PASI Knowledge Base

Table of Contents

Get School Information (2019 Service Endpoint and Prior)

This is the definition of the service on the 2019 Service Endpoint and prior endpoints. For the current definition of the service refer to Get School Information

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 using the current Get School Information service, and mapped to the information 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

The following information will be returned for each requested School record:

2019 Response Information Mapped From 2020 Response Information
Available Status Availability Status
School Code School Code

The following information will be returned for each school with an Availability Status of Normal:

2019 Response Information Mapped From 2020 Response Information
List of Organization Names Organization Name
Name Organization Operating Name
Effective Date Organization Name Effective Date
List of Organization Statuses Organization Status
Effective Date
Is Active
  • True for the period of time in which the organization is active (based on the Effective and Expiry Dates)
  • False for the period of time in which the organization is not active (based on the Effective and Expiry Dates)
List of School Classifications School Classification
Classification Type School Classification Type
Effective Date
Is Active
  • True for the period of time in which the type is active (based on Effective Date and Expiry Date)
  • False for the period of time in which the type is not active (based on the Effective Date and Expiry Date)
List of Governing Authority Governing Authority
School Authority Code School Authority Code
Effective Date Governing Authority Effective Date
List of Addresses From the Organization Delivery Address and the Organization Mailing Address
Address Reference ID Not available on the 2020 response, therefore will contain a value of 0.
Address Type
Street Street from the Address
City City from the Address
State / Province Province from the Address
Postal Code Postal Code from the Address
Country Country from the Address
Effective Date

Not available on the 2020 response, therefore is populated with:

Expiry Date Not available on the 2020 response, therefore no value is returned.
Email Address Organization Email Address
Phone Number Organization Phone Number
Fax Number Organization Fax Number
PASI Core Version PASI Core Version
Source Version Not available from the 2020 response
    No links found.
, ,
©2024 Government of Alberta Contact Us | Copyright and Disclaimer | Privacy