Skip to main content

ROC WSI: ROC Request Submission & Response Processing

  • Updated

This section outlines each of the ROC System Web Service operations.

Operation: SubmitRespOrgChange

This operation allows a Resp Org to submit a Resp Org Change request to another Resp Org.

The following rules must be adhered to:

  1. Request submitted for more than 1 number will be stored in the ROC System as an individual request for each number and will be associated with each other by a single transaction ID (TxnID). For example: A request submitted with 5 numbers will have 5 individual requests recorded in the system but will be associated with the same TxnID.
  2. DialNumberList parameter should include a list of unique numbers.
  3. DialNumberList parameter cannot include any numbers with Spare or Unavailable status.
  4. Can only submit a ROC request to gain a TFN for a Resp Org ID within your Entity.
  5. The ROC documents (i.e. the LOA and other supporting documents). Please Note: Only Portable Document Format (PDF) and Tagged Image File Format (TIF/TIFF) file types can be attached to the request. If TIF or TIFF file types are attached, the file(s) will be automatically converted to a PDF file type. Total size of all files cannot exceed 2 MB; this is a configurable limit.

Request Specification: SubmitRespOrgChange

Sample XML for the SubmitRespOrgChange Request:

 

<!--SUBMITRESPORGCHANGE REQUEST-->

<SubmitRespOrgChange>

 <UserName>AABBC001</UserName>

 <Password>password</Password>

 <DialNumberList>

   <DialNumber>800-123-4567</DialNumber>

   <DialNumber>8881234567</DialNumber>

   <DialNumber>8771234567</DialNumber>

   <DialNumber>8661234567</DialNumber>

   <DialNumber>8551234567</DialNumber>

 </DialNumberList>

 <NewRespOrgID>AABBC</NewRespOrgID>

 <LOAFile>

    <FileName>LOAFile1.pdf</FileName>

    <EncodedContent>ddfekdA9384KKDJFoekdjfkdls9394j3kdk43KDF==</EncodedContent>

    <MimeType>application/pdf</MimeType>

 </LOAFile>

 <Notes></Notes>

 <EmergencyROC>1</EmergencyROC>

 <EffectiveDate>2016-12-12T00:00:00</EffectiveDate>

</SubmitRespOrgChange>

 

The contents of the “LOAFile/EncodedContent” node must be encoded in the Base-64 format. For details on Base-64 format refer to: http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

 

Response Specification: SubmitRespOrgChange

Sample XML for the SubmitRespOrgChange Response:

 

<!--SUBMITRESPORGCHANGE RESPONSE-->

<SubmitRespOrgChangeResponse>

 <StatusCode>1</StatusCode>

 <TxnID>51039A75-4728-4C26-A297-A1E3946FBEA5</TxnID>

 <LOAId>190</LOAId>

 <LOAFileName>LOAFile1.pdf</LOAFileName>

 <ErrorList>

   <Error>

     <Code>VAL-01</Code>

     <Description>Dial number 888-123-4567 is not available for a Resp Org Change request       

     </Description>

     <AdditionalInfo>None</AdditionalInfo>

   </Error>

 </ErrorList>

</SubmitRespOrgChangeResponse>

 

Operation: SearchRespOrgChangeRequests

This operation allows both the requesting and controlling Resp Org within the Entity or Resp Org to search Resp Org Change requests. Controlling Resp Orgs will only receive a list of Dial numbers that have been requested of them. EntityOrRespOrgIdentifier is used to check data for Entity or Resp Org. For example: If it has 2 characters value the result set, it will have requests within the Entity and if it has 5 characters, the result will have requests within Resp Org.

 

Request Specification: SearchRespOrgChangeRequests

Sample XML for the SearchRespOrgChangeRequests Request:

 

<!--SEARCHRESPORGCHANGEREQUESTS REQUEST-->

<SearchRespOrgChangeRequest>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <FilterType>1</FilterType>

  <FilterStatus></FilterStatus>

  <FilterSubmittedDateTimeStart>2016-12-01T00:00:00</FilterSubmittedDateTimeStart>

  <FilterSubmittedDateTimeEnd>2016-12-11T00:00:00</FilterSubmittedDateTimeEnd>

  <FilterDialNumber></FilterDialNumber>

  <EntityOrRespOrgIdentifier>AABBC</EntityOrRespOrgIdentifier>

  <Progress>1</Progress>

  <RejectReasonCode>01</RejectReasonCode>

  <IsRequestCheckedOut>1</IsRequestCheckedOut>

</SearchRespOrgChangeRequest>

 

Response Specification: SearchRespOrgChangeRequests

Sample XML for the SearchRespOrgChangeRequests Response:

 

<!--SEARCHRESPORGCHANGEREQUESTS RESPONSE-->

<SearchRespOrgChangeRequestsResponse>

 <StatusCode>1</StatusCode>

 <DialNumberResultList>

   <DialNumber>

     <Dial>8002223333</Dial>

     <TxnID>8C1D4C99-8D45-49C2-899E-32B3BA3212B0</TxnID>

     <ExpediteROC>Yes</ExpediteROC>

     <SubmittedDateTime>2016-12-01T00:00:00</SubmittedDateTime>

     <ProcessedDateTime>2016-12-02T00:00:00</ProcessedDateTime>

     <DueDateTime>2016-12-02T00:00:00</DueDateTime>

     <SubmittingRespOrg>AABBC</SubmittingRespOrg>

     <NewRespOrgID>AABBC</NewRespOrgID>

     <ControllingRespOrg>CCDDD</ControllingRespOrg>

     <Status>3</Status>

     <IsRequestCheckedOut>Yes</IsRequestCheckedOut>

     <RequestCheckedOutBy>Test User</RequestCheckedOutBy>

     <LOAID>143</LOAID>

     <LOAFileName>Test 143.pdf</LOAFileName>

     <DocumentList>

<Document>

  <DocumentID>144</DocumentID>

  <FileTitle>Test 144.pdf</FileTitle>

  <FileNotes>Test Comments</FileNotes>

</Document>

<Document>

  <DocumentID>164</DocumentID>

  <FileTitle>Test 164.pdf</FileTitle>

  <FileNotes>Test Comment Notes</FileNotes>

</Document>

     </DocumentList>

     <RejectReasonList>

        <RejectReason>

          <ReasonCode>01</ReasonCode>

          <ReasonDescription>Customer name mismatch/missing</ReasonDescription>

        </RejectReason>

        <RejectReason>

          <ReasonCode>02</ReasonCode>

          <ReasonDescription>Address mismatch/missing (verification done if address is different but all other information is the same)</ReasonDescription>

        </RejectReason>

     </RejectReasonList>

     <RejectNote>Test Reject Note</RejectNote>

   </DialNumber>

 </DialNumberResultList>

 <ErrorList>

   <Error>

     <Code>ErrorCode</Code>

     <Description>ErrorDescription</Description>

     <AdditionalInfo>AdditionalInfo</AdditionalInfo>

   </Error>

 </ErrorList>

</SearchRespOrgChangeRequestsResponse>

 

