IPASIService2020GetCredentialRequirementChecklist Method Provincial Approach to Student Information API
This service is used to retrieve Credential Requirement Checklist PDFs from PASI Core for a given list of students. The user must have the View Transcript Role.

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

CredentialRequirementChecklistResponse GetCredentialRequirementChecklist(
	CredentialRequirementChecklistRequest request
)

Parameters

request
Type: PASI.DataContract.V2019CredentialRequirementChecklistRequest

Return Value

Type: CredentialRequirementChecklistResponse

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, 9053, 60002, 60003
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
CredentialTypeStringYesValue must be an appropriate Credential code value
LanguageStringYesValue must be an appropriate DocumentLanguage code value
RequirementSetStringYesValue must be an appropriate CredentialRequirementSet code value
StudentInfosList<CredentialRequirementChecklistStudentInfo>YesList must contain no more than 100 items
StudentInfos.StateProvinceIdStringYesValue must be in the form of a number between '000000001' and '999999999'


Response Fields

Full Property NameTypeRequiredOther Attributes
CredentialRequirementChecklistResponse.CredentialRequirementChecklistsList<CredentialRequirementChecklistInfo>No
CredentialRequirementChecklistResponse.CredentialRequirementChecklists.DocumentStringNo
CredentialRequirementChecklistResponse.CredentialRequirementChecklists.IsOutOfDateBooleanNo
CredentialRequirementChecklistResponse.CredentialRequirementChecklists.RejectionsList<Rejection>No
CredentialRequirementChecklistResponse.CredentialRequirementChecklists.Rejections.CodeStringYes
CredentialRequirementChecklistResponse.CredentialRequirementChecklists.Rejections.DescriptionStringYes
CredentialRequirementChecklistResponse.CredentialRequirementChecklists.StateProvinceIdStringNo
CredentialRequirementChecklistResponse.RejectionsList<Rejection>No
CredentialRequirementChecklistResponse.Rejections.CodeStringYes
CredentialRequirementChecklistResponse.Rejections.DescriptionStringYes
See Also

Reference