|
Package gp_entity_address Process APIs related to AddEntityAddress and ExpireEntityAddress.Description The APIs in this package allow the caller to add or update address information about a person in the Banner system. Operations This package contains process API functions that accept request information in the form of an Oracle Object Type (OOT), and return response information, also in OOT form. This package also contains service API functions that accept request information in XML form (Oracle's XMLTYPE), then call the appropriate process API, and return response information in XML form, contained in a character large object (CLOB). There is one service API function for each process API function and each pair shares a common name (i.e., the function is "overloaded"). The service API function takes care of converting the incoming XML message to an OOT that will be accepted by the corresponding process API. The service API function also converts the response OOT returned from the process API back to XML.
|
| Program units |
| f_add_entity_address | Service API for AddEntityAddress. |
| f_expire_entity_address | Service API for ExpireEntityAddress. |
| f_add_entity_address | Process API for AddEntityAddress. |
| f_expire_entity_address | Process API for ExpireEntityAddress. |
f_add_entity_address
FUNCTION f_add_entity_address(p_xt xmltype) RETURN CLOB
Service API for AddEntityAddress.
The f_add_entity_address Service API function accepts an XML request message with a root element of AddEntityAddress. This request message XML contains a current Banner ID number (source=SPRIDEN.SPRIDEN_ID), or other accepted ID. Other accepted IDs include the IMSID used for eLearning integrations (source=GOBSRID.GOBSRID_SOURCED_ID) and the Luminis log-on identifier or LogonID (source=GOBTPAC.GOBTPAC_EXTERNAL_USER or SPRIDEN.SPRIDEN_ID, depending on institutional preferences).
The f_add_entity_address Service API function converts the XML to an Oracle Object Type (OOT) and calls the f_add_entity_address Process API function, passing in the OOT. The response that is returned by the Process API function is converted from OOT to XML with a root element of ConfirmAddEntityAddress. This XML is returned by the Service API in the form of a Character Large Object (CLOB).
| Parameters |
| p_xt |
XML for AddEntityAddress. XMLTYPE |
| Returns |
|
XML for AddEntityAddress. CLOB |
f_expire_entity_address
FUNCTION f_expire_entity_address(p_xt xmltype) RETURN CLOB
Service API for ExpireEntityAddress.
The f_expire_entity_address Service API function accepts an XML request message with a root element of ExpireEntityAddress. This request message XML contains a current Banner ID number (source=SPRIDEN.SPRIDEN_ID), or other accepted ID. Other accepted IDs include the IMSID used for eLearning integrations (source=GOBSRID.GOBSRID_SOURCED_ID) and the Luminis log-on identifier or LogonID (source=GOBTPAC.GOBTPAC_EXTERNAL_USER or SPRIDEN.SPRIDEN_ID, depending on institutional preferences).
It also contains the expiration date for the entity address to be expired.
The f_expire_entity_address Service API function converts the XML to an Oracle Object Type (OOT) and calls the f_expire_entity_address Process API function, passing in the OOT. The response that is returned by the Process API function is converted from OOT to XML with a root element of ConfirmExpireEntityAddress. This XML is returned by the Service API in the form of a Character Large Object (CLOB).
| Parameters |
| p_xt |
XML for ExpireEntityAddress. XMLTYPE |
| Returns |
|
XML for ExpireEntityAddress. CLOB |
f_add_entity_address
FUNCTION f_add_entity_address(p_request_oot uwx_add_entity_address) RETURN uwx_confirm_add_entity_address
Process API for AddEntityAddress.
The f_add_entity_address Process API function accepts a request message in the form of a UWX_ADD_ENTITY_ADDRESS Oracle Object Type (OOT).
This request message contains the person ID number (refer to description of f_add_entity_address Service API function for further details concerning valid IDs).
The f_add_entity_address Process API function queries the Banner database in order to build a response message containing the entity address information. The response message is returned by the Process API in the form of a UWX_CONFIRM_ADD_ENTITY_ADDRESS OOT.
| Parameters |
| p_request_oot |
OOT for AddEntityAddress. UWX_ADD_ENTITY_ADDRESS |
| Returns |
|
OOT for ConfirmAddEntityAddress. UWX_CONFIRM_ADD_ENTITY_ADDRESS |
f_expire_entity_address
FUNCTION f_expire_entity_address(p_request_oot uwx_expire_entity_address) RETURN uwx_confirm_expire_entity_addr
Process API for ExpireEntityAddress.
| Parameters |
| p_request_oot |
Accepts request message in OOT format. UWX_EXPIRE_ENTITY_ADDRESS |
| Returns |
|
Response message in OOT format. UWX_CONFIRM_EXPIRE_ENTITY_ADDR |