OrderedDocumentResponse PropertiesProvincial Approach to Student Information API

The OrderedDocumentResponse type exposes the following members.

Properties

  NameDescription
Public propertyDocument
The base64 encoded Transcript PDF.
Public propertyDocumentOrderErrors
(Conditional) The errors associated with the document order item.
Public propertyDocumentOrderId
(Required) A unique public identifier for the order that can be used by all stakeholders to represent the order.
Public propertyDocumentOrderItemNumber
(Required) A public identifier for the order item (unique within the order) that can be used, in combination with the Document Order Identifier, to uniquely represent the order item.
Public propertyDocumentWarningIndicator
(Required) Indication if the document is potentially out of date based on a processing request. If false this document is up to date. If true, the caller may want to consider creating a new document order to generate a new document.
Public propertyRejections
A list of rejections generated for this request.
Public propertyXml
If requested this property will contain an XML representation of the document.
Top
See Also

Reference