Get Course Enrolment Status (2017)

This page describes the implementation of the service on the 2017 Service Endpoint. For a description of the current implementation visit the Get Course Enrolment Status service page.

A Course Enrolment 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 Course Enrolment 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 Course Enrolment Status records in PASI Core and if requested, this service can also return the Course Enrolment entity information.

This service can be used as required, or as part of the data synchronization processes.

Security

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

Request Information

The information provided as part of the Get Course Enrolment Status request is a list of:

  • Course Enrolment Reference ID *
  • Expected Version - The version of the Course Enrolment Status record that the PASI Client is expected.
  • Known Source Version - The version of the underlying Course Enrolment record that the PASI Client has currently synchronized. Using the Known Source Version provides the ability to synchronize both Course Enrolment Status and Course Enrolment 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 Course Enrolment 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 Course Enrolment Reference IDs provided in the request are validated and the result is returned in the Availability Status:

  • Unknown if the Course Enrolment 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 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 a Known Source Version is provided in the request, if the version of the underlying Course Enrolment record is greater than the Known Source Version provided, the updated Course Enrolment record will also be included in the response.

Request Mapping

The request information on the service endpoint are the same.

Response Mapping

Response Information

Availability Status will be returned for each requested Course Enrolment record.

The response will contain a list of the Validation Status (Course Enrolment) record requested with an Availability Status of Normal:

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

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

    No links found.