Submits a request to create or modify an official document consumer
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
SubmitResponse SubmitOfficialDocumentConsumer( SubmitOfficialDocumentConsumerRequest request )
Parameters
Return Value
Type: SubmitResponseA SubmitResponse with the new PASICoreVersion value after a successful update and the Id, 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, 11251, 11252, 11253, 11254, 11255, 82000, 82001, 82002, 82003, 82004, 82005, 82006Remarks
If the service encounters any errors during the submission process, it returns a list of rejections and no changes are saved.
Request and Response Class Diagram
Request Fields
| Full Property Name | Type | Required | Other Attributes |
|---|---|---|---|
| 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 |
| ContactEmail | String | Yes | Value must not contain invalid characters |
| ContactName | String | Yes | 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] |
| ContactPhone | String | Yes | 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] |
| ContactPhoneExtension | String | No | 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] Value must be no more than 7 characters |
| CountryName | String | No | Value must be no more than 60 characters |
| EmailFrequency | String | Yes | Value must be an appropriate EmailNotificationFrequency code value |
| Id | Int32 | Yes | |
| IsDeleted | Boolean | Yes | |
| LinkEmailAddress | String | Yes | Value must not contain invalid characters |
| OrganizationName | String | Yes | 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] Value must be no more than 60 characters |
| PASICoreVersion | Int64 | Yes | |
| Preference | String | Yes | Value must be an appropriate DocumentPreferenceType code value |
| Region | String | No | Value must be no more than 60 characters |
| Status | String | Yes | Value must be an appropriate ConsumerStatus code value |
Response Fields
| Full Property Name | Type | Required | Other Attributes |
|---|---|---|---|
| SubmitResponse.Id | String | No | |
| SubmitResponse.PASICoreVersion | Int64 | No | |
| SubmitResponse.Rejections | List<Rejection> | No | |
| SubmitResponse.Rejections.Code | String | Yes | |
| SubmitResponse.Rejections.Description | String | Yes |
See Also