Get School Information

This is the definition of the service starting with the 2020 Service Endpoint. For the prior service definition refer to Get School Information (2019 Service Endpoint and Prior).

The Get School Information service can be used for 2 purposes:

  1. To retrieve information about a School from the PASI Core, and
  2. To obtain updates about a School from the PASI Core as part of the data synchronization processes.

This request can be completed for a specific school or a list of school authorities.

Security

This service can be accessed by systems with the Hello World User role.

Request Information

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

Request Validations

There are no validations performed on the service request.

Functionality

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

  • Unknown if the School Code 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 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.

Response Information

    No links found.