Controlling Resp Orgs will only receive a list of Dial numbers that have been requested from them.

 

Operation: GetRespOrgChangeRequest

This operation retrieves detail information about a particular Resp Org Change request.

 

Request Specification: GetRespOrgChangeRequest

Sample XML for the GetRespOrgChangeRequest Request:

 

<!--GETRESPORGCHANGEREQUEST REQUEST-->

<GetRespOrgChangeRequest>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <TxnID>51039A75-4728-4C26-A297-A1E3946FBEA5</TxnID>

</GetRespOrgChangeRequest>

 

Response Specification: GetRespOrgChangeRequest

Sample XML for the GetRespOrgChangeRequest Response:

 

<!--GETRESPORGCHANGEREQUEST RESPONSE-->

<GetRespOrgChangeRequestResponse>

  <StatusCode>1</StatusCode>

  <TransactionStatus>Open</TransactionStatus>

  <SubmittingRespOrg>AABBB</SubmittingRespOrg>

  <SubmissionDateTime>2016-12-01T00:00:00</SubmissionDateTime>

  <DueDateTime>2016-12-02T00:00:00</DueDateTime>

  <LOAID>12549</LOAID>

  <LOAFileName>Test 12549.pdf</LOAFileName>

  <DocumentList>

    <Document>

     <DocumentID>1122</DocumentID>

     <FileTitle>Test 1122.pdf</FileTitle>

     <FileNotes>Test Comments</FileNotes>

    </Document>

    <Document>

     <DocumentID>11</DocumentID>

     <FileTitle>Test 164.pdf</FileTitle>

     <FileNotes>Test Comment Notes</FileNotes>

    </Document>

  </DocumentList>

  <Notes>this is test notes data</Notes>

  <SubmitterName>Smith, John</SubmitterName>

  <SubmitterPhone>111-222-3333</SubmitterPhone>

  <SubmitterEmail>email@domain.com</SubmitterEmail>

  <SubmitterCompanyName>AABBB Test</SubmitterCompanyName>

  <ExpediteROC>Yes</ExpediteROC>

  <NewRespOrgID>AAB01</NewRespOrgID>

  <IsRequestCheckedOut>Yes</IsRequestCheckedOut>

  <RequestCheckedOutBy>Test User</RequestCheckedOutBy>

  <DialNumberList>

    <DialNumber>

      <Dial>8002223333</Dial>

      <ProcessedDateTime>2016-12-01T00:00:00</ProcessedDateTime>

      <ControllingRespOrg>CCDDD</ControllingRespOrg>

      <Status>3</Status>

      <StatusDescription>Declined</StatusDescription>

      <RejectReasonList>

         <RejectReason>

           <ReasonCode>01</ReasonCode>

           <ReasonDescription>Customer name mismatch/missing</ReasonDescription>

  </RejectReason>

  <RejectReason>

    <ReasonCode>06</ReasonCode>

    <ReasonDescription>Sent to wrong Resp Org</ReasonDescription>

  </RejectReason>

      </RejectReasonList>

     <ControllingRespOrgName>CCDDD</ControllingRespOrgName>

     <RejectNote>Test Reject Notes</RejectNote>

    </DialNumber>

   </DialNumberList>

  <ErrorList>

    <Error>

      <Code>ErrorCode</Code>

      <Description>ErrorDescription</Description>

      <AdditionalInfo>AdditionalInfo</AdditionalInfo>

    </Error>

  </ErrorList>

</GetRespOrgChangeRequestResponse>

 

Operation: ProcessRespOrgChangeRequest

This operation allows the controlling Resp Org within the Entity to process a Resp Org Change request.

 

The following rules must be adhered to:

  1. A user can process a Resp Org Change requests for numbers in control only by their Entity.
  2. If the current status of a Dial number is Overdue and user process the number with action “D0” (D zero) then it will be treated as “00” (zero zero) i.e. immediate release.

Request Specification: ProcessRespOrgChangeRequest

Sample XML for the ProcessRespOrgChangeRequest Request:

 

<!--PROCESSRESPORGCHANGEREQUEST REQUEST-->

<ProcessRespOrgChangeRequest>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <TxnID>51039A75-4728-4C26-A297-A1E3946FBEA5</TxnID>

  <DialNumberList>

     <DialNumber>8001112222</DialNumber>

     <DialNumber>8661112222</DialNumber>

     <DialNumber>8771112222</DialNumber>

  </DialNumberList>

  <ActionList>

     <Action>01</Action>

     <Action>02</Action>

     <Action>06</Action>

  </ActionList>

  <RejectNote>Test Reject Note</RejectNote>

</ProcessRespOrgChangeRequest>

 

Response Specification: ProcessRespOrgChangeRequest

Sample XML for the ProcessRespOrgChangeRequest Response:

 

<!--PROCESSRESPORGCHANGEREQUEST RESPONSE-->

<ProcessRespOrgChangeRequestResponse>

  <StatusCode>1</StatusCode>

  <ErrorList>

    <Error>

      <Code>ErrorCode</Code>

      <Description>ErrorDescription</Description>

      <AdditionalInfo>AdditionalInfo</AdditionalInfo>

    </Error>

  </ErrorList>

</ProcessRespOrgChangeRequestResponse>

 

Operation: GetLOAFile

Allows a Resp Org to retrieve the Letter of Agency (LOA) file of a particular Resp Org Change request as long as they participated in that transaction.

 

Request Specification: GetLOAFile

Sample XML for the GetLOAFile Request:

 

<!--GETLOAFILE REQUEST-->

<GetLOAFile>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <LOAID>704</LOAID>

</GetLOAFile>

 

Response Specification: GetLOAFile

Sample XML for the GetLOAFile Response:

 

<!--GETLOAFILE RESPONSE-->

<GetLOAFileResponse>

  <StatusCode>1</StatusCode>

  <LOAFile>

    <FileName>LOAFile1.pdf</FileName>

    <EncodedContent>Dkkjdkafwew9ekjsakdKJDKFJ==</EncodedContent>

    <MimeType>text/pdf</MimeType>

  </LOAFile>

  <ErrorList>

    <Error>

      <Code>ErrorCode</Code>

      <Description>ErrorDescription</Description>

      <AdditionalInfo>AdditionalInfo</AdditionalInfo>

    </Error>

  </ErrorList>

</GetLOAFileResponse>

 

The contents of the “LOAFile/EncodedContent” node are binary contents of the LOA file which are encoded in the Base-64 format.

 

Operation: GetDocument

This operation allows a Resp Org to retrieve a document from a particular Resp Org Change request as long as they had participated in that transaction.

 

The following rules need to be followed:

  1. The Resp Org requesting the document must be a participant in the Resp Org Change transaction related to the document.

 

Request Specification: GetDocument

Sample XML for the GetDocument Request:

 

<!--GETDOCUMENT REQUEST-->

<GetDocument>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <DocumentID>704</DocumentID>

</GetDocument>

 

Response Specification: GetDocument

Sample XML for the GetDocument Response:

 

<!--GETDOCUMENT RESPONSE-->

