Get Student School Enrolment (2018)

This service allows the PASI Client to retrieve a students' School Enrolment(s) by passing in the School Enrolment RefId(s). This service can be used to:

  1. Retrieve information about a Student School Enrolment from the PASI Core, and
  2. Obtain updates about a Student School 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 Student School Enrolments that are retrievable by the PASI Client are limited to those that:

  • Are owned by the PASI Client, or
  • On a student that they have an Association by Recent School Enrolment or higher.

This version of the service is available starting with the 2018 Service Endpoint1).

Security

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

Request Information

The information provided as part of the Get Student School Enrolment request is a list of:

Request Validations

There are no validations performed on the service request.

Functionality

Information for each of the Student School 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 Student School Enrolment Reference IDs provided in the request are validated and the result is returned in the Availability Status:

  • Unknown if the Student School Enrolment Reference ID provided is unknown in the PASI Core;
  • No Access if the PASI Client does not have the required association to the student and did not create the record being requested; or
  • Normal if the record(s) has been returned.

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.

The Student School Enrolment information will be updated using the following mapping and then returned by the service when it is called from 2018 End Point:

Response Information

Availability Status will be returned for each requested Student School Enrolment record.

The response will contain a list of the Student School Enrolment records requested with an Availability Status of Normal:

The following data elements are returned as extended information:

Note: The FNMI Declaration extended information will on be returned if the PASI Client owns the record or has an Association By Ministry to the student.

Note: The French Hours of Instruction extended information will on be returned if the PASI Client owns the record or has an Association By Last School Enrolment, or better, to the student.

    No links found.
1)
for the current version of this service, refer to Get Student School Enrolment