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:
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:
This version of the service is available starting with the 2018 Service Endpoint1).
This service can be accessed by systems with the View Enrolment User role.
The information provided as part of the Get Student School Enrolment request is a list of:
There are no validations performed on the service request.
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:
When an Expected Version is provided in the request for a record:
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:
Attributes in the Student School Enrolment | Returned value of Registration Status |
---|---|
Student School Enrolment Is Deleted = True | CreatedInError (Registration Status) |
Student School Enrolment Is Deleted = False and Registration Start Date is in future | Registered (Registration Status) |
Student School Enrolment Is Deleted = False and Registration Start Date is in past and Registration Exit Date is in the future. | Active (Registration Status) |
Student School Enrolment Is Deleted = False and Registration Exit Date is in past and Exit Date Type is CompletionDate. | Completed (Registration Status) |
Student School Enrolment Is Deleted = False and Registration Exit Date is in past and Exit Date Type is WithdrawalDate. | Withdrawn (Registration Status) |
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.