<GetDocumentResponse>

  <StatusCode>1</StatusCode>

  <DocumentFile>

    <DocumentID>704</DocumentID>

    <FileTitle>Documentfile1.pdf</FileTitle>

    <EncodedContent>Dkkjdkafwew9ekjsakdKJDKFJ==</EncodedContent>

    <FileNotes>Comments related to the file</FileNotes>

  </DocumentFile>

  <ErrorList>

    <Error>

      <Code>ErrorCode</Code>

      <Description>ErrorDescription</Description>

      <AdditionalInfo>AdditionalInfo</AdditionalInfo>

    </Error>

  </ErrorList>

</GetDocumentResponse>

 

Operation: AddDocument

This operation allows a submitting Resp Org to add a document to a particular Resp Org Change request.

 

The following rules must be adhered to:

  1. The Resp Org adding the document must be a participant as a submitting Resp Org within the Entity to change transaction related to the document.
  2. The Resp Org can only add the document when all numbers are in a Pending, Overdue, or Declined status with rejection status code 16.
  3. The ROC documents (i.e. the LOA and other supporting documents). Please Note: Only Portable Document Format (PDF) and Tagged Image File Format (TIF/TIFF) file types can be attached to the request. If TIF or TIFF file types are attached, the file(s) will be automatically converted to a PDF file type. Total size of all files cannot exceed 2 MB; this is a configurable limit.

 

Request Specification: AddDocument

Sample XML for the AddDocument Request:

 

<!--ADDDOCUMENT REQUEST-->

<AddDocument>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <TxnID>51039A75-4728-4C26-A297-A1E3946FBEA5</TxnID>

  <DocumentFile>

     <FileTitle>Documentfile1.pdf</FileTitle>

     <EncodedContent>Dkkjdkafwew9ekjsakdKJDKFJ==</EncodedContent>

     <FileNotes>Comments related to the file</FileNotes>

  </DocumentFile>

</AddDocument>

 

Response Specification: AddDocument

Sample XML for the AddDocument Response:

 

<!--ADDDOCUMENT RESPONSE-->

<AddDocumentResponse>

  <StatusCode>1</StatusCode>

  <DocumentID>112234</DocumentID>

  <ErrorList>

    <Error>

      <Code>ErrorCode</Code>

      <Description>ErrorDescription</Description>

      <AdditionalInfo>AdditionalInfo</AdditionalInfo>

    </Error>

  </ErrorList>

</AddDocumentResponse>

 

Operation: RemoveDialNumber

Allows a submitting Resp Org within an Entity to remove a number (or a set of) from a Resp Org Change request as long as the numbers are still in a Pending or Overdue or Due Date Approval status.

 

The following rules must be adhered to:

  1. All Dial numbers must be still Pending, Overdue or Due Date Approval status.
  2. Dial numbers get declined with rejection status code 16.

 

Request Specification: RemoveDialNumber

Sample XML for the RemoveDialNumber Request:

 

<!--REMOVEDIALNUMBERS REQUEST-->

<RemoveDialNumbers>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <TxnID>51039A75-4728-4C26-A297-A1E3946FBEA5</TxnID>

  <DialNumberList>

    <DialNumber>800-123-4567</DialNumber>

    <DialNumber>888-123-4567</DialNumber>

    <DialNumber>877-123-4567</DialNumber>

    <DialNumber>866-123-4567</DialNumber>

    <DialNumber>855-123-4567</DialNumber>

  </DialNumberList>

</RemoveDialNumbers>

 

Response Specification: RemoveDialNumber

Sample XML for the RemoveDialNumber Response:

 

<!--REMOVEDIALNUMBERS RESPONSE-->

<RemoveDialNumbersResponse>

  <StatusCode>1</StatusCode>

  <ErrorList>

    <Error>

      <Code>ErrorCode</Code>

      <Description>ErrorDescription</Description>

      <AdditionalInfo>AdditionalInfo</AdditionalInfo>

    </Error>

  </ErrorList>

</RemoveDialNumbersResponse>

 

Operation: CancelROCRequest

This operation allows a Resp Org to cancel a Resp Org Change request.

 

The following rules must be adhered to:

  1. All Dial numbers must be still in a Pending, Overdue or Due Date Approval status.
  2. All Dial numbers get declined with rejection status code 16.

 

Request Specification: CancelROCRequest

Sample XML for the CancelROCRequest Request:

 

<!--CancelRespOrgChangeRequest REQUEST-->

<CancelRespOrgChangeRequest>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <TxnID>50B0821A-E217-42FA-90FE-F0006A4980BB</TxnID>

</CancelRespOrgChangeRequest>

 

Response Specification: CancelROCRequest

Sample XML for the CancelROCRequest Response:

 

<!--CancelRespOrgChangeRequestResponse RESPONSE-->

<CancelRespOrgChangeRequestResponse>

  <StatusCode>1</StatusCode>

  <ErrorList>

    <Error>

      <Code>ErrorCode</Code>

      <Description>ErrorDescription</Description>

      <AdditionalInfo>AdditionalInfo</AdditionalInfo>

    </Error>

  </ErrorList>

</CancelRespOrgChangeRequestResponse>

 

Operation: GetMissedChangeRequestNotifications

This operation allows a subscriber to pull retrieving failed NewIncomingChangeRequest subscriber notifications.

 

The following rules must be adhered to:

  1. The Resp Org getting the NewIncomingChangeRequest must be a subscribed to the Notification Subscriber Web Service Interface and can get missed change request within the Entity.

 

Request Specification: GetMissedChangeRequestNotifications

Sample XML for the GetMissedChangeRequestNotifications Request:

 

<!--GetMissedNotificationsRequest REQUEST-->

<GetMissedNotificationsRequest>

  <UserName>xxxxxxxx</UserName>

  <Password>password1</Password>

  <StartDate>2016-08-09T00:00:00</StartDate>

  <EndDate>2016-08-09T00:00:00</EndDate>

</GetMissedNotificationsRequest>

 

Response Specification: GetMissedChangeRequestNotifications

Sample XML for the GetMissedChangeRequestNotifications Response:

 

<!--GetMissedNotificationsResponse RESPONSE-->

<GetMissedNotificationsResponse>

  <RegistrationCode>

    <Registration>

      <Code>77DD0C86-C8E0-48F3-B0D5-8F2AC25D86A2</Code>

      <MissedChangeRequests>

        <Txn>

          <TransactionID>644B8332-9834-42F3-A439-C78EF6E7970E</TransactionID>

          <SubmittingRespOrg>AABBC</SubmittingRespOrg>

          <SubmitterName>Test, User</SubmitterName>

          <SubmitterPhone>1111111111111111111111111</SubmitterPhone>

          <SubmitterEmail>test@test.com</SubmitterEmail>

          <SubmitterCompanyName>Test Company</SubmitterCompanyName>

   <NewRespOrgID>AAB01</NewRespOrgID>

          <ControllingRespOrg>AAC01</ControllingRespOrg>

          <SubmissionDateTime>2016-07-11T12:30:23.51</SubmissionDateTime>

          <DueDateTime>2016-07-12T12:30:00</DueDateTime>

          <LOAID>87</LOAID>

          <LOAFileName>Test 87.pdf</LOAFileName>

          <ExpediteROC>Yes</ExpediteROC>

          <DialNumberList>

             <Dial>8005433343</Dial>

             <Dial>8004333454</Dial>

          </DialNumberList>

          <DocumentList>

            <Document>

              <DocumentID>84</DocumentID>

              <FileTitle>test file 84.pdf</FileTitle>

              <FileNotes>test</FileNotes>

            </Document>

            <Document>

              <DocumentID>85</DocumentID>

              <FileTitle>test file 85.pdf</FileTitle>

              <FileNotes>test</FileNotes>

            </Document>

          </DocumentList>

        </Txn>

      </MissedChangeRequests>

    </Registration>

  </RegistrationCode>

 <StatusCode>1</StatusCode>

