IPASIService2018BeginGetOrderedDocument Method Provincial Approach to Student Information API
The implementation of this service has been removed

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
Copy
IAsyncResult BeginGetOrderedDocument(
	OrderedDocumentRequest request,
	AsyncCallback callback,
	Object asyncState
)

Parameters

request
Type: PASI.DataContract.V201507OrderedDocumentRequest
callback
Type: SystemAsyncCallback
asyncState
Type: SystemObject

Return Value

Type: IAsyncResult

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.

60400
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
DocumentOrderIdInt32YesValue must be greater than or equal to 0
DocumentOrderItemNumberInt16YesValue must be greater than or equal to 1
IncludePdfWithXmlBooleanYes
IncludeXmlBooleanYes
WaitTimeInSecondsInt32YesValue must be between 0 and 300


Response Fields

Full Property NameTypeRequiredOther Attributes
OrderedDocumentResponse.DocumentStringNo
OrderedDocumentResponse.DocumentOrderErrorsList<DocumentOrderErrorResponseItem>No
OrderedDocumentResponse.DocumentOrderErrors.ErrorCodeInt32Yes
OrderedDocumentResponse.DocumentOrderErrors.ErrorDescriptionStringYes
OrderedDocumentResponse.DocumentOrderIdInt32Yes
OrderedDocumentResponse.DocumentOrderItemNumberInt16Yes
OrderedDocumentResponse.DocumentWarningIndicatorBooleanYes
OrderedDocumentResponse.RejectionsList<Rejection>No
OrderedDocumentResponse.Rejections.CodeStringYes
OrderedDocumentResponse.Rejections.DescriptionStringYes
OrderedDocumentResponse.XmlStringNo
See Also

Reference

IPASIService2018 Interface
PASI.ServiceContract Namespace