IPASIService2021GetStudentAuditEvents Method Provincial Approach to Student Information API
This service returns the audit events for a particular student.

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

StudentAuditEventResponse GetStudentAuditEvents(
	StudentAuditEventRequest request
)

Parameters

request
Type: PASI.DataContract.V2009StudentAuditEventRequest
Contains a StateProvinceId that identifies the student.

Return Value

Type: StudentAuditEventResponse
A response that contains a list of audit events. The audit events detail the updates made to the student by the various student submission services. This includes changes to student identification, names, addresses etc... all information related to identifying a student including the student's enrolments.

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.

9002, 9010
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
StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'


Response Fields

Full Property NameTypeRequiredOther Attributes
StudentAuditEventResponse.AuditEventsList<AuditEventInfo>Yes
StudentAuditEventResponse.AuditEvents.ActionStringNo
StudentAuditEventResponse.AuditEvents.AuditEventUtcDateTimeNo
StudentAuditEventResponse.AuditEvents.CoreMessageIdStringNo
StudentAuditEventResponse.AuditEvents.ExtendedAuditEventInfoExtendedInfoListYes
StudentAuditEventResponse.AuditEvents.ExtendedAuditEventInfo.ListList<ExtendedInfo>Yes
StudentAuditEventResponse.AuditEvents.ExtendedAuditEventInfo.List.NameStringYesValue 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]
StudentAuditEventResponse.AuditEvents.ExtendedAuditEventInfo.List.ValuesList<KeyValuePair>Yes
StudentAuditEventResponse.AuditEvents.ExtendedAuditEventInfo.List.Values.KeyStringYes
StudentAuditEventResponse.AuditEvents.ExtendedAuditEventInfo.List.Values.ValueStringYesPASI.Validation.Schema.IsNotRequired
StudentAuditEventResponse.AuditEvents.OrganizationCodeStringNo
StudentAuditEventResponse.AuditEvents.StateProvinceIdStringNo
StudentAuditEventResponse.AuditEvents.SubjectStringNoValue must be an appropriate AuditSubject code value
StudentAuditEventResponse.AuditEvents.SubjectRefIdInt32No
StudentAuditEventResponse.AuditEvents.UserNameStringNo
See Also

Reference