</GetMissedNotificationsResponse>

Operation: GenerateStandardLOA

This method allows a submitting Resp Org to generate a Standard LOA cover document. Request: Please use the GenerateLOA method.

The following rules must be adhered to:

  1. LOA file will not have barcodes and LOA data and file will not be stored in database.
  2. DialNumberList parameter should include a list of unique numbers.
  3. Resp Org will sign the LOA and create a request using SubmitRespOrgChange() method with LOA and include the signed Standard LOA.

Request Specification: GenerateStandardLOA

Sample XML for the GenerateStandardLOA Request:

 

<!-- GenerateStandardLOA REQUEST-->

<GenerateStandardLOA>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <DialNumberList>

    <DialNumber>8005971096</DialNumber>

    <DialNumber>8558051865</DialNumber>

    <DialNumber>8667491252</DialNumber>

    <DialNumber>8776511362</DialNumber>

    <DialNumber>8883251668</DialNumber>

  </DialNumberList>

  <CompanyAddress1>Test Company Address 1</CompanyAddress1>

  <CustomerName>Test Customer Name</CustomerName>

  <CompanyAddress2>Test Company Address 2</CompanyAddress2>

  <City>Casa Grande</City>

  <State>Arizona (AZ)</State>

  <ZipCode>85123</ZipCode>

  <AuthorizedCustomerContact>John Doe</AuthorizedCustomerContact>

  <ContactTitle>Contact Title</ContactTitle>

  <AuthorizedCustomerPhone>8001977011</AuthorizedCustomerPhone>

  <AuthorizedCustomerExtension>123</AuthorizedCustomerExtension>

  <AuthorizedCustomerFax>800-1977-022</AuthorizedCustomerFax>

</GenerateStandardLOA>

 

Response Specification: GenerateStandardLOA

Sample XML for the GenerateStandardLOA Response:

 

<!--GenerateStandardLOA RESPONSE-->

<GenerateStandardLOAResponse>

<StatusCode>1</StatusCode>

  <StandardLOAFile>

    <FileName>LOABarcode.pdf</FileName>

    <EncodedContent>Dkkjdkafwew9ekjsakdKJDKFJ==</EncodedContent>

    <MimeType>application/pdf</MimeType>

  </StandardLOAFile>

</GenerateStandardLOAResponse>

 

Operation: EscalateROCtoHDI

This method allows a submitting Resp Org to send the request to the Help Desk for processing.

 

The following rules must be adhered to:

  1. Only a Primary Contact, Company Admin(s) or a user with Special Approver with permissions to the Resp Org Change Help Desk Intervention request will be able to submit the ROC request to the Help Desk for processing.
  2. Request must have a LOA.
  3. Only numbers with the status Expired, Declined (Except decline reason 22 - Dial number is already in control by your organization) or Overdue can be included in such request.

 

Request Specification: EscalateROCtoHDI

Sample XML for the EscalateROCtoHDI Request:

 

<!--EscalateROCtoHDI REQUEST-->

<EscalateROCtoHDIRequest>

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <TxnID>ABC0F0D0-35AA-4862-BD92-71EE227B69A1</TxnID>

  <DialNumberList>

    <DialNumber>8005977011</DialNumber>

    <DialNumber>8005977022</DialNumber>

  </DialNumberList>

  <LOAVerification>3</LOAVerification>

  <LOAVerificationComments>Test Comment</LOAVerificationComments>

  <LOAFile>

    <FileName>TEST234.PDF</FileName>

    <EncodedContent>ddfekdA9384KKDJFoekdjfkdls9394j3kdk43KDF==</EncodedContent>

    <MimeType>application/pdf</MimeType>

  </LOAFile>

  <EmergencyROC>1</EmergencyROC>

  <EffectiveDate>2018-01-12T00:00:00</EffectiveDate>

  <Aware99RespOrg>1</Aware99RespOrg>

</EscalateROCtoHDIRequest>

 

Response Specification: EscalateROCtoHDI

Sample XML for the EscalateROCtoHDI Response:

 

<!--EscalateROCtoHDI RESPONSE-->

<EscalateROCtoHDIResponse>

<StatusCode>1</StatusCode>

  <TransactionList>

    <Transaction>

      <TxnID>F62BCE2E-45C2-408D-B23A-E438712E0F71</TxnID>

      <OldRespOrgId>ABC01</OldRespOrgId>

      <LOAId>190</LOAId>

      <LOAFileName>TEST234.PDF</LOAFileName>

    </Transaction>

    <Transaction>

      <TxnID>A02ACD2D-46C2-409E-C23A-D438712F0F72</TxnID>

      <OldRespOrgId>ABC99</OldRespOrgId>

      <LOAId>192</LOAId>

      <LOAFileName>TEST234.PDF</LOAFileName>

    </Transaction>

  </TransactionList>

<WarningMessage>By submitting the request, you agree to pay the additional Resp Org Change tariff fee per Toll-Free Number.</WarningMessage>

</EscalateROCtoHDIResponse>

 

Operation: SubmitHDIRequest

This method allows a submitting Resp Org to submit a Resp Org Change Help Desk Intervention request to the Help Desk outside of the ROC System. Please Note: All Resp Org Changes must occur through the ROC System. However, if the Toll-Free Number(s) qualifies to be ported by the Help Desk under the 3.2.7 chapter of the “Industry Guidelines for Toll-Free Number Administration” document or is classified as a Special Number(s), you may proceed with submitting this request via this method.

 

The following rules must be adhered to:

  1. Request submitted for more than one number will be stored as an individual request for each number and will be associated with each other by a single transaction ID (TxnID).
  2. DialNumberList parameter should include a list of unique numbers.

 

Request Specification: SubmitHDIRequest

Sample XML for the SubmitHDIRequest Request:

 

<!--SubmitHDIRequest REQUEST-->

