Get Responsible School

This Get Responsible School service allows a PASI client to access Responsible School information stored within PASI.

This service will be available from the 2019 endpoint.

Security

This service can be access by systems with the following security role(s):

Request Information

The information provided as part of this service request is a list of (* denotes mandatory information):

Service Functionality

Information for each of the Responsible School records identified in the request will be retrieved from the PASI Core and returned in the response.

The Reference IDs provided in the request are validated and the result is returned in the Availability Status:

  • Unknown if the Reference ID provided is not found or identified as a Responsible School in PASI Core.
  • No Access if the PASI Client does not meet the “Access to a Responsible School” data access rules for the record being requested; or
  • Normal if the record(s) has been returned (meaning that the caller meets the “Access to a Responsible School” data access rules for the record being requested).

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

The response will contain a list of Responsible School records requested with a response of status of Normal. A request to use this service will include the following information (* denotes mandatory information).

  • Responsible School Reference ID *
  • Availability Status *
  • Responsible School Information – only returned if the status is normal
    • Unordered List ItemPASI Core Version *
    • Effective Date
    • Student – StateProvinceID
    • Has Responsible School
    • Transition Reason
    • School Code
    • School Name
    • School City
    • School Province
    • School Country
    No links found.