Get Classroom Accommodation

This service allows the PASI Client to retrieve a students' Classroom Accomodations(s) by passing in the Classroom Accommodation RefId(s). This service can be used to:

  1. Retrieve information about a Classroom Accommodation from the PASI Core, and
  2. Obtain updates about a Classroom Accommodation from the PASI Core as part of the data synchronization processes.

This service can be used to get a single record or a list of records.

The Is Data Available service operation is used to determine if there are any classroom accommodation object changes that the PASI client is interested in. The PASI client could then call this service to return those changes.

Security

This service can be accessed by systems with the View Enrolment User role.

In addition, refer to Access to a Classroom Accommodation Record for complete access rules.

Request Information

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

Request Validations

There are no validations performed on the service request.

Functionality

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

  • Unknown if the Classroom Accommodation Reference ID provided is unknown in the PASI Core;
  • No Access if the PASI Client does not have the required association to the student and did not create 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.