<SubmitHDIRequest>

  <UserName>ABWEB001</UserName>

  <Password>password</Password>

  <DialNumberList>

    <DialNumber>8005923011</DialNumber>

    <DialNumber>8005923021</DialNumber>

    <DialNumber>8005923031</DialNumber>

  </DialNumberList>

  <NewRespOrgID>ABWEB</NewRespOrgID>

  <OldRespOrgID>TST01</OldRespOrgID>

  <LOAVerification>2</LOAVerification>

  <LOAVerificationComments></LOAVerificationComments>

  <LOAFile>

    <FileName>Test LOA.PDF</FileName>

    <EncodedContent>JVBERi0xLjYKJeTjz9IKMSAwIG9iagpbLiUlRU9GCg==</EncodedContent>

    <MimeType>application/pdf</MimeType>

  </LOAFile>

  <Notes></Notes>

  <EmergencyROC>1</EmergencyROC>

  <EffectiveDate>2018-01-12T00:00:00</EffectiveDate>

  <Aware99RespOrg>0</Aware99RespOrg>

</SubmitHDIRequest>

 

Response Specification: SubmitHDIRequest

Sample XML for the SubmitHDIRequest Response:

 

<!--SubmitHDIRequest RESPONSE-->

<SubmitHDIRequestResponse>

<StatusCode>1</StatusCode>

  <TxnID>A62BCE2E-45C2-408D-B23A-E438712E0F71</TxnID>

  <LOAId>110</LOAId>

  <LOAFileName>TEST LOA.PDF</LOAFileName>

<WarningMessage>By submitting the request, you agree to pay the additional Resp Org Change tariff fee per Toll-Free Number.</WarningMessage>

</SubmitHDIRequestResponse>

 

Operation: ReSubmitHDIRequest

This method allows a submitting Resp Org to resubmit a Resp Org Change Help Desk Intervention request to the Help Desk. Please Note: All Resp Org Changes must occur through the ROC System. However, if the Toll-Free Number(s) qualifies to be ported by the Help Desk under the 3.2.7 chapter of the “Industry Guidelines for Toll-Free Number Administration” document or is classified as a Special Number(s), you may proceed with submitting this request via this method.

 

The following rules must be adhered to:

  1. Request must be in a Rejected status.
  2. Dial numbers can only be removed from request no addition of new Dial number is allowed.

Request Specification: ReSubmitHDIRequest

Sample XML for the ReSubmitHDIRequest Request:

 

<!--ReSubmitHDIRequest REQUEST-->

<ReSubmitHDIRequest>

  <UserName>TSTZK001</UserName>

  <Password>password1</Password>

  <TxnID>A62BCE2E-45C2-408D-B23A-E438712E0F71</TxnID>

  <DialNumberList>

    <DialNumber>8005923011</DialNumber>

    <DialNumber>8005923021</DialNumber>

  </DialNumberList>

  <NewRespOrgID>TST01</NewRespOrgID>

  <OldRespOrgID>ABC99</OldRespOrgID>

  <LOAVerification>2</LOAVerification>

  <LOAVerificationComments></LOAVerificationComments>

  <LOAFile>

    <FileName>Test LOA.PDF</FileName>

    <EncodedContent>JVBERi0xLjYKJeTjz9IKMSAwIG9iagpbLiUlRU9GCg==</EncodedContent>

    <MimeType>application/pdf</MimeType>

  </LOAFile>

  <Notes></Notes>

  <EmergencyROC>1</EmergencyROC>

  <EffectiveDate>2018-01-14T00:00:00</EffectiveDate>

  <Aware99RespOrg>1</Aware99RespOrg>

</ReSubmitHDIRequest>

 

Response Specification: ReSubmitHDIRequest

Sample XML for the ReSubmitHDIRequest Response:

 

<!--ReSubmitHDIRequest RESPONSE-->

<ReSubmitHDIRequestResponse>

<StatusCode>1</StatusCode>

  <TxnID>A62BCE2E-45C2-408D-B23A-E438712E0F71</TxnID>

  <LOAId>130</LOAId>

  <LOAFileName>TEST LOA.PDF</LOAFileName>

<WarningMessage>By submitting the request, you agree to pay the additional Resp Org Change tariff fee per Toll-Free Number.</WarningMessage>

</ReSubmitHDIRequestResponse>

 

Operation: SearchHDIRequests

This operation allows a submitting Resp Org to search Resp Org Change Help Desk Intervention requests.

Request Specification: SearchHDIRequests

Sample XML for the SearchHDIRequests Request:

 

<!--SearchHDIRequests REQUEST-->

<SearchHDIRequest>

  <UserName>TSTZK001</UserName>

  <Password>password</Password>

  <FilterType>1</FilterType>

  <FilterStatus>2</FilterStatus>

  <DialNumberStatusID></DialNumberStatusID>

  <FilterSubmittedDateTimeStart>2018-01-01T00:00:00</FilterSubmittedDateTimeStart>

  <FilterSubmittedDateTimeEnd>2018-01-20T00:00:00</FilterSubmittedDateTimeEnd>

  <FilterDialNumber></FilterDialNumber>

  <RejectReasonCode>9</RejectReasonCode>

</SearchHDIRequest>

 

Response Specification: SearchHDIRequests

Sample XML for the SearchHDIRequests Response:

 

<!--SearchHDIRequests RESPONSE-->

<SearchHDIRequestsResponse>

    <StatusCode>1</StatusCode>

    <DialNumberResultList>

      <DialNumber>

        <Dial>8002223333</Dial>

        <TxnID>8C1D4C99-8D45-49C2-899E-32B3BA3212B0</TxnID>

 <RequestStatus>Rejected</RequestStatus>

        <SubmittedDateTime>2018-01-10T00:00:00</SubmittedDateTime>

        <ProcessedDateTime>2018-01-12T11:24:00</ProcessedDateTime>

        <SubmittedBy>ZATST</SubmittedBy>

        <NewRespOrgId>ZATXT</NewRespOrgId>

        <OldRespOrgID>xxxxx</OldRespOrgID>

        <Status>3</Status>

        <LOAID>43</LOAID>

        <LOAFileName>Test 43.pdf</LOAFileName>

        <DocumentList>

          <Document>

            <DocumentID>1122</DocumentID>

            <FileTitle>TEST 1122.PDF</FileTitle>

          </Document>

          <Document>

            <DocumentID>3344</DocumentID>

            <FileTitle>TEST 3344.PDF</FileTitle>

          </Document>

        </DocumentList>

        <RejectReasonList>

          <RejectReason>

            <ReasonCode>9</ReasonCode>

            <ReasonDescription>Dial Number is in a Spare, Reserve, or Transitional status</ReasonDescription>

          </RejectReason>

        </RejectReasonList>

      </DialNumber>

    </DialNumberResultList>

    <ErrorList></ErrorList>

  </SearchHDIRequestsResponse>

 

Operation: GetHDIRequest

This operation allows a submitting Resp Org to retrieve detail information about a particular Resp Org Change Help Desk Intervention request.

 

Request Specification: GetHDIRequest

Sample XML for the GetHDIRequest Request:

 

<!--GetHDIRequest REQUEST-->

<GetHDIRequest>

  <UserName>ABWEB001</UserName>

  <Password>password</Password>

  <TxnID>E9123010-F9D7-44E6-B11E-954FF4D91C65</TxnID>

</GetHDIRequest>

 

Response Specification: GetHDIRequest

Sample XML for the GetHDIRequest Response:

 

