Package tp_student

Package tp_student_deposit

Process APIs related to student deposits.

Description

StudentDeposit is intended to be used by an external system to create a deposit record in the SCT Banner system, or to release one or more previously recorded deposit(s). A deposit is a sum of money given as security for an item or service. These funds are subsequently released to cover charges on account or to be remitted to the student at the end of a specified period.

Operations

The AddStudentDeposit message will be sent by the external system to request the creation of a student deposit in the SCT Banner system. To create a deposit, valid SCT Banner values must be provided.

A ConfirmAddStudentDeposit response message is returned if the deposit is successfully added to the student's account in SCT Banner.

The ReleaseStudentDeposit message will be sent by the external system to request the release of deposit funds for a student. The StudentDeposit Web Service can process the release of an individual deposit, process the release of multiple deposits according to the auto release flag and date, or force the release of multiple deposits meeting the specified criteria. The message will contain elements identifying the transaction.

A ConfirmReleaseStudentDeposit response message is returned if the request is processed successfully. The message will contain elements identifying the transaction, as well as the amount actually released and the amount retained on record. Because it is possible for the request to be successfully processed even if no funds are released, this information is provided to inform the user of the final disposition of the request.

Program units

f_receipt_required	Function to determine if a Receipt Number is required when releasing deposits.
p_force_release	Procedure to update Deposit records so that they are ready for Auto Release.
f_add_student_deposit	Service API to add a student deposit.
f_release_stdn_deposit	Service API to release student deposits.
f_add_student_deposit	Process API to add a student deposit.
f_release_stdn_deposit	Process API to release student deposits.

f_receipt_required

Function f_receipt_required(p_pidm                tbrdepo.tbrdepo_pidm%TYPE,
                            p_tran_number         tbrdepo.tbrdepo_tran_number%TYPE,
                            p_term_code           tbrdepo.tbrdepo_term_code%TYPE DEFAULT NULL,
                            p_detail_code_deposit tbrdepo.tbrdepo_detail_code_deposit%TYPE DEFAULT NULL,
                            p_deposit_type        tbbdepc.tbbdepc_dtyp_code%TYPE DEFAULT NULL)
  RETURN VARCHAR2

Function to determine if a Receipt Number is required when releasing deposits.

Review Detail Code Deposit for all deposits specified by the parameters given, to see if any require a receipt.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account that has a deposit, valid in SPRIDEN. NUMBER(8) Required Key
	p_tran_number	Transaction number (one-up within entity) of the deposit. Matched if given, or all. NUMBER(8)
	p_term_code	Term associated with the deposit. Wildcard is allowed, all if null. VARCHAR2(6)
	p_detail_code_deposit	Detail code used when the deposit is released to the receivable ledger. Wildcard is allowed, all if null. VARCHAR2(4)
	p_deposit_type	Deposit type as designated in the Deposit Control (TBBDEPC). Matched if given, or all. VARCHAR2(3)

Returns

Y when any deposit detail code included by the criteria requires a receipt.

p_force_release

Procedure p_force_release(p_pidm                tbrdepo.tbrdepo_pidm%TYPE,
                          p_term_code           tbrdepo.tbrdepo_term_code%TYPE DEFAULT NULL,
                          p_detail_code_deposit tbrdepo.tbrdepo_detail_code_deposit%TYPE DEFAULT NULL,
                          p_deposit_type        tbbdepc.tbbdepc_dtyp_code%TYPE DEFAULT NULL)

Procedure to update Deposit records so that they are ready for Auto Release.

For all deposits specified by the parameters given -
If the Auto Release indicator is not 'Y' it will be changed to 'Y'.
If the Release Date or Expiration Date is in the future, it will be changed to today.

Parameters

	p_pidm	Internal Identification Number of the person or non-person account that has a deposit, valid in SPRIDEN. NUMBER(8) Required Key
	p_term_code	Term associated with the deposit. Wildcard is allowed, all if null. VARCHAR2(6)
	p_detail_code_deposit	Detail code used when the deposit is released to the receivable ledger. Wildcard is allowed, all if null. VARCHAR2(4)
	p_deposit_type	Deposit type as designated in the Deposit Control (TBBDEPC). Matched if given, or all. VARCHAR2(3)

f_add_student_deposit

Function f_add_student_deposit(p_xt xmltype) RETURN CLOB

Service API to add a student deposit.

Parameters

p_xt

Request message to add student deposit. XMLTYPE.

Returns

CLOB containing response message in XML format. CLOB.

f_release_stdn_deposit

Function f_release_stdn_deposit(p_xt xmltype) RETURN CLOB

Service API to release student deposits.

Parameters

p_xt

Request message to release student deposits. XMLTYPE.

Returns

CLOB containing response message in XML format. CLOB.

f_add_student_deposit

Function f_add_student_deposit(p_request_oot uwx_add_student_deposit)
  RETURN uwx_confirm_add_stdn_deposit

Process API to add a student deposit.

A deposit will be created via the Deposit API.

Parameters

p_request_oot

Request to add a student deposit. UWX_ADD_STUDENT_DEPOSIT

Returns

Response message in OOT format. UWX_CONFIRM_ADD_STDN_DEPOSIT

f_release_stdn_deposit

Function f_release_stdn_deposit(p_request_oot uwx_release_stdn_deposit)
  RETURN uwx_confirm_release_stdn_dep

Process API to release student deposits.

Deposits meeting the criteria will be released via the Deposit API.

Parameters

p_request_oot

Request to release student deposits. UWX_RELEASE_STDN_DEPOSIT

Returns

Response message in OOT format. UWX_CONFIRM_RELEASE_STDN_DEP