Ministry only service. This service updates the Document order Item.
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax
DocumentOrderItemUpdateResponse UpdateDocumentOrderItem( DocumentOrderItemUpdateRequest request )
Parameters
- request
- Type: PASI.DataContract.SystemDocumentOrderItemUpdateRequest
The DocumentOrderItemUpdateRequest specifying the document Order Item Id, and Arguments to use for the documentOrderItem update.
Return Value
Type: DocumentOrderItemUpdateResponseA DocumentOrderItemUpdateResponse with the new PASICoreVersion value after a successful update, or with Rejections after an unsuccessful update.
Service Validations
The following codes can be returned from the service operation. This list also shows core alerts that could be generated as a result calling this service. These codes are in addition to the standard set of codes that can be returned defined as in the Approach to Error Reporting. Click the link for the details.
9023, 60101, 60102, 60105, 60107, 60108, 60109, 60110, 60115, 60116, 60118, 60120, 60121, 60123, 60126, 60128, 60129, 60131, 60315, 60316, 60319, 60320, 82007Remarks
If the service encounters any errors during the submission process, it returns a list of rejections and does not save the document order item.
Request and Response Class Diagram
Request Fields
| Full Property Name | Type | Required | Other Attributes |
|---|---|---|---|
| AddressLines | String | No | Value must be no more than 246 characters |
| AmountCollected | Decimal | Yes | Decimal number must have precision of at most 7 and scale of at most 2 Value must be greater than or equal to 0 Value must be less than or equal to 99999.99 |
| CallerInfo | CallerInfo | Yes | |
| CallerInfo.ClientMessageID | String | Yes | Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.SentUtcTime | DateTime | Yes | |
| CallerInfo.Software | Software | Yes | |
| CallerInfo.Software.BuildNumber | String | Yes | Value must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.Software.Manufacturer | String | Yes | Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.Software.Product | String | Yes | Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.Software.Version | String | Yes | Value must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.User | User | Yes | |
| CallerInfo.User.IPAddress | String | Yes | Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.User.LocalID | String | Yes | Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.User.Name | String | Yes | Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CallerInfo.User.OrganizationCode | String | Yes | Value must be no more than 6 characters |
| CityName | String | No | Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CountryName | String | No | Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| CredentialNumber | Nullable`1 | No | |
| DocumentDeliveryMethod | String | Yes | Value must be an appropriate DocumentDeliveryMethod code value |
| DocumentLanguage | String | Yes | Value must be an appropriate DocumentLanguage code value |
| DocumentOrderId | Int32 | Yes | Value must be greater than or equal to 0 |
| DocumentOrderItemNumber | Int16 | Yes | Value must be greater than or equal to 1 |
| FaxNumber | String | No | Value must be no more than 20 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| NumberOfCopies | Int16 | Yes | Value must be between 1 and 10 |
| OperationControlScheduleId | Int32 | No | Value must be greater than or equal to 0 |
| OrderItemStatus | String | Yes | Value must be an appropriate OrderItemStatus code value |
| PASICoreVersion | Int64 | Yes | Value must be greater than or equal to 0 |
| PostalCode | String | No | Value must be no more than 15 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| ProcessExpectation | String | Yes | Value must be an appropriate DocumentProcessingTimeframe code value |
| ProvidedConsentForSchoolRelease | String | No | Value must be an appropriate SchoolCodeConsentProvided code value |
| RecipientClientId | Int32 | No | Value must be greater than or equal to 0 |
| RecipientDigitalOfficialDocumentConsumer | Nullable`1 | No | |
| RecipientInstitutionId | String | No | |
| RecipientIsStudent | Boolean | Yes | |
| RecipientName | String | Yes | Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| ReorderReason | String | No | Value must be an appropriate ReorderReason code value |
| SpecialHandlingStatus | String | Yes | Value must be an appropriate SpecialHandlingStatus code value |
| StateProvince | String | No | Value must be no more than 20 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF] |
| StatusChangeReason | String | No | Value must be an appropriate StatusChangeReason code value |
Response Fields
| Full Property Name | Type | Required | Other Attributes |
|---|---|---|---|
| DocumentOrderItemUpdateResponse.PASICoreVersion | Int64 | Yes | |
| DocumentOrderItemUpdateResponse.Rejections | List<Rejection> | No | |
| DocumentOrderItemUpdateResponse.Rejections.Code | String | Yes | |
| DocumentOrderItemUpdateResponse.Rejections.Description | String | Yes |
See Also