<!--GetHDIRequest RESPONSE-->

<GetHDIRequestResponse>

<StatusCode>1</StatusCode>

<RequestStatus>Approved</RequestStatus>

<SubmittingRespOrg>xxxxx</SubmittingRespOrg>

<SubmissionDateTime>2017-12-27T12:31:21</SubmissionDateTime>

<LOAID>43</LOAID>

<LOAFileName>Test 43.pdf</LOAFileName>

  <DocumentList>

    <Document>

      <DocumentID>112</DocumentID>

      <FileTitle>Test 1122.pdf</FileTitle>

    </Document>

    <Document>

      <DocumentID>113</DocumentID>

      <FileTitle>Test 164.pdf</FileTitle>

    </Document>

  </DocumentList>

<Notes/>

<SubmitterName>XX YY</SubmitterName>

<SubmitterPhone>111-111-11114564564565757</SubmitterPhone>

<SubmitterEmail>none@none.com</SubmitterEmail>

<SubmitterCompanyName>xxxxx</SubmitterCompanyName>

<NewRespOrgID>xxxxy</NewRespOrgID>

<DialNumberList>

<DialNumber>

<Dial>8005977096</Dial>

<ProcessedDateTime>2013-06-27T13:19:04.37</ProcessedDateTime>

<ControllingRespOrg>xxxxx</ControllingRespOrg>

<Status>2</Status>

<StatusDescription>Declined</StatusDescription>

<ControllingRespOrgName>xxxxx</ControllingRespOrgName>

</DialNumber>

<DialNumber>

<Dial>8558057865</Dial>

<ProcessedDateTime>2013-06-27T13:19:04.37</ProcessedDateTime>

<ControllingRespOrg>xxxxx</ControllingRespOrg>

<Status>2</Status>

<StatusDescription>Declined</StatusDescription>

<ControllingRespOrgName>xxxxx</ControllingRespOrgName>

</DialNumber> 

<DialNumber>

<Dial>8883253668</Dial>

<ProcessedDateTime>2013-07-01T14:11:54.95</ProcessedDateTime>

<ControllingRespOrg>xxxxx</ControllingRespOrg>

<Status>3</Status>

<StatusDescription>Declined</StatusDescription>

<RejectReasonList>

   <RejectReason>

     <ReasonCode>7</ReasonCode>

     <ReasonDescription>Please review notes left by the Help Desk about this request   

     </ReasonDescription>

   </RejectReason>

</RejectReasonList>

<ControllingRespOrgName>xxxxx</ControllingRespOrgName>

</DialNumber>

</DialNumberList>

</GetHDIRequestResponse>

 

Operation: GetHDILOAFile

This operation allows a submitting Resp Org to retrieve the LOA file of a particular Resp Org Change Help Desk Intervention request.

 

Request Specification: GetHDILOAFile

Sample XML for the GetHDILOAFile Request:

 

<!--GetHDILOAFile REQUEST-->

<GetHDILOAFileRequest>

  <UserName>ABWEB001</UserName>

  <Password>password</Password>

  <LOAID>52</LOAID>

</GetHDILOAFileRequest>

 

Response Specification: GetHDILOAFile

Sample XML for the GetHDILOAFile Response:

 

<!--GetHDILOAFile RESPONSE-->

<GetHDILOAFileResponse>

<StatusCode>1</StatusCode>

   <LOAFile>

     <FileName>LOAFile4.pdf</FileName>

     <EncodedContent>JVBERi0xLjYKJeTjz9ICnN0YXJ0eHJlZgo5MDQlRU9GCg==</EncodedContent>

   </LOAFile>

</GetHDILOAFileResponse>

 

Operation: GetHDIDocument

This operation allows a submitting Resp Org to retrieve a document from a particular Resp Org Change Help Desk Intervention request.

Request Specification: GetHDIDocument

Sample XML for the GetHDIDocument Request:

 

<!--GetHDIDocument REQUEST-->

<GetHDIDocumentRequest>

  <UserName>ABWEB001</UserName>

  <Password>password</Password>

  <DocumentID>155</DocumentID>

</GetHDIDocumentRequest>

 

Response Specification: GetHDIDocument

Sample XML for the GetHDIDocument Response:

 

<!--GetHDIDocument RESPONSE-->

<GetHDIDocumentResponse>

   <StatusCode>1</StatusCode>

      <DocumentFile>

         <DocumentID>155</DocumentID>

         <FileTitle>Test File.pdf</FileTitle>

         <EncodedContent>JVBERi0xLjYKJeTjz9ICnN0YXJ0eHJlZgo5MDQlRU9GCg==</EncodedContent>

       </DocumentFile>

</GetHDIDocumentResponse>

 

Operation: AddHDIDocument

This operation allows a submitting Resp Org to add a document to a particular Resp Org Change Help Desk Intervention request.

 

The following rules must be adhered to:

  1. The Resp Org can only add the document when the request is not processed by the Help Desk (i.e in Unprocessed status).

 

Request Specification: AddHDIDocument

Sample XML for the AddHDIDocument Request:

 

<!--AddHDIDocument REQUEST-->

<AddHDIDocumentRequest>

  <UserName>ABWEB001</UserName>

  <Password>password</Password>

  <TxnID>A62BCE2E-45C2-408D-B23A-E438712E0F71</TxnID>

  <DocumentFile>

    <FileTitle>TestDocfile.pdf</FileTitle>

    <EncodedContent>JVBERi0xLjYKJeTjz9IKMSAwIG9iagpbLiUlRU9GCg==</EncodedContent>

  </DocumentFile>

</AddHDIDocumentRequest>

 

Response Specification: AddHDIDocument

Sample XML for the AddHDIDocument Response:

 

<!--AddHDIDocument RESPONSE-->

<AddHDIDocumentResponse>

   <StatusCode>1</StatusCode>

   <DocumentID>1134</DocumentID>

</AddHDIDocumentResponse>

 

Operation: CancelHDIRequest

This operation allows a submitting Resp Org to cancel a Resp Org Change Help Desk Intervention request.

 

The following rules must be adhered to:

  1. The Resp Org can only be cancelled when the request is not processed by the Help Desk (i.e in Unprocessed status).

 

Request Specification: CancelHDIRequest

Sample XML for the CancelHDIRequest Request:

 

<!--CancelHDIRequest REQUEST-->

<CancelHDIRequest>

  <UserName>ABWEB001</UserName>

  <Password>password</Password>

  <TxnID>50B0821A-E217-42FA-90FE-F0006A4980BB</TxnID>

</CancelHDIRequest>

 

Response Specification: CancelHDIRequest

Sample XML for the CancelHDIRequest Response:

 

<!--CancelHDIRequest RESPONSE-->

<CancelHDIRequestResponse>

  <StatusCode>1</StatusCode>

</CancelHDIRequestResponse>

 

Operation: SearchRespOrgChangeRequestsByTxnID

