A Student School 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 Student School 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 Student School Enrolment Status records in PASI Core and if requested, this service can also return the Student School 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 Enrolment User role.

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

• Student School Enrolment Reference ID *
• Expected Version
• Known Source Version

There are no validations performed on the service request.

Information for each of the Validation 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 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 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 Versionrequested 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.

When providing the Known Source Version, if the version of the underlying Student School Enrolment record is greater than the Known Source Version provided, the updated Student School Enrolment record will also be included in the response.

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:

• Set Registration Entry Status:
  • Always return the code value of 800 (Registration Entry Status) on the 2018 end-point.
    

• Set Registration Status:
  • PASI will interpret the value of the Registration Status based on the mapping information in table below:
    

• Set Registration Type:
  • PASI will interpret the value of the Registration Type based on the mapping information in table below:
    

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

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

• List of Core Alert records
  • Alert Code
  • Alert Type
  • Description (Core Alert)
  • Acknowledgement Status
  • List of Arguments
    • Key
    • Value
• Max Source PASI Version
• PASI Core Version

When using the Known Source Version, the response may also include the Student School Enrolment record associated to the status;

• Student School Enrolment Reference ID
• ASN
• School Code
• School Year
• Grade (Student School Enrolment)
• Registration Type
• Registration Start Date
• Registration Exit Date
• Registration Status
• School Provided Program Percentage (Note: This attribute is not returned for end points prior to 2017)
• List of Extended Information
  • Name
  • List of Values
    • Key
    • Value
• Last Updated Date and Time
• PASI Core Version