Get Document Orders
The Get Document Orders service is used to get a list of the Document Orders and appropriate Document Order Items stored within PASI against a specific Student or Education Account.
This service will be used in one of two ways:
To retrieve all the Document Orders and Document Order Items that have been ordered for a particular student.
To retrieve all the Document Orders, and corresponding Document Order Items, that have not been deleted and do not have a status of “Ordered” for a particular Education Account.
Security
A request to use this service will include (* denotes mandatory information):
Validation Rules
The information provided in the request is validated using the following validation rules:
Single Identifier Must Be Specified. Either the State Province Id or the Education Account must be specified to use this service.
Functionality
Once the request information has been validated, PASI Core will collect and return the Document Orders and appropriate Document Order Items using the following criteria:
If a State Province Id was provided then the service will return all the Document Orders, with a status of “Ordered”, that have a Document Order Item for that student. Please note the following:
Only Document Order Items, on the Document Orders, for that student (and any linked secondary ASNs) will be returned. For example, if an order has two items on it and each of those items have different ASNs. Then a get service call for one of the ASNs will return the order and the single item. The item for the other ASN is not returned in the response.
If an Education Account was provided then the service will return any Document Orders that were placed by that Education Account and are not with a status of “Ordered”. All Document Order Items on those orders are returned as well.
In all cases, only Document Orders and Document Order Items that are not marked as IsDeleted will be returned in the response.
A successful response to this service will include a list of one or more Document orders.
The content and the format of each document order in the response will include (* denotes mandatory information):
Document Order Identifier*
PASI Client System Name
Order Received By Method
Requestor Name
Education Account Identifier
Education Account Organization
Order Placed Date/Time
Order Status*
Total Amount*
Amount Collected*
Payment Transaction ID
Payment Method
PASI Core Version*
Document Processing Timeframe*
A list of one or more Document Order Items with each containing:
Document Order Item Number*
State Province Id*
Document Type*
Status*
Status Change Reason
Total Amount*
Amount Collected*
Control Schedule Identifier
Document Delivery Method*
Document Language*
Number of Copies*
Recipient Is Student*
Recipient Name*
Recipient Address Lines
Recipient Address City Name
Recipient Address State/Province
Recipient Address Postal Code/Zip
Recipient Address Country Name
Recipient Fax Number
Re-Order Document Order Identifier
Re-Order Document Order Item Identifier
Re-Order Reason
Special Handling Status*
A list of zero or more Document Order Errors with each containing:
Error Code
Error Description
Optionally, Transcript Order Item Specifics data attributes:
Recipient ApplyAlberta Registered Institution
ApplyAlberta Transcript Request Identifier
Provided Consent for School Release*
-
Optionally, Credential Order Item Specifics data attributes:
Optionally, Web Signup Mail Order Item Specifics data attributes:
PASI Core Version*
Processed On Date
Delivered On Date
Print Job Number
Sequence Number
Returned Business Objects