This operation allows both the submitting and controlling (current) Resp Org users within their Entity ID (which is the first 2 characters of the Resp Org ID) to search Resp Org Change requests related to a transaction ID (TxnID). Controlling Resp Orgs will only receive a count details of Dial numbers that have been requested of them. EntityOrRespOrgIdentifier is used to check data for the Entity ID or Resp Org ID. For example: If it has 2 characters value the result set, it will have requests associated to the provided Entity ID and if it has 5 characters, the result will have requests associated to the provided Resp Org ID.

 

Request Specification: SearchRespOrgChangeRequestsByTxnID

Sample XML for the SearchRespOrgChangeRequestsByTxnID Request:

 

<!--SearchRespOrgChangeRequestsByTxnID REQUEST -->

<SearchRespOrgChangeRequestsByTxnID >

  <UserName>AABBC001</UserName>

  <Password>password</Password>

  <FilterType>1</FilterType>

  <FilterStatus></FilterStatus>

  <FilterSubmittedDateTimeStart>2017-12-01T00:00:00</FilterSubmittedDateTimeStart>

  <FilterSubmittedDateTimeEnd>2018-07-11T00:00:00</FilterSubmittedDateTimeEnd>

  <FilterDialNumber></FilterDialNumber>

  <EntityOrRespOrgIdentifier>AABBC</EntityOrRespOrgIdentifier>

  <Progress>1</Progress>

  <RejectReasonCode>01</RejectReasonCode>

  <IsRequestCheckedOut>1</IsRequestCheckedOut>

</ SearchRespOrgChangeRequestsByTxnID >

 

Response Specification: SearchRespOrgChangeRequestsByTxnID

Sample XML for the SearchRespOrgChangeRequestsByTxnID Response:

 

<!-- SearchRespOrgChangeRequestsByTxnID RESPONSE-->

<SearchRespOrgChangeRequestsByTxnIDResponse>

  <StatusCode>1</StatusCode>

  <TransactionResultList>

    <Transaction>

      <TxnID>8C1D4C99-8D45-49C2-899E-32B3BA3212B0</TxnID>

      <TFNCount>25</TFNCount>

      <ExpediteROC>Yes</ExpediteROC>

      <SubmittedDateTime>2018-07-01T00:00:00</SubmittedDateTime>

      <DueDateTime>2018-07-03T00:00:00</DueDateTime>

      <NewRespOrgID>ZATAB</NewRespOrgID>

      <IsRequestCheckedOut>Yes</IsRequestCheckedOut>

      <RequestCheckedOutBy>xxxxxxx</RequestCheckedOutBy>

      <SubmittingRespOrg>ZATXT</SubmittingRespOrg>

      <LOAID>43</LOAID>

      <LOAFileName>Test 43.pdf</LOAFileName>

      <DocumentList>

        <Document>

          <DocumentID>1122</DocumentID>

          <FileTitle>TEST 1122.PDF</FileTitle>

          <FileNotes />

        </Document>

        <Document>

          <DocumentID>3344</DocumentID>

          <FileTitle>TEST 3344.PDF</FileTitle>

          <FileNotes />

        </Document>

      </DocumentList>

        <ControllingRespOrgList>

        <ControllingRespOrg>

            <RespOrg>ABC01</RespOrg>

            <Count>7</Count>

        </ControllingRespOrg>

          <ControllingRespOrg>

            <RespOrg>TST99</RespOrg>

            <Count>15</Count>

        </ControllingRespOrg>

      </ControllingRespOrgList>

      <UnavailRespOrgTFNCount>3</UnavailRespOrgTFNCount>

    </Transaction>

  </TransactionResultList>  

   <ErrorList></ErrorList>

  </SearchRespOrgChangeRequestsByTxnIDResponse>

 

Controlling Resp Orgs will only receive a list of Dial numbers that have been requested from them.

 

Operation: CheckOutROCRequest

This operation allows the controlling Resp Org within their Entity ID to allow check out a Resp Org Change request.

 

Request Specification: CheckOutROCRequest

Sample XML for the CheckOutROCRequest Request:

 

<!-- CheckOutROCRequest REQUEST -->

<CheckOutROCRequest>

  <UserName>ABWEB001</UserName>

  <Password>password</Password>

  <TxnID>50B0821A-E217-42FA-90FE-F0006A4980BB</TxnID>

</CheckOutROCRequest>

 

Response Specification: CheckOutROCRequest

Sample XML for the CheckOutROCRequest Response:

 

<!-- CheckOutROCRequest RESPONSE-->

<CheckOutROCRequestResponse>

  <StatusCode>1</StatusCode>

</CheckOutROCRequestResponse>

 

Operation: CheckInROCRequest

This operation allows the controlling Resp org within their Entity ID to allow check in a Resp Org Change request.

 

Request Specification: CheckInROCRequest

Sample XML for the CheckInROCRequest Request:

 

<!-- CheckInROCRequest REQUEST -->

<CheckInROCRequest>

  <UserName>ABWEB001</UserName>

  <Password>password</Password>

  <TxnID>50B0821A-E217-42FA-90FE-F0006A4980BB</TxnID>

</CheckInROCRequest>

 

Response Specification: CheckInROCRequest

Sample XML for the CheckInROCRequest Response:

 

<!-- CheckInROCRequest RESPONSE-->

<CheckInROCRequestResponse>

  <StatusCode>1</StatusCode>

</CheckInROCRequestResponse>

 

Operation: GenerateLOA

This method allows a submitting Resp Org to generate a LOA cover document. This is a new method for the GenerateStandardLOA method as it has new and updated fields available to ensure your Resp Org is using the standardized LOA.

 

The following rules must be adhered to:

  1. LOA file will not have barcodes and LOA data and file will not be stored in database.
  2. DialNumberList parameter should include a list of unique numbers.
  3. Resp Org will sign the LOA and create a request using SubmitRespOrgChange() method with LOA and include the signed LOA.

 

Request Specification: GenerateLOA

Sample XML for the GenerateLOA Request:

 

<!-- GenerateLOA REQUEST-->

<GenerateLOA>

<UserName>AABBC001</UserName>

<Password>password</Password>

<DialNumberList>

  <DialNumber>8005971096</DialNumber>

  <DialNumber>8558051865</DialNumber>

  <DialNumber>8667491252</DialNumber>

  <DialNumber>8776511362</DialNumber>

  <DialNumber>8883251668</DialNumber>

</DialNumberList>

<TollFreeSubscriber>Test Customer Name</TollFreeSubscriber>

<SubscriberAddress1>Test Company Address 1</SubscriberAddress1>

<SubscriberAddress2>Test Company Address 2</SubscriberAddress2>

<City>Casa Grande</City>

<State>Arizona (AZ)</State>

<ZipCode>85123</ZipCode>

<AuthorizedContact>8001977011</AuthorizedContact>

<ContactTitle>Contact Title</ContactTitle>

<ContactTel>8001977011</ContactTel>

<Ext>123</Ext>

<EmailAddress>Test@test.com</EmailAddress>

<RespOrgInstructions>Test test Test</RespOrgInstructions>

<EndUserInformation>Test test Test</EndUserInformation>

</GenerateLOA>

 

Response Specification: GenerateLOA

Sample XML for the GenerateLOA Response:

 

