This page describes the implementation of the service on the 2018 Service Endpoint & 2019 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.
This service can be accessed by systems with the View Academic Record User role.
The information provided as part of the Get Course Enrolment Status request is a list of:
There are no validations performed on the service request.
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 1).
The Course Enrolment Reference IDs provided in the request are validated and the result is returned in the Availability Status:
When an Expected Version is provided in the request for a record:
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.
The request information on the two service endpoints are the same.
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:
Where using the Known Source Version, the response may also include the Course Enrolment record associated to the status: