IPASIService2021GetCourseEnrolmentAuditEvents Method Provincial Approach to Student Information API
This service is used to retrieve audit history outlining all the changes made to a particular Course Enrolment.

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

CourseEnrolmentAuditResponse GetCourseEnrolmentAuditEvents(
	CourseEnrolmentAuditRequest request
)

Parameters

request
Type: PASI.DataContract.V201204CourseEnrolmentAuditRequest
The request contains a course enrolment Id (GUID) that is used to indicate the Course Enrolment for which audit information will be returned.

Return Value

Type: CourseEnrolmentAuditResponse
The response contains a list of Course Enrolment\Audit data for the specified course enrolment. 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.

9033, 9040
Remarks

The PASI Client must be associated to the Organization who owns the record. The PASI Client must be assigned the ViewAcademicRecordUser role before they are able to call this service.

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
CourseEnrolmentAuditResponse.AuditEventsList<CourseEnrolmentAuditInfo>Yes
CourseEnrolmentAuditResponse.AuditEvents.AuditInfoAuditInfoYes
CourseEnrolmentAuditResponse.AuditEvents.AuditInfo.OrganizationCodeStringNo
CourseEnrolmentAuditResponse.AuditEvents.AuditInfo.UserNameStringNo
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfoCourseEnrolmentInfoYes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.ArePrerequisitesWaivedStringYesValue must be an appropriate ArePrerequisitesWaived code value
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.CourseCodeStringYesValue must be 7 characters
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.CourseEnrolmentMarkCourseEnrolmentMarkInfoNo
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.CourseEnrolmentMark.AssignmentDateDateTimeYes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.CourseEnrolmentMark.IsMarkApprovedBooleanYes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.CourseEnrolmentMark.MarkFormatStringYesValue must be an appropriate MarkFormat code value
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.CourseEnrolmentMark.MarkValueStringYesValue must be no more than 3 characters
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.CourseEnrolmentStatusStringYesValue must be an appropriate CourseEnrolmentStatus code value
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.CreditsAttemptedInt16Yes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.EffectiveUtcDateTimeNo
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.EntryDateDateTimeNo
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.ExitDateDateTimeNo
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.InstructionalMinutesReceivedNullable`1NoValue must be between 0 and 2147483647
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.IsDeletedBooleanYes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.IsDualEnrolmentBooleanYes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.IsFundingRequestedBooleanYes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.PASICoreVersionInt64Yes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.ProviderNumberStringNoValue must be no more than 100 characters
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.RefIdGuidYes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.SectionRefIdGuidYes
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'
CourseEnrolmentAuditResponse.AuditEvents.CourseEnrolmentInfo.StudentSchoolEnrolmentRefIdGuidNo
CourseEnrolmentAuditResponse.RejectionsList<Rejection>No
CourseEnrolmentAuditResponse.Rejections.CodeStringYes
CourseEnrolmentAuditResponse.Rejections.DescriptionStringYes
See Also

Reference