This data contract is used in the request for the ConstructDocumentOrder service.
Inheritance Hierarchy
PASI.DataContract.SystemDocumentOrderConstructRequestItem
Namespace: PASI.DataContract.System
Assembly: PASI.DataContract (in PASI.DataContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
The DocumentOrderConstructRequestItem type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| DocumentOrderConstructRequestItem |
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.
| |
| DocumentDeliveryMethod | (Required)
This is the delivery method for the order item.
| |
| DocumentLanguage | (Required)
Identifies the language that the document should be produced in.
| |
| DocumentType | (Required)
The type of the document being ordered.
| |
| EducationAccountConnectionId |
(Optional) The ID of the Student Connection to Education Account record that was created during the request process.
| |
| FaxNumber |
(Conditional) The fax number that the document is to be faxed to.
| |
| NumberOfCopies | (Required)
The number of copies required.
| |
| OperationControlScheduleId |
(Optional) This is the control schedule for the future delivery of the order item.
| |
| PostalCode |
(Conditional) The postal code or zip code associated with the recipient’s address.
| |
| ProcessExpectation | (Required)
This is the delivery method for the order item.
| |
| ProvidedConsentForSchoolRelease |
(Conditional) Indicates whether the student has given consent to release school information on the transcript.
| |
| RecipientClientId |
(Optional) This is the request client id of a transcript request if electronically requested.
| |
| RecipientInstitutionId |
(Optional) This is the recipient institution id of a transcript request if electronically requested.
| |
| 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.
| |
| StateProvince |
(Conditional) The province or state associated with the recipient’s address.
| |
| StateProvinceId | (Required)
Identifies the associated student.
| |
| TranscriptRequestId |
(Optional) This is the id of a transcript request if electronically requested.
|
See Also