IPASIService2018GetStudentCredentialRequirementAuditEvents Method Provincial Approach to Student Information API
This service is used to retrieve student credential requirement audit information for a single student based on the provided ASN and credential requirement code. Student Credential Requirement audit information will only be returned if the requestor is associated to the student.

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

StudentCredentialRequirementAuditResponse GetStudentCredentialRequirementAuditEvents(
	StudentCredentialRequirementAuditRequest request
)

Parameters

request
Type: PASI.DataContract.V201305StudentCredentialRequirementAuditRequest
Contains a StateProvinceId that identifies the student and a credential requirement code.

Return Value

Type: StudentCredentialRequirementAuditResponse
Returns student's credential requirement audit information.

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, 9053
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
CredentialRequirementStringYesValue must be an appropriate CredentialRequirement code value
StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'


Response Fields

Full Property NameTypeRequiredOther Attributes
StudentCredentialRequirementAuditResponse.AchievementAuditEventsList<CredentialRequirementAchievementAuditEvent>No
StudentCredentialRequirementAuditResponse.AchievementAuditEvents.AchievementStatusStringYes
StudentCredentialRequirementAuditResponse.AchievementAuditEvents.AuditInfoAuditInfoYes
StudentCredentialRequirementAuditResponse.AchievementAuditEvents.AuditInfo.OrganizationCodeStringNo
StudentCredentialRequirementAuditResponse.AchievementAuditEvents.AuditInfo.UserNameStringNo
StudentCredentialRequirementAuditResponse.AchievementAuditEvents.EffectiveUtcDateTimeNo
StudentCredentialRequirementAuditResponse.AchievementAuditEvents.IsDeletedBooleanYes
StudentCredentialRequirementAuditResponse.CredentialRequirementStringYes
StudentCredentialRequirementAuditResponse.ExemptionAuditEventsList<CredentialRequirementExemptionAuditEvent>No
StudentCredentialRequirementAuditResponse.ExemptionAuditEvents.AuditInfoAuditInfoYes
StudentCredentialRequirementAuditResponse.ExemptionAuditEvents.AuditInfo.OrganizationCodeStringNo
StudentCredentialRequirementAuditResponse.ExemptionAuditEvents.AuditInfo.UserNameStringNo
StudentCredentialRequirementAuditResponse.ExemptionAuditEvents.EffectiveUtcDateTimeNo
StudentCredentialRequirementAuditResponse.ExemptionAuditEvents.ExemptionReasonStringYes
StudentCredentialRequirementAuditResponse.ExemptionAuditEvents.ExemptionStatusStringYes
StudentCredentialRequirementAuditResponse.ExemptionAuditEvents.IsDeletedBooleanYes
StudentCredentialRequirementAuditResponse.RejectionsList<Rejection>No
StudentCredentialRequirementAuditResponse.Rejections.CodeStringYes
StudentCredentialRequirementAuditResponse.Rejections.DescriptionStringYes
StudentCredentialRequirementAuditResponse.StateProvinceIdStringYes
See Also

Reference