IPASIService2021GetPathwayCompletionAuditEvents Method Provincial Approach to Student Information API
Retrieve the audit history outlining all the changes made to completion record for a student's pathway.

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

PathwayCompletionAuditResponse GetPathwayCompletionAuditEvents(
	PathwayCompletionAuditRequest request
)

Parameters

request
Type: PASI.DataContract.V2017PathwayCompletionAuditRequest
Contains StateProvinceId (Alberta Student Number) and PathwayCode indicating the audit history to be returned.

Return Value

Type: PathwayCompletionAuditResponse
The response contains a list of Pathway Completion data for the specified student and pathway code. The audit information includes organization, user and date the record was modified.

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


Response Fields

Full Property NameTypeRequiredOther Attributes
PathwayCompletionAuditResponse.AuditEventsList<PathwayCompletionInfo>Yes
PathwayCompletionAuditResponse.AuditEvents.CompletionDateDateTimeYes
PathwayCompletionAuditResponse.AuditEvents.CompletionSchoolYearInt16Yes
PathwayCompletionAuditResponse.AuditEvents.ContributingCoursesStringNo
PathwayCompletionAuditResponse.AuditEvents.IsDeletedBooleanYes
PathwayCompletionAuditResponse.AuditEvents.LastUpdateUtcTimeDateTimeYes
PathwayCompletionAuditResponse.AuditEvents.PASICoreVersionInt64Yes
PathwayCompletionAuditResponse.AuditEvents.PathwayCodeStringYes
PathwayCompletionAuditResponse.AuditEvents.StateProvinceIdStringYes
PathwayCompletionAuditResponse.RejectionsList<Rejection>No
PathwayCompletionAuditResponse.Rejections.CodeStringYes
PathwayCompletionAuditResponse.Rejections.DescriptionStringYes
See Also

Reference