Name
ROCRetrieveRequestDetail Retrieve the details of a specific request.
Description
ROCRetrieveRequestDetail allows the controlling and requesting Resp Orgs to retrieve the details of a specific request. Controlling Resp Orgs may only receive a list of numbers that have been requested of them; numbers not belonging to them may not be queried. 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.
Either the single parameter entity or the pair of parameters rocusername and rocpasswd must be specified.
ROC Messages
ROCRetrieveRequestDetail sends a GetRespOrgChangeRequest message.
Results
A RocRetrieveRequestDetail 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.
<GetRespOrgChangeRequestResponse>
<StatusCode>1</StatusCode>
<SubmittingRespOrg>art01</SubmittingRespOrg>
<SubmissionDateTime>2016-05-05T07:36:42</SubmissionDateTime>
<DueDateTime>2016-05-09T07:36:00</DueDateTime>
<LOAID>329</LOAID>
<LOAFileName>LOA File 1.pdf</LOAFileName>
<DocumentList>
<Document>
<DocumentID>330</DocumentID>
<FileTitle>Doc2.pdf</FileTitle>
<FileNotes>Remarks</FileNotes>
</Document>
<Document>
<DocumentID>331</DocumentID>
<FileTitle>Doc4.pdf</FileTitle>
<FileNotes>Remarks</FileNotes>
</Document>
</DocumentList>
<Notes></Notes>
<SubmitterName>Steve-AR Levinn</SubmitterName>
<SubmitterPhone>732-302-0222</SubmitterPhone>
<SubmitterEmail>roc@iconectiv.com</SubmitterEmail>
<SubmitterCompanyName>csf Corporation</SubmitterCompanyName>
<NewRespOrgID>art01</NewRespOrgID>
<DialNumberList>
<DialNumber>
<Dial>8448153984</Dial>
<ProcessedDateTime>2016-05-06T05:58:42.303</ProcessedDateTime>
<Status>3</Status>
<StatusDescription>Declined</StatusDescription>
<RejectReasonList>
<RejectReason>
<ReasonCode>18</ReasonCode>
<ReasonDescription>Resp Org is no longer in control of the Toll Free Number</ReasonDescription>
</RejectReason>
</RejectReasonList>
<ControllingRespOrgName>ART04</ControllingRespOrgName>
<RejectNote>Test Reject Notes</RejectNote>
</DialNumber>
</DialNumberList>
<ErrorList>
<Error>
<Code>ErrorCode1>/Code>
<Description>ErrorDescription1</Description>
<AdditionalInfo>AdditionalInfo1</AdditionalInfo>
<Error>
<ErrorList>
</GetRespOrgChangeRequestResponse>
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 retrieve detail for a specific ROC request:
entity~AR;txnid~a1dd40c5-52aa-4332-83b5-131ada513840;