SAD_GETAPPLS

This service operation enables the user to retrieve a summary of all active admission applications from the Campus Solutions system for the current authenticated user. The applications summary includes applications found in both the admissions staging and production database tables.

Get Applications Service Operation Description and Features Details

Description

Use this service operation to retrieve a summary of all the applications that reside in the Campus Solutions staging and production tables. The service operation retrieves only those applications that the authenticated user is authorized to access.

SAD_GETAPPLS can operate under applicant or administrative modes. When using administrator mode, the application data returned from the Admissions production tables is subject to application center row level security. When using applicant mode, the application data returned is restricted to those applications entered previously by the authenticated online application user.

Users

  • An applicant using an online application.

  • An administrator using an online application to retrieve data that he or she previously saved or submitted. The administrator can retrieve an application for an applicant who has or does not have an EMPLID.

Processing

This service operation performs the following steps:

  1. Validate that the user is authenticated (and is not a Guest).

  2. If administrator mode then:

    1. Validate the required input administrator parameters.

    2. Validate that the administrator is authorized to access the application center.

    3. Use the EMPLID supplied by the administrator for the transaction.

  3. Determine the list of configured application transactions from the Transaction Setup component.

  4. Retrieve all the application transactions for all the configured application transactions.

  5. Retrieve all admission applications from the Admissions staging tables that the authenticated user is authorized to access.

  6. If applicant mode, then retrieve all the applications associated with the authenticated EMPLID from the production tables.

  7. To retrieve the application based on the ADM_APPL_NBR key:

    1. First, check whether the application exists in the admissions staging tables using the SCC_TEMP_ID key.

    2. If the application does not exist in the staging tables, check the admissions production tables using the EMPLID key.

  8. Return the Application Summary, which indicates ID (EMPLID or SCC_TEMP_ID), Application Number, Institution, Academic Career and Application Status (SAVED, SUBMITTED, ERROR, or POSTED).

Output

After processing the steps, a summary of all active applications is returned.

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).

  • Required input parameters have not been supplied by the user (see the graphic titled SAD_GETAPPLS_REQ Message Parameters).

Input Message: SAD_GETAPPLS_REQ

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

SAD_GETAPPLS_REQ Message Parameters

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

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

  • Institution

  • Admission Application Center

  • Academic Program

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

<?xml version="1.0"?>
<SAD_GETAPPLS_REQ>
</SAD_GETAPPLS_REQ>

Output Message: SAD_GETAPPLS_RESP

When the Integration Broker receives the SAD_GETAPPLS_REQ message, it responds with the SAD_GETAPPLS_RESP message.

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

SAD_GETAPPLS_RESP Message Parameters

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

<?xml version="1.0"?>
<SAD_GETAPPLS_RESP>
  <APPLICATION>
    <ADM_APPL_NBR>00024656</ADM_APPL_NBR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <ACAD_CAREER>UGRD</ACAD_CAREER>
    <APPL_STATUS>DRAFT</APPL_STATUS>
	  </APPLICATION>
  <APPLICATION>
    <ADM_APPL_NBR>00024657</ADM_APPL_NBR>
    <INSTITUTION>PSUNV</INSTITUTION>
    <ACAD_CAREER>UGRD</ACAD_CAREER>
    <APPL_STATUS>SUBMITTED</APPL_STATUS>
	  </APPLICATION>
</SAD_GETAPPLS_RESP>

Fault Message: SAD_FAULT_RESP

Refer to the SAD_FAULT_RESP message example in the SAD_CREATEAPPL section.