Using the SFA_FINANCIAL_AID Web Service
The SFA_FINANCIAL_AID web service includes different service operations that allow an external user interface to access student financial aid information.
This section discusses:
Entity Registry
Description Language
Service Operations
Setting up the Web Service
The SFA_FINANCIAL_AID web service uses the Entity Registry to provide the structure for returning student financial aid data. SFA_FINANCIAL_AID provides basic and work entities to represent Financial Aid student award data. These entities are not directly related to existing records.
During setup, the system generates the Web Services Description Language (WSDL) for SFA_FINANCIAL_AID.
The following diagram lists the SFA_FINANCIAL_AID web service operations and their messages:
Image: SFA_FINANCIAL_AID Web Service Operations and Messages
This example illustrates SFA_FINANCIAL_AID Web Service Operations and Messages.
The SFA_FINANCIAL_AID web service provides the following SOAP and REST services that enable you to access student Campus Solutions Financial Aid information:
|
Service |
Service Operation |
Description |
|---|---|---|
|
SFA_FINANCIAL_AID |
SFA_GET_STUDENT_AWARDS |
SOAP Service. Allows the student to view award information for an Institution and Aid Year. |
|
SFA_FINANCIAL_AID_R |
SFA_GET_STUDENT_AWARDS_R_POST |
REST Service. Allows the student to view award information for an Institution and Aid Year. |
The service operations use PeopleTools Integration Broker. Any user interface that is web-service enabled and complies with web service standards can access the service operations. The SFA_FINANCIAL_AID web service adheres to open web service standards that are currently supported in the latest release of PeopleTools. Before you develop your own user interface, it is recommended that you use a SOAP service tester to become familiar with how the web services process the student account data and user information. One way to use a service tester is to pass the input parameters to a service operation, and then view the service operation output.
The PeopleTools Integration Broker applies to the SFA_FINANCIAL_AID web service and must be set up.
The following documentation is posted to My Oracle Support and should be reviewed as part of your Financial Aid Web Service implementation:
See PeopleTools: Integration Broker Testing Utilities and Tools.
See Campus Solutions 9.0 Generic Service Tester Tool [Doc ID 1478817.1]