IPASISystemSubmitDocumentType Method Provincial Approach to Student Information API
Submit a DocumentType

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax
Copy
SubmitResponse SubmitDocumentType(
	SubmitDocumentTypeRequest request
)

Parameters

request
Type: PASI.DataContract.SystemSubmitDocumentTypeRequest

Return Value

Type: SubmitResponse
A SubmitResponse with the new PASICoreVersion value after a successful update and the Id, or with Rejections after an unsuccessful update.

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.

9023, 65000, 65001, 65002, 65018, 65032, 65085, 65091, 65138, 65139, 81000, 81001
Remarks

If the service encounters any errors during the submission process, it returns a list of rejections and no changes are saved.

Request and Response Class Diagram



Request Fields

Full Property NameTypeRequiredOther Attributes
AvailableForBatchWithoutWaybillBooleanYes
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
CanHaveMultipleRelevantBooleanYes
DocumentCategoryIdsList<String>YesValue must be an appropriate DocumentCategory code value
DocumentDescriptionStringYesValue must be no more than 1000 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]
DocumentDisposalActionStringYesValue must be an appropriate DocumentDisposalAction code value
DocumentNameStringYesValue must be no more than 200 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]
DocumentTypeStringYesValue must be no more than 200 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]
DocumentTypeIdInt32Yes
EffectiveEndDateNullable`1No
EffectiveStartDateDateTimeYes
IsOrganizationBoundBooleanYes
IsRestrictedToMinistryBooleanYes
IsSchoolYearBoundBooleanYes
MaximumImageFileSizeInt32YesValue must be between 1 and 99999
PASICoreVersionInt64Yes
QualityAssuranceRatioInt16NoValue must be between 1 and 100
RequiresDocumentDateBooleanYes
RequiresDocumentExpiryDateBooleanYes
RetentionPeriodStringYesValue must be an appropriate DocumentRetentionPeriod code value
RetentionScheduleStringYesValue must be no more than 200 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]
SecurityClassificationStringYesValue must be an appropriate SecurityClassification code value
SourceDocumentQualityStringNoValue must be an appropriate SourceDocumentQuality code value


Response Fields

Full Property NameTypeRequiredOther Attributes
SubmitResponse.IdStringNo
SubmitResponse.PASICoreVersionInt64No
SubmitResponse.RejectionsList<Rejection>No
SubmitResponse.Rejections.CodeStringYes
SubmitResponse.Rejections.DescriptionStringYes
See Also

Reference

IPASISystem Interface
PASI.ServiceContract Namespace