Get Section Status (2018)

This page describes the implementation of the service on the 2017 and 2018 Service Endpoint. For a description of the current implementation visit the Get Section Status service page.

A Section Status object identifies any business rule validations that have failed in the form of a Core Alert. Refer to any Validation Rules implemented by the Section Status Processor for a list of the business rules. These issues need to be resolved by an end-user to ensure that the data in PASI remains of high quality.

This service is used to acquire Section Status records in PASI Core and if requested, this service can also return the Section entity information. This service can be used as required, or as part of the data synchronization processes.

Security

The service can be accessed by systems with the View Academic Record User role.

Request Information

The following information is provided when using this service:

  • Expected Version: The version of the Section Status record that the PASI Client is expected.
  • Known Source Version: The version of the underlying Section record that the PASI Client has currently synchronized. Using the Known Source Version provides the ability to synchronize both Section Status and Section at the same time which may help to simplify client data synchronization.

Request Validations

There are no validations performed on the service request.

Service Functionality

Information for each of the Section Status records identified in the request will be retrieved from the PASI Core and returned in the response. If a list of records has been requested, they will be processed in the order provided.

The Section Reference IDs provided in the request are validated and the result is returned in the Response Status:

  • Unknown if the Section ID provided is unknown in the PASI Core;
  • No Access if the PASI Client does not have access to the record being requested;
  • Normal if the record has been returned; or
  • Recalculating if the status is being recalculated.

When an Expected Version is provided in the request for a record:

  • If the Expected Version requested is ‘0’, the current PASI Version of the record will be returned.
  • If the Expected Version requested is the same as the PASI Version of the record, the record will be returned.
  • If the Expected Version requested is not the same as the PASI Version of the record, the record will not be returned and no further requested records will be processed.

When providing the Known Source Version, if the version of the underlying Section record is greater than the Known Source Version provided, the updated Section record will also be included in the response.

Response Information

Availability Status will be returned for each requested Validation Status record for each Section.

The response will contain a list of the Validation Status records requested with a response status of Normal:

  • Section Status Information
    • Section Reference ID
    • List of Core Alerts
      • Alert Code
      • Alert Type
      • Description
      • Acknowledgement Status
      • List of Arguments
        • Argument Key
        • Argument Value
    • Max Source PASI Version
    • PASI Core Version

Where using the Known Source Version, the response may also include the Section record associated to the status:

  • Section Information
    • Section Reference ID
    • School Code
    • School Year
    • Section Term
    • Start Date
    • End Date
    • Description
    • Instructional Language
    • Instructional Minutes Offered
    • Credits Offered
    • Primary Delivery Method
    • Delivery Schedule
    • Local Section ID
    • List of Course Codes
    • Is Deleted
    • PASI Core Version
    • Last Updated Date and Time
    No links found.