OrderedDocumentRequest ClassProvincial Approach to Student Information API
Request contract for the GetOrderedDocument service.
Inheritance Hierarchy
SystemObject
  PASI.DataContract.V2009RequestBase
    PASI.DataContract.V201507OrderedDocumentRequest

Namespace: PASI.DataContract.V201507
Assembly: PASI.DataContract (in PASI.DataContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
Copy
public class OrderedDocumentRequest : RequestBase

The OrderedDocumentRequest type exposes the following members.

Constructors
  NameDescription
Public methodOrderedDocumentRequest
Top
Properties
  NameDescription
Public propertyCallerInfo
(Required) Information about the Caller
(Inherited from RequestBase.)
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 propertyIncludePdfWithXml
(Required) Set this property to true to return a base 64 encoded PDF of the document. This PDF will have the data used to create the document embedded as Xml as an attachment inside the PDF.
Public propertyIncludeXml
(Required) Set this property to true if the Xml representation of the document should be returned in the Xml property of the response.
Public propertyWaitTimeInSeconds
(Required) The number of seconds the client is willing to wait for the document to be produced
Top
See Also

Reference

PASI.DataContract.V201507 Namespace