DocumentOrderConstructRequestItem PropertiesProvincial Approach to Student Information API

The DocumentOrderConstructRequestItem type exposes the following members.

Properties

  NameDescription
Public propertyAddressLines
(Conditional) Recipient mailing address.
Public propertyAmountCollected
(Required) The total amount of money that has been collected for this order.
Public propertyCityName
(Conditional) The city associated with the recipient’s address.
Public propertyCountryName
(Conditional) The country associated with the recipient’s address.
Public propertyCredentialNumber
(Conditional) The credential number associated with the order.
Public propertyDocumentDeliveryMethod
(Required) This is the delivery method for the order item.
Public propertyDocumentLanguage
(Required) Identifies the language that the document should be produced in.
Public propertyDocumentType
(Required) The type of the document being ordered.
Public propertyEducationAccountConnectionId
(Optional) The ID of the Student Connection to Education Account record that was created during the request process.
Public propertyFaxNumber
(Conditional) The fax number that the document is to be faxed to.
Public propertyNumberOfCopies
(Required) The number of copies required.
Public propertyOperationControlScheduleId
(Optional) This is the control schedule for the future delivery of the order item.
Public propertyPostalCode
(Conditional) The postal code or zip code associated with the recipient’s address.
Public propertyProcessExpectation
(Required) This is the delivery method for the order item.
Public propertyProvidedConsentForSchoolRelease
(Conditional) Indicates whether the student has given consent to release school information on the transcript.
Public propertyRecipientClientId
(Optional) This is the request client id of a transcript request if electronically requested.
Public propertyRecipientInstitutionId
(Optional) This is the recipient institution id of a transcript request if electronically requested.
Public propertyRecipientIsStudent
(Required) Indicates whether the intended recipient of the document is the student.
Public propertyRecipientName
(Required) This is the name of the party that the document order item is addressed to.
Public propertyRecipientOfficialDocumentConsumer
(Conditional) The identifier of the Digital Official Document Consumer that the order item will be sent to.
Public propertyReorderDocumentOrderId
(Conditional) The Document Order ID of another transcript order item that this order item is replacing.
Public propertyReorderDocumentOrderItemNumber
(Conditional) The Document Order Item Number of another transcript order item that this order item is replacing.
Public propertyReorderReason
(Conditional) Indicates the reason for the re-order.
Public propertyStateProvince
(Conditional) The province or state associated with the recipient’s address.
Public propertyStateProvinceId
(Required) Identifies the associated student.
Public propertyTranscriptRequestId
(Optional) This is the id of a transcript request if electronically requested.
Top
See Also

Reference