Name
ROCUploadDocument Upload a LOA or other document necessary to support a request.
Description
ROCUploadDocument uploads a single document associated with a request. The following are the allowed fields in reqparams:
rocusername The username registered at SMS/800 for ROC requests.
rocpasswd The password associated with the username registered at SMS/800 for ROC requests.
entity The SMS/800 entity for ROC requests.
* txnid The Transaction ID returned from a ROCRetrieveRequests API call.
* docfilename The name of the document to be uploaded
* docencodedcontent The document data, encoded in Base64.
* doccomments Any comments to be associated with this document.
Either the single parameter entity or the pair of parameters rocusername and rocpasswd must be specified.
ROC Messages
ROCUploadDocument sends an AddDocument message.
Results
A ROCUploadDocument response is an XML document embedded within the normal API response. A typical XML response will have the following fields.
The ErrorList section will only be included if an error has occurred.
<AddDocumentResponse>
<StatusCode>1</StatusCode>
<DocumentID>345</DocumentID>
</AddDocumentResponse>
<ErrorList>
<Error>
<Code>ErrorCode1>/Code>
<Description>ErrorDescription1</Description>
<AdditionalInfo>AdditionalInfo</AdditionalInfo>
<Error>
<ErrorList>
Most data validation is left to Somos to perform. In some cases, 8MS may provide some up-front validation. In that event, the following XML will be returned.
<err>
<code>E0000000</code>
<context>param-in-error</context>
<description>text describing error.</description>
<err>
Possible errors returned for this API call include
Code Context Description
E0000093 entity/rocusername A valid 'entity' or 'rocusername' must be specified.
Example
The following request parameters will add a new document to the associated ROC Request:
entity~AR;txnid~7a4eb197-d293-4569-886c-6bf0a6745517;docfilename~newbill.tif; docencodedcontent~content-omitted