DocumentOrderItemUpdateRequest ClassProvincial Approach to Student Information API
This data contract is used in the request for the UpdateDocumentOrderItem service.
Inheritance Hierarchy
SystemObject
  PASI.DataContract.V2009RequestBase
    PASI.DataContract.SystemDocumentOrderItemUpdateRequest

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

The DocumentOrderItemUpdateRequest type exposes the following members.

Constructors
  NameDescription
Public methodDocumentOrderItemUpdateRequest
Top
Properties
  NameDescription
Public propertyAddressLines
(Conditional) Recipient mailing address
Public propertyAmountCollected
(Required) The total amount of money that has been collected for this order.
Public propertyCallerInfo
(Required) Information about the Caller
(Inherited from RequestBase.)
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 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 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 propertyOrderItemStatus
(Required) The operational status of the order item.
Public propertyPASICoreVersion
(Required) The PASI version of this object. This is used for updating the object. Value is ignored when new.
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 propertyRecipientDigitalOfficialDocumentConsumer
(Conditional) The identifier of the Digital Official Document Consumer that the order item will be sent to.
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 propertyReorderReason
(Conditional) Indicates the reason for the re-order.
Public propertySpecialHandlingStatus
(Required) Indicates the status of any special handling that is required by Student Records.
Public propertyStateProvince
(Conditional) The province or state associated with the recipient’s address.
Public propertyStatusChangeReason
(Conditional) Provides more detail on why the order item had a status change.
Top
See Also

Reference

PASI.DataContract.System Namespace