The Construct Document Order service is used to create a new Document Order or update the information stored in an already existing Document Order that does not have a status of “Ordered”. The service is intended to perform all the document order updates with the final update having the order go to a status of “Ordered” or having the document order be deleted.

This service can no longer be used to update Document Orders once the status of the Document Order is “Ordered”.

This service can be accessed by systems with the PASI System User role.

A request to use this service will include (* denotes mandatory information):

• Document Order Identifier *
• Request Method *
• Order Requested By
• Document Order Education Account Identifier
• Education Account Organization Code
• Order Placed Date/Time
• Order Status *
• Document Order Payment Transaction ID
• Document Order Payment Method
• Is Deleted (Document Order)*
• PASI Core Version*
• A list of one or more Document Order Items with each containing:
  • Alberta Student Number*
  • Document Order Item Type*
  • Document Order Item Amount Collected*
  • Document Processing Timeframe*
  • Control Schedule Identifier
  • Document Order Item Delivery Method*
  • Document Order Item Document Language*
  • Number of Copies*
  • Recipient Is Student*
  • Document Order Item Recipient Name*
  • Recipient Address Details including:
    • Street
    • City
    • Province
    • Postal Code
    • Country
  • Recipient Fax Number
  • Re-Order Document Order Identifier
  • Re-Order Document Order Item Identifier
  • Reorder Reason
  • Optionally, Transcript Order Item Specifics data attributes:
    • Recipient Digital Official Document Consumer
    • Document Order Item Recipient Client Identifier
    • Document Order Item Recipient Institution Identifier
    • Transcript Request Identifier
    • Provided Consent for School Release
  • Optionally, Credential specific data attributes:
    • Credential Number
  • Optionally, Web Signup Mail Order Item specific data attributes:
    • Education Account Connection ID

• Document Order
• Document Order Item
• Signup Access Code
• Transcript Order Item Specifics
• Web Signup Mail Order Item Specifics

The information provided in the request is validated using the following validation rules:

• Rule 9002 - Invalid ASN
• Rule 9009 - Deactivated ASN
• Rule 9010 - Organization Not Associated to Student
• Rule 9014 - PASI Core Out of Date
• Rule 9019 - Invalid Organization Code
• Rule 9023 - Empty Update
• Rule 60002 - Secondary ASN
• Rule 60101 - Invalid Control Schedule
• Rule 60102 - Control Schedule Must Be In Future
• Rule 60105 - Re-Order Not Fully Specified
• Rule 60106 - Cannot Re-Order the Order Item
• Rule 60107 - Invalid Delivery Method
• Rule 60108 - Missing Recipient
• Rule 60109 - Order Item Specifics Don’t Match Document Type
• Rule 60110 - Credential Number Invalid
• Rule 60111 - Missing Payment Transaction ID
• Rule 60112 - Invalid Change for Payment Pending Order
• Rule 60113 - Invalid Change for Ordered Order
• Rule 60114 - Cannot Delete Document Order
• Rule 60124 - Invalid Re-Order Document Order Item
• Rule 60125 - Order amount exceeds maximum value
• Rule 60126 - Order item amount exceeds maximum value
• Rule 60128 - Missing Credential Number
• Rule 60129 - Missing Control Schedule ID
• Rule 60130 - Missing Document Order Item(s)
• Rule 60131 - Incomplete Recipient Client Information
• Rule 60133 - Invalid Control Schedule Identifier
• Rule 60315 - Transcript Order for Empty Transcript
• Rule 60316 - Unable to order transcript
• Rule 60318 - Order cannot be constructed for deceased student
• Rule 82007 – Invalid Digital Document Consumer for Transcript

Potentially no longer used (to be confirmed):

• Rule 60116 - Invalid Delivery Method – Invalid Delivery Method

Note: All recipient mailing address validations are the responsibility of the service caller. More information on the acceptable formats of the recipient mailing addresses can be found in the Data Format Guidelines document.

Once the request information has been validated then the service will create/update the Document Order. The service does not perform any validations of content that might end up on the resulting document. It is meant to be used to make the necessary updates to bring the Document Order to a status of “Ordered”. Once it is ordered, then the Update Document Order Item must be used to make further changes to the order items as they are processed and delivered.

If a Document Order Identifier is not provided, then that means the service caller is creating a new order/order item and a new Document Order Identifier will be generated and returned.

Need to be able to support the creation of an order with a status of “ordered” with only one service call. Typically, this would be used internally for non-official docs as well as for ApplyAlberta Transcript orders.

The service will create/delete document order items as needed based on the # of items submitted for each document order.

The Document Order Item Number will be based on the order of items in the service. The item numbers are not static and will only be considered accurate once the Document Order has moved to a status of “Ordered” or “Payment Pending”.

A Document Order Item is deleted from an order by using the Construct Document Order service without including the Document Order Item that the caller wants to delete.

A Document Order is deleted if the isDelete flag is set.

The Document Order Item Status will be set based on the status of the Document Order. The following table lays out the values to use:

The Education Account Organization on a Document Order is copied from caller's Extranet Profile (if the user has one); otherwise it is set to null.

The Document Order Special Handling Status will be set to Not Required by default.

Document Order’s Document Order Total Amount and Document Order Item’s Document Order Item Total Amounts are calculated by the service. This is based on the Document Order Item Category and associated PASI Client System Name value. The logic is as follows:

Note: This should be part of the configuration of PASI. This should not be hard coded.

Only the undeleted Document Order Items are included in the calculations.

A successful response to this service will include a list of one or more Document order containing:

• Document Order Identifier*
• PASI Core Version*