SAD_SUBMITAPPL

This service operation enables the user to submit a completed admissions application to the Campus Solutions system. The service operation initially saves the applications to the admissions staging tables and subsequently posts the staged application data to the admissions production tables.

Submit Application Service Operation Description and Features	Details
Description	The Submit Application service call results in the given admissions application being submitted to the Campus Solutions system. The application must be complete (according to the institution's data capture requirements). The online application user interface and the underlying Campus Solutions data model ensure that the submitted admission application is complete. The application submit process involves first validating the data, then saving the data to the admissions staging tables, and finally transferring the staged data into the admissions production tables. When initially saving the application to the staging tables, if the application does not have an application number, the service operation assigns an application number (ADM_APPL_NBR) to the application for tracking purpose. The operation does not assign an application number if another operation (for example, the SAD_SAVEAPPL operation) has already assigned an application number. The admission application must pass through validation checks before it gets submitted. The service operation validates all aspects of application data including data entered and translate values selected by the user on the online application and custom business validation rules that the institution has incorporated into the online application. If the constituent who initiated the application submit process is known to the Campus Solutions system (for example, the constituent has an EMPLID), then the constituent and application data is eligible to be posted to the admissions and person production tables. Otherwise, the application remains in the staging tables until addressed by an administrator. When configured to do so, the constituent can pay an application fee and/or request an application fee waiver. Applications may include attachments. The online application must encode the attachment in Base64 format before passing the attachment to Campus Solutions.
Users	An applicant using an online application. An administrator using an online application for creating an application on behalf of an applicant or a student.
Processing	This service operation performs the following steps: Validate that the user is authenticated (and is not a Guest). If administrator mode then: Validate the required input administrator parameters. Validate that the administrator is authorized to access the application center, institution, career, program and plan. Use the EMPLID supplied by the administrator for the transaction. Validate that the applicant is authorized to submit the application (for example, verify whether the applicant is the same person who created the application in a call to the SAD_CREATEAPPL service operation.) If administrator mode, then use the input parameter Application Center value for the application. If applicant mode, then use the input parameters and the settings on the Application Configuration component to assign an application center to the application. To enter the Application Citizenship details use the applicant details in the input parameters, if necessary. To enter the Constituent Institution (needed for data update rules) use the Admissions Application Institution input parameter value. Validate the constituent and application data using the Constituent and Applicant entity schemas. Associate the TEMP_ID (assigned during the SAD_CREATEAPPL processing) with the application. Save the validated constituent and application data to the staging tables. If the constituent is not known to the Campus Solutions system (for example, the applicant does not have an EMPLID): Run the Search Match process according to the Search Match settings on the Transaction Setup component. Add or update a Person record according to Search Match configuration and apply the necessary data update rules during this processing. If Fee payment is required but has not yet been paid: Call the Student Financials Fee Calculation API to calculate the fee amount. If Fee Waivers are allowed then allow the application to progress to submitted status. If Fee Waivers are Not allowed then: 1. Set the application data to Saved Status. 2. Add the Fee details to the response message. The caller must handle this response by initiating the payment services. Note it is possible for Fee calculation to result in a zero (0) amount in which case the caller should not initiate the payment service. Create or update a prospect record in the production tables according to settings on the Application Configuration component. If the constituent is known (for example, the applicant has an EMPLID), post the application data into the admissions production tables and apply the necessary data update rules during this processing.
Output	After completing the processing steps, the service operation: Posts the valid application data to the Campus Solutions admissions staging tables. Posts the valid constituent data to the Transaction Manager constituent staging tables. Transfers the application and constituent data from the staging tables to the person and admissions production tables. Optionally, creates or updates a person record for a valid application. Optionally, creates a prospect record for a known applicant.
Error Conditions	The following conditions result in a service error: User is not authenticated (for example, if an anonymous Guest user tries to sign into the online application, the service operation throws an error message.) User is not authorized to access the application (for example, the applicant is trying to access an application created by another applicant). Application is invalid (that is, the application fails validation processing). Required input parameters have not been supplied by the user (see the graphic titled SAD_SUBMITAPPL_REQ Message Parameters and the "AAWS and Entity Registry" section).

Input Message: SAD_SUBMITAPPL_REQ

This image shows the input parameters that the SAD_SUBMITAPPL service operation receives from an online application.

Note that the SAD_SUBMITAPPL_REQ schema includes the Application entity (ADM_APPL_DATA) and Constituent entity XSD schemas.

Required data that the online application must supply to the service operation in Non-administrator (Applicant) mode:

ADM_APPL_DATA
CONSTITUENT

Required data that the online application must supply to the service operation in Administrator mode:

Institution
Admission Application Center
ADM_APPL_DATA
CONSTITUENT

The following is an example of the SAD_SUBMITAPPL_REQ message that the SAD_SUBMITAPPL service operation receives from an online application:

<?xml version="1.0"?>
<SAD_SUBMITAPPL_REQ>
  <ADM_APPL_DATA>
   <!-- Application data shape -->
  </ADM_APPL_DATA>
  <CONSTITUENT>
   <!-- Constituent data shape -->
  </CONSTITUENT>
</SAD_SUBMITAPPL_REQ>

Output Message: SAD_SUBMITAPPL_RESP

When the Integration Broker receives the SAD_SUBMITAPPL_REQ message, it responds with the SAD_SUBMITAPPL_RESP message.

This image shows the output parameters that the SAD_SUBMITAPPL service operation passes to the online application.

The following is an example of the SAD_SUBMITAPPL_RESP message that the SAD_SUBMITAPPL service operation transmits to the online application:

<?xml version="1.0"?>
<SAD_SUBMITAPPL_RESP>
  <ADM_APPL_NBR>00023456</ADM_APPL_NBR>
  <FEE>
    <PAYMENT_APPLICATION>SADAAWS</PAYMENT_APPLICATION>
    <PAYMENT_KEY>00023456</PAYMENT_KEY>
    <APPL_FEE_AMT>20</APPL_FEE_AMT>
    <CURRENCY_CD>USD</CURRENCY_CD>
  </FEE>
</SAD_SUBMITAPPL_RESP>

Fault Message: SAD_FAULT_RESP

Refer to the SAD_FAULT_RESP message example in the SAD_CREATEAPPL section.