Service Operations
This section discusses the service operations for SSF_FINANCIALS.
Note: The schema diagrams may be updated in future bundle releases.
There is no difference in the request/response messages for SOAP and REST.
This section describes the SSF_FINANCIALS service operation SSF_GET_STUDENT_ACCOUNT.
SSF_GET_STUDENT_ACCOUNT
The Get Student Account request enables the user to retrieve student account details. This service retrieves Charges Due, Recent Payments and Pending Financial Aid details based on the setup and data available.
The Get Student Account service operation is available only in self-service mode. Although the EmplID is part of the request, it is overridden so that only the operator’s EmplID is used.
The following list describes the Get Student Account service operation.
Description:
The Get Student Account service operation extracts and publishes student account information.
Users:
This service can be consumed by schools and third-party providers to render custom user interface on a tablet, mobile or any other device.
Processing:
The service operation:
Accepts the input parameters: EmplID, Business Unit, and Term. The EmplID must match the operator ID.
Verifies that the operator has an institution set and that the institution set is service-enabled. Otherwise, the service operation returns a SOAP fault with the error: We are unable to display your account at this time (14872, 9).
Invokes Tuition Calculation, if required. The service operation uses the same criteria as self-service to determine if tuition calculation needs to run, and which terms require recalculation.
Retrieves data according to the views requested.
Calculates SSF_OVERALL_ACTBAL based on the business units in the Institution Set. This amount represents the total ITEM_AMT for business units in the institution set and may be a negative amount.
If requested, fetches due charges for the EmplID based on the business units in the student’s institution set. Other filter criteria that are passed, for example Business Unit, Term, are also applied in order to fetch the due charges. Data is sorted in ascending order of Due Date, Business Unit and Term. Required charges and deposits are returned by Due Date on the Item Summary across multiple business units. Individual due dates, item description, item number, and amounts are returned on the Item Detail level. The Item Summary view for the Due Charges and Deposits returns the earliest due date first. The Item Detail returns the due charges and deposits in business unit and term order for the specified due date. If there are no charges or deposits due, the following message is returned on the Message Set/Message number of the StudentAccountView: You have no outstanding charges or deposits at this time” (14872,10).
If requested, the Recent Payments View returns Payment table rows in the Item Summary for the student. The value in the Maximum Payments in Service field is used to identify the number of payment rows to be retrieved. Payments are defined as item type code of P. It excludes credits that have a contract number associated with it. Payments are retrieved in descending order of Posted Date, ensuring the most recent payments are returned by the service operation. No Item Detail is returned for this view.
If requested, fetches Pending Financial Aid (Anticipated Financial Aid) information. Item Summary is returned in Term and then Institution order. Item Detail is returned for the Pending Aid view, and each detail includes the Career, Item Type, and amount. Unlike the Self Service Pending Aid component, this view only returns data for terms and careers that have an Anticipated Aid Display Date. This date is defined in the Valid Terms for Careers page, and allows users to limit the terms and careers that are returned by the service operation. If no date is defined, the data for the term is not returned.
If requested, the Due Charges and Deposits by Term return a sum of all due charges and deposits that are summarized by term and business unit.
Note: The Business Unit passed to the service is not used by the tuition calculation process to show overall account balance.
Tuition Calculation is done for all business units to which a student is enrolled regardless of the Business Unit value that is passed to the service request. The overall account balance represents the student account balance across all business units.
Output:
After processing, the operation returns the Due Charges, Recent Payments and Pending Financial Aid (Anticipated Aid) details.
Error Conditions:
These conditions result in a service error:
EmplID does not have the required permission or security to access the Student Financial components.
EmplID is not associated to a SF Institution Set.
SF Institution Set is not set up to be used by the service operation, that is, the Allow Use in Service check box is not selected.
Input Message: SSF_GET_STUDENT_ACCT_REQ
Image: SSF_GET_STUDENT_ACCT_REQ Message Parameters
This example illustrates the fields and controls on the SSF_GET_STUDENT_ACCT_REQ Message Parameters. You can find definitions for the fields and controls later on this page.
The Get Student Account request may include the EmplID, Business Unit, and Term. It must include one or more views. Views represent the type of data that is requested. A view could be: Due Charges, Payment, Anticipated Aid, or Due Charges by Term.
The following table lists data that can be passed to the service operation:
|
Data |
Description |
|---|---|
|
Employee ID |
Required. Defaults to operator’s EmplID. |
|
Business Unit |
Optional |
|
Term |
Optional |
|
Account Views |
Required. There are four views that represent different data for the student.
|
The following code is an example of the SSF_GET_STUDENT_ACCT_REQ message that the SSF_GET_STUDENT_ACCOUNT service operation receives from a service caller:
<?xml version="1.0"?> <SSF_GET_STUDENT_ACCT_REQ xmlns="http://xmlns.oracle.com/Enterprise/HCM/services"> <STUDENT_ACCOUNT_REQUEST> <EMPLID>SFSCE0001</EMPLID> <BUSINESS_UNIT/> <STRM/> <ACCOUNT_VIEWS> <ACCOUNT_VIEW_REQUEST> <SSF_ACCOUNT_VIEW>01</SSF_ACCOUNT_VIEW> </ACCOUNT_VIEW_REQUEST> <ACCOUNT_VIEW_REQUEST> <SSF_ACCOUNT_VIEW>02</SSF_ACCOUNT_VIEW> </ACCOUNT_VIEW_REQUEST> <ACCOUNT_VIEW_REQUEST> <SSF_ACCOUNT_VIEW>03</SSF_ACCOUNT_VIEW> </ACCOUNT_VIEW_REQUEST> <ACCOUNT_VIEW_REQUEST> <SSF_ACCOUNT_VIEW>04</SSF_ACCOUNT_VIEW> </ACCOUNT_VIEW_REQUEST> </ACCOUNT_VIEWS> </STUDENT_ACCOUNT_REQUEST> </SSF_GET_STUDENT_ACCT_REQ>
Output Message: SSF_GET_STUDENT_ACCT_RESP
When the Integration Broker receives the SSF_GET_STUDENT_ACCT_REQ message, it responds with the SSF_GET_STUDENT_ACCT_RESP message.
The following diagram shows the output parameters that the SSF_GET_STUDENT_ACCOUNT service operation passes to the service caller:
Image: SSF_GET_STUDENT_ACCT_RESP XSD Schema, 1 of 5
This example illustrates the fields and controls on the SSF_GET_STUDENT_ACCT_RESP XSD Schema, 1 of 5. You can find definitions for the fields and controls later on this page.
The SSF_GET_STUDENT_ACCT_RESP schema includes the STUDENT_ACCOUNT_SUMMARY, STUDENT_ACCOUNT_VIEW, ITEM_SUMMARY and ITEM_DETAIL entity XSD schemas, which are illustrated by the following diagrams:
Image: SSF_GET_STUDENT_ACCT_RESP XSD Schema, 2 of 5
This example illustrates the fields and controls on the SSF_GET_STUDENT_ACCT_RESP XSD Schema, 2 of 5. You can find definitions for the fields and controls later on this page.
Image: SSF_GET_STUDENT_ACCT_RESP XSD Schema, 3 of 5
This example illustrates the fields and controls on the SSF_GET_STUDENT_ACCT_RESP XSD Schema, 3 of 5. You can find definitions for the fields and controls later on this page.
Image: SSF_GET_STUDENT_ACCT_RESP XSD Schema, 4 of 5
This example illustrates the fields and controls on the SSF_GET_STUDENT_ACCT_RESP XSD Schema, 4 of 5. You can find definitions for the fields and controls later on this page.
Image: SSF_GET_STUDENT_ACCT_RESP XSD Schema, 5 of 5
This example illustrates the fields and controls on the SSF_GET_STUDENT_ACCT_RESP XSD Schema, 5 of 5. You can find definitions for the fields and controls later on this page.
The Student Account Summary (STUDENT_ACCOUNT_SUMMARY) entity returns high level student information, such as the Institution Set and the student’s Overall Balance. These data elements return the same information regardless of the view you request. The data returned by the service takes into account the Business Units defined for the student’s Institution Set. Make sure you set up the self-service components that apply to this service.
Depending on the view you request, the Student Account Item Summary (ITEM_SUMMARY) may contain various types of information from different levels of the student account. ITEM_SUMMARY is not directly tied to the Student Financials Item_SF. The data that is returned could be the payment table row, the total charges due for a date, anticipated aid for a term, and so on. In addition, Student Account Item Detail (ITEM_DETAIL) may or may not be returned.
The following table lists the account views that represent various types of student data:
|
View |
Type of Student Data |
|---|---|
|
SSF_ACCOUNT_VIEW = 01 |
Due Charges and Deposits by Due Date |
|
SSF_ACCOUNT_VIEW = 02 |
Recent Payments. The number of payments returned is based on the value in the Maximum Payments in Service field on the SF Institution Set attached to the student. This view does not include ITEM_DETAIL. |
|
SSF_ACCOUNT_VIEW = 03 |
Pending Financial Aid. The Anticipated Aid Display Date on the Valid Terms for Careers page controls the data that is displayed. |
|
SSF_ACCOUNT_VIEW = 04 |
Due Charges and Deposits by Term. This view does not have ITEM_DETAIL. |
The following code is an example of the SSF_GET_STUDENT_ACCT_RESP message that the SSF_GET_STUDENT_ACCOUNT service operation transmits to the service caller:
<?xml version="1.0"?>
<SSF_GET_STUDENT_ACCT_RESP xmlns="http://xmlns.oracle.com/Enterprise/HCM/services">
<STUDENT_ACCOUNT_SUMMARY>
<EMPLID>SFSCE0001</EMPLID>
<BUSINESS_UNIT/>
<STRM/>
<SSF_OVERALL_ACTBAL>2710</SSF_OVERALL_ACTBAL>
<CURRENCY_CD>USD</CURRENCY_CD>
<MSGSET>0</MSGSET>
<MSGNUM>0</MSGNUM>
<SSF_MSG_LONG/>
<STUDENT_ACCOUNT_VIEW>
<SSF_ACCOUNT_VIEW>01</SSF_ACCOUNT_VIEW>
<SSF_VW_TOTAL_AMT>2710.00</SSF_VW_TOTAL_AMT>
<SSF_VW_TOTAL_BAL>2710.00</SSF_VW_TOTAL_BAL>
<CURRENCY_CD>USD</CURRENCY_CD>
<MSGSET>0</MSGSET>
<MSGNUM>0</MSGNUM>
<SSF_MSG_LONG/>
<ITEM_SUMMARY>
<EMPLID>SFSCE0001</EMPLID>
<INSTITUTION/>
<BUSINESS_UNIT/>
<STRM/>
<ITEM_NBR/>
<ITEM_TYPE/>
<DUE_DT>2013-08-04</DUE_DT>
<PAYMENT_ID_NBR>0</PAYMENT_ID_NBR>
<POSTED_DATE/>
<AID_YEAR/>
<SSF_AMOUNT>333.34</SSF_AMOUNT>
<SSF_BALANCE>333.34</SSF_BALANCE>
<CURRENCY_CD>USD</CURRENCY_CD>
<SSF_DESCR100> </SSF_DESCR100>
<BUSINESS_UNIT_LOVDescrShort> </BUSINESS_UNIT_LOVDescrShort>
<INSTITUTION_LOVDescrShort> </INSTITUTION_LOVDescrShort>
<STRM_LOVDescrShort> </STRM_LOVDescrShort>
<ITEM_DETAIL>
<BUSINESS_UNIT>PSUNV</BUSINESS_UNIT>
<EMPLID>SFSCE0001</EMPLID>
<ITEM_NBR>000000000000008</ITEM_NBR>
<STRM>0700</STRM>
<DUE_DT>2013-08-04</DUE_DT>
<DESCR>Student Tuition & Fees</DESCR>
<SSF_AMOUNT>333.34</SSF_AMOUNT>
<SSF_BALANCE>333.34</SSF_BALANCE>
<ACAD_PROG/>
<ACAD_CAREER/>
<STDNT_CAR_NBR>0</STDNT_CAR_NBR>
<ACAD_YEAR>2013</ACAD_YEAR>
<SESSION_CODE/>
<CLASS_NBR>0</CLASS_NBR>
<SEL_GROUP/>
<FEE_CD/>
<COURSE_LIST/>
<CRSE_ID/>
<ADM_APPL_NBR/>
<BILLING_CAREER/>
<ITEM_TYPE>180000000002</ITEM_TYPE>
<BILLING_DT>2013-08-01</BILLING_DT>
<REF1_DESCR/>
<SSF_TXN_DTL_TYPE>C</SSF_TXN_DTL_TYPE>
<CURRENCY_CD>USD</CURRENCY_CD>
<BUSINESS_UNIT_LOVDescrShort/>
<STRM_LOVDescrShort>2013 Spr</STRM_LOVDescrShort>
<INSTITUTION/>
<INSTITUTION_LOVDescrShort> </INSTITUTION_LOVDescrShort>
</ITEM_DETAIL>
</ITEM_SUMMARY>
</STUDENT_ACCOUNT_VIEW>
<STUDENT_ACCOUNT_VIEW>
<SSF_ACCOUNT_VIEW>02</SSF_ACCOUNT_VIEW>
<SSF_VW_TOTAL_AMT>-1100</SSF_VW_TOTAL_AMT>
<SSF_VW_TOTAL_BAL>0</SSF_VW_TOTAL_BAL>
<CURRENCY_CD>USD</CURRENCY_CD>
<MSGSET>0</MSGSET>
<MSGNUM>0</MSGNUM>
<SSF_MSG_LONG/>
<ITEM_SUMMARY>
<EMPLID>SFSCE0001</EMPLID>
<INSTITUTION/>
<BUSINESS_UNIT>PSUNV</BUSINESS_UNIT>
<STRM>0700</STRM>
<ITEM_NBR/>
<ITEM_TYPE>300000000001</ITEM_TYPE>
<DUE_DT/>
<PAYMENT_ID_NBR>1</PAYMENT_ID_NBR>
<POSTED_DATE>2013-07-29</POSTED_DATE>
<AID_YEAR/>
<SSF_AMOUNT>-600</SSF_AMOUNT>
<SSF_BALANCE>0</SSF_BALANCE>
<CURRENCY_CD>USD</CURRENCY_CD>
<SSF_DESCR100> </SSF_DESCR100>
<BUSINESS_UNIT_LOVDescrShort/>
<INSTITUTION_LOVDescrShort> </INSTITUTION_LOVDescrShort>
<STRM_LOVDescrShort>2013 Spr</STRM_LOVDescrShort>
</ITEM_SUMMARY>
<ITEM_SUMMARY>
<EMPLID>SFSCE0001</EMPLID>
<INSTITUTION/>
<BUSINESS_UNIT>PSUNV</BUSINESS_UNIT>
<STRM>0700</STRM>
<ITEM_NBR/>
<ITEM_TYPE>300000000002</ITEM_TYPE>
<DUE_DT/>
<PAYMENT_ID_NBR>2</PAYMENT_ID_NBR>
<POSTED_DATE>2013-07-29</POSTED_DATE>
<AID_YEAR/>
<SSF_AMOUNT>-500</SSF_AMOUNT>
<SSF_BALANCE>0</SSF_BALANCE>
<CURRENCY_CD>USD</CURRENCY_CD>
<SSF_DESCR100> </SSF_DESCR100>
<BUSINESS_UNIT_LOVDescrShort/>
<INSTITUTION_LOVDescrShort> </INSTITUTION_LOVDescrShort>
<STRM_LOVDescrShort>2013 Spr</STRM_LOVDescrShort>
</ITEM_SUMMARY>
</STUDENT_ACCOUNT_VIEW>
<STUDENT_ACCOUNT_VIEW>
<SSF_ACCOUNT_VIEW>03</SSF_ACCOUNT_VIEW>
<SSF_VW_TOTAL_AMT>1500</SSF_VW_TOTAL_AMT>
<SSF_VW_TOTAL_BAL>0</SSF_VW_TOTAL_BAL>
<CURRENCY_CD>USD</CURRENCY_CD>
<MSGSET>0</MSGSET>
<MSGNUM>0</MSGNUM>
<SSF_MSG_LONG/>
<ITEM_SUMMARY>
<EMPLID>SFSCE0001</EMPLID>
<INSTITUTION>PSUNV</INSTITUTION>
<BUSINESS_UNIT/>
<STRM>0710</STRM>
<ITEM_NBR/>
<ITEM_TYPE/>
<DUE_DT/>
<PAYMENT_ID_NBR>0</PAYMENT_ID_NBR>
<POSTED_DATE/>
<AID_YEAR/>
<SSF_AMOUNT>750</SSF_AMOUNT>
<SSF_BALANCE>0</SSF_BALANCE>
<CURRENCY_CD>USD</CURRENCY_CD>
<SSF_DESCR100> </SSF_DESCR100>
<BUSINESS_UNIT_LOVDescrShort> </BUSINESS_UNIT_LOVDescrShort>
<INSTITUTION_LOVDescrShort>PSU</INSTITUTION_LOVDescrShort>
<STRM_LOVDescrShort>2013 Fall</STRM_LOVDescrShort>
<ITEM_DETAIL>
<BUSINESS_UNIT>PSUNV</BUSINESS_UNIT>
<EMPLID>SFSCE0001</EMPLID>
<ITEM_NBR/>
<STRM>0710</STRM>
<DUE_DT/>
<DESCR>Chicago Fire Survivor Grant</DESCR>
<SSF_AMOUNT>375</SSF_AMOUNT>
<SSF_BALANCE>0</SSF_BALANCE>
<ACAD_PROG/>
<ACAD_CAREER/>
<STDNT_CAR_NBR>0</STDNT_CAR_NBR>
<ACAD_YEAR/>
<SESSION_CODE/>
<CLASS_NBR>0</CLASS_NBR>
<SEL_GROUP/>
<FEE_CD/>
<COURSE_LIST/>
<CRSE_ID/>
<ADM_APPL_NBR/>
<BILLING_CAREER/>
<ITEM_TYPE>900000000009</ITEM_TYPE>
<BILLING_DT/>
<REF1_DESCR/>
<SSF_TXN_DTL_TYPE/>
<CURRENCY_CD>USD</CURRENCY_CD>
<BUSINESS_UNIT_LOVDescrShort/>
<STRM_LOVDescrShort>2013 Fall</STRM_LOVDescrShort>
<INSTITUTION>PSUNV</INSTITUTION>
<INSTITUTION_LOVDescrShort>PSU</INSTITUTION_LOVDescrShort>
</ITEM_DETAIL>
<ITEM_DETAIL>
<BUSINESS_UNIT>PSUNV</BUSINESS_UNIT>
<EMPLID>SFSCE0001</EMPLID>
<ITEM_NBR/>
<STRM>0710</STRM>
<DUE_DT/>
<DESCR>Lake Michigan Polar Bear Schol</DESCR>
<SSF_AMOUNT>375</SSF_AMOUNT>
<SSF_BALANCE>0</SSF_BALANCE>
<ACAD_PROG/>
<ACAD_CAREER/>
<STDNT_CAR_NBR>0</STDNT_CAR_NBR>
<ACAD_YEAR/>
<SESSION_CODE/>
<CLASS_NBR>0</CLASS_NBR>
<SEL_GROUP/>
<FEE_CD/>
<COURSE_LIST/>
<CRSE_ID/>
<ADM_APPL_NBR/>
<BILLING_CAREER/>
<ITEM_TYPE>900000000010</ITEM_TYPE>
<BILLING_DT/>
<REF1_DESCR/>
<SSF_TXN_DTL_TYPE/>
<CURRENCY_CD>USD</CURRENCY_CD>
<BUSINESS_UNIT_LOVDescrShort/>
<STRM_LOVDescrShort>2013 Fall</STRM_LOVDescrShort>
<INSTITUTION>PSUNV</INSTITUTION>
<INSTITUTION_LOVDescrShort>PSU</INSTITUTION_LOVDescrShort>
</ITEM_DETAIL>
</ITEM_SUMMARY>
</STUDENT_ACCOUNT_VIEW>
<STUDENT_ACCOUNT_VIEW>
<SSF_ACCOUNT_VIEW>04</SSF_ACCOUNT_VIEW>
<SSF_VW_TOTAL_AMT>4810</SSF_VW_TOTAL_AMT>
<SSF_VW_TOTAL_BAL>2710</SSF_VW_TOTAL_BAL>
<CURRENCY_CD>USD</CURRENCY_CD>
<MSGSET>0</MSGSET>
<MSGNUM>0</MSGNUM>
<SSF_MSG_LONG/>
<ITEM_SUMMARY>
<EMPLID>SFSCE0001</EMPLID>
<INSTITUTION/>
<BUSINESS_UNIT>PSUNV</BUSINESS_UNIT>
<STRM>0700</STRM>
<ITEM_NBR/>
<ITEM_TYPE/>
<DUE_DT/>
<PAYMENT_ID_NBR>0</PAYMENT_ID_NBR>
<POSTED_DATE/>
<AID_YEAR/>
<SSF_AMOUNT>3100</SSF_AMOUNT>
<SSF_BALANCE>1000</SSF_BALANCE>
<CURRENCY_CD>USD</CURRENCY_CD>
<SSF_DESCR100> </SSF_DESCR100>
<BUSINESS_UNIT_LOVDescrShort/>
<INSTITUTION_LOVDescrShort> </INSTITUTION_LOVDescrShort>
<STRM_LOVDescrShort>2013 Spr</STRM_LOVDescrShort>
</ITEM_SUMMARY>
<ITEM_SUMMARY>
<EMPLID>SFSCE0001</EMPLID>
<INSTITUTION/>
<BUSINESS_UNIT>PSUNV</BUSINESS_UNIT>
<STRM>0710</STRM>
<ITEM_NBR/>
<ITEM_TYPE/>
<DUE_DT/>
<PAYMENT_ID_NBR>0</PAYMENT_ID_NBR>
<POSTED_DATE/>
<AID_YEAR/>
<SSF_AMOUNT>1710</SSF_AMOUNT>
<SSF_BALANCE>1710</SSF_BALANCE>
<CURRENCY_CD>USD</CURRENCY_CD>
<SSF_DESCR100> </SSF_DESCR100>
<BUSINESS_UNIT_LOVDescrShort/>
<INSTITUTION_LOVDescrShort> </INSTITUTION_LOVDescrShort>
<STRM_LOVDescrShort>2013 Fall</STRM_LOVDescrShort>
</ITEM_SUMMARY>
</STUDENT_ACCOUNT_VIEW>
</STUDENT_ACCOUNT_SUMMARY>
</SSF_GET_STUDENT_ACCT_RESP>
Fault Message: SSF_FAULT_RESP
If the service operation encounters an error condition, it responds with the SSF_FAULT_RESP message.
Image: SSF_FAULT_RESP Message Parameters
This example illustrates the fields and controls on the SSF_FAULT_RESP Message Parameters. You can find definitions for the fields and controls later on this page.
The data returned by the service takes into account the Business Units defined for the student’s Institution Set. Make sure you set up the self-service components that apply to this service. The service returns the same error encountered in Self Service if an Institution Set is not defined for the student’s operator ID. In addition, the student’s associated Institution Set must be service-enabled. Any data that you request for Business Units that are not part of the student’s Institution Set cannot be retrieved.
The following code is an example of the SSF_FAULT_RESP message that the SSF_GET_STUDENT_ACCOUNT service operation transmits to the service caller:
<?xml version="1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>Client</faultcode>
<faultstring>An Error occurred processing this request (14098,286)</faultstring>
<detail>
<MSGS>
<MSG>
<ID>14872-9</ID>
<DESCR>We are unable to display your account at this time.</DESCR>
<MESSAGE_SEVERITY>E</MESSAGE_SEVERITY>
<PROPS/>
</MSG>
</MSGS>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>