IPASIService2018GetSectionAuditEvents Method Provincial Approach to Student Information API
This service is used to retrieve audit history outlining all the changes made to a particular section. PASI Clients who can update the section information will also be able to retrieve audit history.

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

SectionAuditResponse GetSectionAuditEvents(
	SectionAuditRequest request
)

Parameters

request
Type: PASI.DataContract.V201204SectionAuditRequest
The request contains a Section reference Id (GUID) that is used to indicate the section for which audit information will be returned.

Return Value

Type: SectionAuditResponse
The response contains a list of Section\Audit data for the specified section. 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.

9035, 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
SectionAuditResponse.AuditEventsList<SectionAuditInfo>Yes
SectionAuditResponse.AuditEvents.AuditInfoAuditInfoYes
SectionAuditResponse.AuditEvents.AuditInfo.OrganizationCodeStringNo
SectionAuditResponse.AuditEvents.AuditInfo.UserNameStringNo
SectionAuditResponse.AuditEvents.SectionInfoSectionInfoYes
SectionAuditResponse.AuditEvents.SectionInfo.CourseCodesList<String>Yes
SectionAuditResponse.AuditEvents.SectionInfo.CreditsOfferedInt16Yes
SectionAuditResponse.AuditEvents.SectionInfo.DeliveryScheduleStringYesValue must be an appropriate SectionDeliverySchedule code value
SectionAuditResponse.AuditEvents.SectionInfo.DescriptionStringYesValue must be no more than 255 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]
SectionAuditResponse.AuditEvents.SectionInfo.EffectiveUtcDateTimeNo
SectionAuditResponse.AuditEvents.SectionInfo.EndDateDateTimeNo
SectionAuditResponse.AuditEvents.SectionInfo.InstructionalLanguageStringYesValue must be an appropriate InstructionalLanguage code value
SectionAuditResponse.AuditEvents.SectionInfo.InstructionalMinutesOfferedNullable`1NoValue must be between 0 and 32767
SectionAuditResponse.AuditEvents.SectionInfo.IsDeletedBooleanYes
SectionAuditResponse.AuditEvents.SectionInfo.LocalSectionIdStringNoValue must be no more than 8 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]
SectionAuditResponse.AuditEvents.SectionInfo.PASICoreVersionInt64Yes
SectionAuditResponse.AuditEvents.SectionInfo.PrimaryDeliveryMethodStringYesValue must be an appropriate PrimaryDeliveryMethod code value
SectionAuditResponse.AuditEvents.SectionInfo.RefIdGuidYes
SectionAuditResponse.AuditEvents.SectionInfo.SchoolCodeStringYesValue must be in the form of a number between '0001' and '9999'
SectionAuditResponse.AuditEvents.SectionInfo.SchoolYearInt16YesValue must be between 1900 and 2100
SectionAuditResponse.AuditEvents.SectionInfo.SectionTermStringYesValue must be an appropriate SectionTerm code value
SectionAuditResponse.AuditEvents.SectionInfo.StartDateDateTimeNo
SectionAuditResponse.RejectionsList<Rejection>No
SectionAuditResponse.Rejections.CodeStringYes
SectionAuditResponse.Rejections.DescriptionStringYes
See Also

Reference