This data contract is used in the response for the GetDocumentOrders service.
Inheritance Hierarchy
PASI.DataContract.SystemDocumentOrdersGetResponseItem
Namespace: PASI.DataContract.System
Assembly: PASI.DataContract (in PASI.DataContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
The DocumentOrdersGetResponseItem type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | DocumentOrdersGetResponseItem |
Properties
| Name | Description | |
|---|---|---|
 | AddressLines |
(Conditional) Recipient mailing address
|
| AmountCollected | (Required)
The total amount of money that has been collected for this order.
|
| CityName |
(Conditional) The city associated with the recipient’s address.
|
| CountryName |
(Conditional) The country associated with the recipient’s address.
|
| CredentialNumber |
(Conditional) The credential number associated with the order.
|
| DeliveredOnUtcTime |
(Optional) The time that the order was delivered by PASI.
|
| DocumentDeliveryMethod | (Required)
This is the delivery method for the order item.
|
| DocumentLanguage | (Required)
Identifies the language that the document should be produced in.
|
| DocumentOrderErrors |
(Conditional) The errors associated with the document order item.
|
| DocumentOrderItemNumber | (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.
|
| DocumentType | (Required)
The type of the document being ordered.
|
| FaxNumber |
(Conditional) The fax number that the document is to be faxed to.
|
| LastUpdateUtcTime | (Required)
The date and time that this item was last updated.
|
| NumberOfCopies | (Required)
The number of copies required.
|
| OperationControlScheduleId |
(Optional) This is the control schedule for the future delivery of the order item.
|
| OrderItemStatus | (Required)
The operational status of the order item.
|
| PASICoreVersion | (Required)
The PASI version of this object. This is used for updating the object. The value is ignored when new or when used as part of
the SubmitDocumentOrder service.
|
| PostalCode |
(Conditional) The postal code or zip code associated with the recipient’s address.
|
| PrintJobNumber |
(Optional) The Print Job Number that the physical printing of the Document Order was assigned to, if one exists.
|
| PrintJobSequenceNumber |
(Optional) The Print Job Sequence Number used for physical printing of the document requested.
|
| ProcessedOnUtcTime |
(Optional) The time that the order was processed by PASI.
|
| ProcessExpectation | (Required)
The process expectation for this document order.
|
| ProvidedConsentForSchoolRelease | (Required)
Indicates whether the student has given consent to release school information on the transcript.
|
| RecipientClientId |
(Conditional) The identifier of the client that the order item will be sent to.
|
| RecipientInstitutionId |
(Conditional) The identifier of the client's institution that the order item will be sent to.
|
| RecipientIsStudent | (Required)
Indicates whether the intended recipient of the document is the student.
|
| RecipientName | (Required)
This is the name of the party that the document order item is addressed to.
|
| RecipientOfficialDocumentConsumer |
(Conditional) The identifier of the Digital Official Document Consumer that the order item will be sent to.
|
| ReorderDocumentOrderId |
(Conditional) The Document Order ID of another transcript order item that this order item is replacing.
|
| ReorderDocumentOrderItemNumber |
(Conditional) The Document Order Item Number of another transcript order item that this order item is replacing.
|
| ReorderReason |
(Conditional) Indicates the reason for the re-order.
|
| RequestTrackingId |
(Conditional) The identifier associated with a non-APAS transcript request that this order item is fulfilling.
|
| SpecialHandlingStatus | (Required)
Indicates the status of any special handling that is required by Student Records.
|
| StateProvince |
(Conditional) The province or state associated with the recipient’s address.
|
| StateProvinceId | (Required)
Identifies the associated student.
|
| StatusChangeReason |
(Conditional) Provides more detail on why the order item had a status change.
|
| StudentName |
(Optional) The student name used in the context of the document. (e.g. Credential recipient)
|
| TotalAmount | (Required)
Identifies the cost for this order item.
|
| WaybillRefId |
(Optional) The Globally Unique Identifier (GUID) of the Waybill associated with this document order item.
|
See Also