Name
ROCCreateLOA Create a Standard LOA Cover document to attach to a request.
Description
ROCCreateLOA allows the requesting Resp Orgs to create a Standard LOA Cover document, which can be attached to a ROC 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.
* dnlist A comma-separated list of numbers to be included in this LOA.
* contactcustomer The name of the company submitting this LOA.
* contactname The name of the person submitting this LOA.
* contacttitle The title of the person submitting this LOA.
* address1 The first line of the contact's address.
address2 The second line of the contact's address.
* city The contact's city.
* state The contact's state.
* zipcode The contact's zip code.
* contactphone The contact's phone number.
contactextension The contact's phone extension.
contactfax The contact's fax number.
Either the single parameter entity or the pair of parameters rocusername and rocpasswd must be specified.
ROC Messages
ROCCreateLOA sends a GenerateStandardLOA message.
Results
A RocRetrieveRequests 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.
<GenerateStandardLOAResponse>
<StatusCode>1</StatusCode>
<StandardLOAFile>
<FileName>LOABarcode.pdf</FileName>
<EncodedContent>Dkkjdkafwew9ekjsakdKJDKFJ==</EncodedContent>
<MimeType>application/pdf</MimeType>
</StandardLOAFile>
</GenerateStandardLOAResponse>
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 generate an LOA for CSF.
entity~AR;dnlist~8005551212;contactcustomer~CSF;contactname~John Smith; contacttitle~VP of Sales;address1~285 Davidson Ave;address2~Suite 103; city~Somerset;state~NJ;zipcode~08873;contactphone~7323020222; contactextension~1234;contactfax~73233020799