Package sp_academic

Package sp_academic_period

Process APIs related to GetAcademicPeriods.

Description

The API in this package allows the caller to acquire information from the Banner system about one or many academic periods at the institution. The information can be used by the caller to query for academic period based on specific search criteria.

Preparation

In order to retrieve academic period information one of the following is required: SearchDate RegistrationAllowed: The values are Y or N The above two criteira allows to filter the data set returned.

Operations

This package contains a process API function that accepts request information in the form of an Oracle Object Type (OOT), and returns response information, also in OOT form.

This package also contains a service API function that accepts 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_get_acad_periods	Service API for GetAcademicPeriods.
f_get_acad_periods	Process API for GetAcademicPeriods.

f_get_acad_periods

Function f_get_acad_periods(p_xt xmltype) RETURN CLOB

Service API for GetAcademicPeriods.

The f_get_acad_periods Service API function accepts an XML request message with a root element of GetAcademicPeriods. This request message XML contains search criteria (search_date, registration_allowed, etc).

The f_get_acad_periods Service API function converts the XML to an Oracle Object Type (OOT) and calls the f_get_acad_periods 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 ShowAcademicPeriods. This XML is returned by the Service API in the form of a Character Large Object (CLOB).

Parameters

p_xt

XML for GetAcademicPeriods. XMLTYPE

Returns

XML for ShowAcademicPeriods. CLOB

f_get_acad_periods

Function f_get_acad_periods(p_request_oot uwx_get_acad_periods)
  RETURN uwx_show_acad_periods

Process API for GetAcademicPeriods.

The f_get_acad_periods Process API function accepts a request message in the form of a UWX_GET_ACAD_PERIODS Oracle Object Type (OOT). This request message contains search criteria of f_get_acad_periods Service API function for further details concerning academic periods.

The f_get_acad_periods Process API function queries the Banner database in order to build a response message containing the academic period information. The response message is returned by the Process API in the form of a UWX_SHOW_ACAD_PERIODS OOT.

Parameters

p_request_oot

OOT for GetAcademicPeriods. UWX_GET_ACAD PERIODS

Returns