Get Course Enrolment (2019)

This service allows the PASI Client to retrieve a students' Course Enrolment(s) starting with the 2018 Service Endpoint & 2019 Service Endpoint1), by passing in the Course Enrolment RefId(s).

This service can be used to:

  1. Retrieve information about a Course Enrolment from the PASI Core, and
  2. Obtain updates about a Course Enrolment from the PASI Core as part of the data synchronization processes.

This service can be used to get a single record or a list of records.

The Course Enrolments that are retrievable by the PASI Client are limited to those that:

  • Are owned by the PASI Client, or
  • Have an approved marked value and is for a student that they have an Association by Recent School Enrolment or higher.

Security

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

Request Information

The information provided as part of the service request is a list of:

The PASI Client must be associated to the Organization who owns the record.

Request Validations

There are no validations performed on the service request.

Service Functionality

Information for each of the Course Enrolment 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 Reference ID provided is unknown in the PASI Core;
  • No Access if the PASI Client does not have access to the record being requested; or
  • Normal if the record(s) has been returned.

When an Expected Version is provided in the request for a Course Enrolment 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.

Request Mapping

The request information on the two service endpoints are the same.

Response Mapping

Response Information

    No links found.
1)
for the previous endpoints, refer to Get Course Enrolment (2017)