<!--GenerateLOA RESPONSE-->

<GenerateLOAResponse>

<StatusCode>1</StatusCode>

  <LOAFile>

    <FileName>LOABarcode.pdf</FileName>

    <EncodedContent>Dkkjdkafwew9ekjsakdKJDKFJ==</EncodedContent>

    <MimeType>application/pdf</MimeType>

  </LOAFile>

</GenerateLOAResponse>

 

Operation: SubmitRespOrgChangeWithDocs

This operation allows a Resp Org to submit a Resp Org Change request along with an LOA and additional documents to another Resp Org. Maximum of 4 additional documents can be uploaded while submitting a new request.

 

DISCLAIMER: If the allowed size limit is reached, the document(s) will be compressed.

 

The following rules must be adhered to:

  1. Request submitted for more than 1 number will be stored in the ROC System as an individual request for each number and will be associated with each other by a single transaction ID (TxnID). For example: A request submitted with 5 numbers will have 5 individual requests recorded in the ROC System but will be associated with the same transaction ID.
  2. DialNumberList parameter should include a list of unique numbers.
  3. DialNumberList parameter cannot include any numbers with Spare or Unavailable status.
  4. Can only submit a ROC request to gain a TFN for a Resp Org ID within your Entity.
  5. The ROC documents (i.e. the LOA and other supporting documents). Please Note: Only PDF and TIF/TIFF file types can be attached to the request. If TIF or TIFF file types are attached, the file(s) will be automatically converted to a PDF file type. Total size of all files cannot exceed 2 MB; this is a configurable limit.

Request Specification: SubmitRespOrgChangeWithDocs

Sample XML for the SubmitRespOrgChange Request:

 

<!--SUBMITRESPORGCHANGE REQUEST-->

<SubmitRespOrgChange>

 <UserName>AABBC001</UserName>

 <Password>password</Password>

 <DialNumberList>

   <DialNumber>800-123-4567</DialNumber>

   <DialNumber>8881234567</DialNumber>

   <DialNumber>8771234567</DialNumber>

   <DialNumber>8661234567</DialNumber>

   <DialNumber>8551234567</DialNumber>

 </DialNumberList>

 <NewRespOrgID>AABBC</NewRespOrgID>

 <LOAFile>

    <FileName>LOAFile1.pdf</FileName>

    <EncodedContent>ddfekdA9384KKDJFoekdjfkdls9394j3kdk43KDF==</EncodedContent>

    <MimeType>application/pdf</MimeType>

 </LOAFile>

<Doc1>

    <FileName>DocFile1.pdf</FileName>

    <EncodedContent>ddfekdA9384KKDJFoekdjfkdls9394j3kdk43KDF==</EncodedContent>

    <FileNotes> file note</FileNotes>

 </ Doc1>

<Doc2>

    <FileName>DocFile2.pdf</FileName>

    <EncodedContent>ddfekdA9384KKDJFoekdjfkdls9394j3kdk43KDF==</EncodedContent>

    <FileNotes>file note</FileNotes>

 </Doc2>

<Doc3>

    <FileName>DocFile3.pdf</FileName>

    <EncodedContent>ddfekdA9384KKDJFoekdjfkdls9394j3kdk43KDF==</EncodedContent>

    <FileNotes>file note</FileNotes>

 </Doc3>

<Doc4>

    <FileName>DocFile4.pdf</FileName>

    <EncodedContent>ddfekdA9384KKDJFoekdjfkdls9394j3kdk43KDF==</EncodedContent>

    <FileNotes>file note</FileNotes>

 </Doc4>

 <Notes></Notes>

 <EmergencyROC>1</EmergencyROC>

 <EffectiveDate>2021-12-12T00:00:00</EffectiveDate>

</SubmitRespOrgChange>

 

The contents of the “LOAFile and DocFile/EncodedContent” node must be encoded in the Base-64 format. For details on Base-64 format refer to: http://msdn.microsoft.com/en-us/library/dhx0d524.aspx

 

Response Specification: SubmitRespOrgChangeWithDocs

Sample XML for the SubmitRespOrgChange Response:

 

<!--SUBMITRESPORGCHANGE RESPONSE-->

<SubmitRespOrgChangeResponse>

 <StatusCode>1</StatusCode>

 <TxnID>51039A75-4728-4C26-A297-A1E3946FBEA5</TxnID>

 <LOAId>190</LOAId>

 <LOAFileName>LOAFile1.pdf</LOAFileName>

 <ErrorList>

   <Error>

     <Code>VAL-01</Code>

     <Description>Dial number 888-123-4567 is not available for a Resp Org Change request       

     </Description>

     <AdditionalInfo>None</AdditionalInfo>

   </Error>

 </ErrorList>

</SubmitRespOrgChangeResponse>

 

Please Note: This response specification method does not return any additional document IDs nor the additional documents. Users may use the SearchRespOrgChangeRequestsByTxnID method or use the GetRespOrgChangeRequest method for the transaction in order to view a listing of all the documents in the request. To obtain a document, please use the GetDocument or GetHDIDocument method depending upon the type of request sent.

 

Operation: GetRequestContactInformation

This operation allows you to request a CSV file with the controlling Resp Org's contact information. In the CSV file the following fields will be available: DialNumber, RespOrgID, CompanyName, CompanyAddress, PrimaryContact, ChangeContact and Notes. This information comes from the “Find Resp Org Contacts” portion of the “Resp Org Tools” section on the Somos Portal Website. This information is maintained by the Primary Contact and/or Company Administrators of the controlling Resp Org.

 

Request Specification: GetRequestContactInformation

Sample XML for the GetRequestContactInformation Request:

 

<!-- GETREQUESTCONTACTINFORMATION REQUEST-->

<GetRequestContactInformationRequest>

 <UserName>AABBC001</UserName>

 <Password>password</Password>

 <TxnID>51039A75-4728-4C26-A297-A1E3946FBEA5</TxnID>

</GetRequestContactInformationRequest>

 

Response Specification: GetRequestContactInformation

Sample XML for the GetRequestContactInformation Response:

 

<!--GETREQUESTCONTACTINFORMATION RESPONSE-->

<GetRequestContactInformation>

 <StatusCode>1</StatusCode>

 <TransactionID>51039A75-4728-4C26-A297-A1E3946FBEA5</TransactionID>

 <FileName>GetRequestContactInformation.CSV</FileName>

 <EncodedContent>ddfekdA9384KKDJFoekdjfkdls9394j3kdk43KDF==</EncodedContent>

</GetRequestContactInformation>

 

Please Note: This method allows you to request a CSV file with the controlling Resp Org's contact information. In the CSV file the following fields will be available: DialNumber, RespOrgID, CompanyName, CompanyAddress, PrimaryContact, ChangeContact and Notes. This information comes from the “Find Resp Org Contacts” portion of the “Resp Org Tools” section on the Somos Portal Website. The file is available only when the ROC System is able to identify the controlling Resp Orgs of all the numbers submitted in a transaction. Otherwise, the file will return with a message that the information is still being gathered.

Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles

Powered by Zendesk