This is the service definition on the 2019 Service Endpoint and prior endpoints. For the current definition of the service, see Get School Authority Information.
The Get School Authority Information service can be used for 2 purposes:
This request can be completed for a specific school authority or a list of school authorities.
The Get School Authority Information service can be accessed by systems with the Hello World User role.
The information provided as part of the Get School Authority Information request is a list of:
There are no validations performed on the service request.
Information for each of the School Authority records identified in the request will be retrieved from the PASI Core using the current Get School Authority 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 Authority Codes 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 following information will be returned for each requested School Authority record.
2019 Response Information | Mapped From 2020 Response Information |
---|---|
Availability Status | Availability Status |
Authority Code | School Authority Code |
The following information will be returned for each School Authority record requested 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 |
|
|
List of School Authority Classifications | School Authority Classification | |
Classification Type | A value School Authority Type based on a mapping of the 2020 School Authority Classification Type response:
|
|
Effective Date |
|
|
Is Active |
|
|
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 and therefore will not be populated. | |
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, therefore will contain a value of 0. |