IPASIService2020GetDocumentTypes Method Provincial Approach to Student Information API
This service is used to retrieve document types.

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

DocumentTypesResponse GetDocumentTypes(
	DocumentTypeRequest request
)

Parameters

request
Type: PASI.DataContract.V2018DocumentTypeRequest
An instance of the DocumentTypeRequest data contract.

Return Value

Type: DocumentTypesResponse
Definitions of the document types that PASI supports which will describe any limitations that apply to documents of each document type.

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.

No additional errors for this service.
Remarks

This service returns document type information for records with a PASI Core Version that is greater than the Last Known Source Version that is supplied on the request.

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
LastKnownSourceVersionInt64Yes


Response Fields

Full Property NameTypeRequiredOther Attributes
DocumentTypesResponse.DocumentTypesList<DocumentTypeInfo>Yes
DocumentTypesResponse.DocumentTypes.CanHaveMultipleRelevantBooleanYes
DocumentTypesResponse.DocumentTypes.CategoriesList<String>YesValue must be an appropriate DocumentCategory code value
DocumentTypesResponse.DocumentTypes.DescriptionStringYes
DocumentTypesResponse.DocumentTypes.DisposalActionStringYesValue must be an appropriate DocumentDisposalAction code value
DocumentTypesResponse.DocumentTypes.DocumentTypeStringYes
DocumentTypesResponse.DocumentTypes.EffectiveEndDateNullable`1No
DocumentTypesResponse.DocumentTypes.EffectiveStartDateDateTimeYes
DocumentTypesResponse.DocumentTypes.IsDateRequiredBooleanYes
DocumentTypesResponse.DocumentTypes.IsExpiryDateRequiredBooleanYes
DocumentTypesResponse.DocumentTypes.IsOrganizationBoundBooleanYes
DocumentTypesResponse.DocumentTypes.IsRestrictedBooleanYes
DocumentTypesResponse.DocumentTypes.IsSchoolYearBoundBooleanYes
DocumentTypesResponse.DocumentTypes.MaximumImageFileSizeInt32Yes
DocumentTypesResponse.DocumentTypes.NameStringYes
DocumentTypesResponse.DocumentTypes.QualityAssuranceRatioInt16YesValue must be between 0 and 100
DocumentTypesResponse.DocumentTypes.RetentionPeriodStringYesValue must be an appropriate DocumentRetentionPeriod code value
DocumentTypesResponse.DocumentTypes.RetentionScheduleStringYes
DocumentTypesResponse.DocumentTypes.SecurityClassificationStringYesValue must be an appropriate SecurityClassification code value
DocumentTypesResponse.DocumentTypes.SourceDocumentQualityStringYesValue must be an appropriate SourceDocumentQuality code value
See Also

Reference