Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)

Parameters

request

Type: PASI.DataContract.V2018ClassroomAccommodationRequest
The request contains a list of Classroom Accommodation RefIds and expected versions the client wishes to retrieve.

Return Value

Type: ListClassroomAccommodationResponse
The response contains a list of Classroom Accommodations.

Service Validations

The following codes can be returned from the service operation. This list also shows core alerts that could be generated as a result calling this service. These codes are in addition to the standard set of codes that can be returned defined as in the Approach to Error Reporting. Click the link for the details.

No additional errors for this service. This service is intended to be used during the data synchronization process using the IsDataAvailable service. See the Expected Versions section for important details on how this service will return data.

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 PASI Client must be assigned the ViewEnrolmentUser role.

The Classroom Accommodations that are retrievable by the PASI Client which has access to the requesting Student. And they are retrievable by the PASI Client which are limited to those that:

• Are owned by the PASI Client, or
• On a student that they have an Association by Ministry, by Student Creation, by Current School Enrolment, by Last School Enrolment or by Exam Registration.

Request and Response Class Diagram

Request Fields

Full Property Name	Type	Required	Other Attributes
CallerInfo	CallerInfo	Yes
CallerInfo.ClientMessageID	String	Yes	Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.SentUtcTime	DateTime	Yes
CallerInfo.Software	Software	Yes
CallerInfo.Software.BuildNumber	String	Yes	Value must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.Manufacturer	String	Yes	Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.Product	String	Yes	Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.Version	String	Yes	Value must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User	User	Yes
CallerInfo.User.IPAddress	String	Yes	Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.LocalID	String	Yes	Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.Name	String	Yes	Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.OrganizationCode	String	Yes	Value must be no more than 6 characters
ClassroomAccommodationIds	List<EntityRefIdVersionInfo>	Yes
ClassroomAccommodationIds.ExpectedVersion	Nullable`1	No
ClassroomAccommodationIds.RefId	Guid	Yes

Response Fields

Full Property Name	Type	Required	Other Attributes
List<ClassroomAccommodationResponse>	List<ClassroomAccommodationResponse>	No
List<ClassroomAccommodationResponse>.AvailabilityStatus	String	No
List<ClassroomAccommodationResponse>.ClassroomAccommodation	ClassroomAccommodationInfo	No
List<ClassroomAccommodationResponse>.ClassroomAccommodation.AccommodationDetail	String	No	Value must be no more than 1000 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Value must not contain empty lines and each line must be delimited with a carriage return and line feed. Content must not match regular expression: [\x00-\x08]|[\x0E-\x19]|[\x7F-\x9F]|[^\x00-\xFF]|(^|\n)\s*\r|\n\s*(\r|$)|[^\r]\n|\r[^\n]
List<ClassroomAccommodationResponse>.ClassroomAccommodation.AccommodationFormat	String	No	Value must be an appropriate AccommodationFormat code value
List<ClassroomAccommodationResponse>.ClassroomAccommodation.AccommodationType	String	Yes	Value must be an appropriate AccommodationType code value
List<ClassroomAccommodationResponse>.ClassroomAccommodation.EndDate	DateTime	No
List<ClassroomAccommodationResponse>.ClassroomAccommodation.EndDateOverride	Nullable`1	No
List<ClassroomAccommodationResponse>.ClassroomAccommodation.IsDeleted	Boolean	Yes
List<ClassroomAccommodationResponse>.ClassroomAccommodation.LastUpdateUtcTime	DateTime	Yes
List<ClassroomAccommodationResponse>.ClassroomAccommodation.PASICoreVersion	Int64	Yes
List<ClassroomAccommodationResponse>.ClassroomAccommodation.RefId	Guid	Yes
List<ClassroomAccommodationResponse>.ClassroomAccommodation.School	String	Yes	Value must be in the form of a number between '0001' and '9999'
List<ClassroomAccommodationResponse>.ClassroomAccommodation.StartDate	DateTime	Yes
List<ClassroomAccommodationResponse>.ClassroomAccommodation.StateProvinceId	String	Yes	Value must be in the form of a number between '000000001' and '999999999'

Reference