IPASIService2019GetClassroomAccommodationAuditEvents Method Provincial Approach to Student Information API
This service returns the audit events for a particular classroom accommodation.

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax

ClassroomAccommodationAuditResponse GetClassroomAccommodationAuditEvents(
	ClassroomAccommodationAuditRequest request
)

Parameters

request
Type: PASI.DataContract.V2018ClassroomAccommodationAuditRequest
Contains a ReferenceId that identifies the classroom accommodation.

Return Value

Type: ClassroomAccommodationAuditResponse
StudentRecordDocumentDetailAuditResponse A response that contains a list of audit events for the classroom accommodation.

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.

13006
Remarks

Request and Response Class Diagram



Request Fields

Full Property NameTypeRequiredOther Attributes
CallerInfoCallerInfoYes
CallerInfo.ClientMessageIDStringYesValue 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.SentUtcTimeDateTimeYes
CallerInfo.SoftwareSoftwareYes
CallerInfo.Software.BuildNumberStringYesValue 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.ManufacturerStringYesValue 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.ProductStringYesValue 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.VersionStringYesValue 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.UserUserYes
CallerInfo.User.IPAddressStringYesValue 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.LocalIDStringYesValue 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.NameStringYesValue 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.OrganizationCodeStringYesValue must be no more than 6 characters
RefIdGuidYes


Response Fields

Full Property NameTypeRequiredOther Attributes
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEventsList<ClassroomAccommodationAuditInfo>Yes
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.AuditInfoAuditInfoYes
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.AuditInfo.OrganizationCodeStringNo
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.AuditInfo.UserNameStringNo
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfoClassroomAccommodationInfoYes
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.AccommodationDetailStringNoValue 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]
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.AccommodationFormatStringNoValue must be an appropriate AccommodationFormat code value
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.AccommodationTypeStringYesValue must be an appropriate AccommodationType code value
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.EndDateDateTimeNo
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.EndDateOverrideNullable`1No
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.IsDeletedBooleanYes
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.LastUpdateUtcTimeDateTimeYes
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.PASICoreVersionInt64Yes
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.RefIdGuidYes
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.SchoolStringYesValue must be in the form of a number between '0001' and '9999'
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.StartDateDateTimeYes
ClassroomAccommodationAuditResponse.ClassroomAccommodationAuditEvents.ClassroomAccommodationInfo.StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'
ClassroomAccommodationAuditResponse.RejectionsList<Rejection>No
ClassroomAccommodationAuditResponse.Rejections.CodeStringYes
ClassroomAccommodationAuditResponse.Rejections.DescriptionStringYes
See Also

Reference