Skip to main content

ROC WSI Notification Subscriber: ROC Request Submission & Response Processing

  • Updated

This section outlines each of the ROC Notification Subscriber Web Service operations.

Operation: NewIncomingChangeRequestNotification

This operation will be called to notify the subscribed controlling (current) Resp Org when a new incoming ROC request is available. This notification call is made at the Resp Org ID level with list of Dial numbers related to controlling Resp Org.

If Resp Org Change Web Service Interface is not available, method will be called again within an hour. No other retries will be made. An email will be sent to the registered email address informing the Resp Org of an issue with the published Web Service.

Request Specification: NewIncomingChangeRequestNotification

Sample XML for the NewIncomingChangeRequestNotification Request:

 

<!-- NEWINCOMINGCHANGEREQUESTNOTIFICATION REQUEST-->

  <NewIncomingChangeRequestNotification>

    <RegistrationCode>ADAD4DSsdf5545dfsdfA</RegistrationCode>

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

    <SubmittingRespOrg>AABBB</SubmittingRespOrg>

    <SubmitterName>Smith, John</SubmitterName>

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

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

    <SubmitterCompanyName>BBXXX</SubmitterCompanyName>

    <NewRespOrgID>AAB01</NewRespOrgID>

    <ControllingRespOrg>CCDDD</ControllingRespOrg>

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

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

    <LOAID>12549</LOAID>

    <LOAFileName>Test.pdf</LOAFileName>

    <ExpediteROC>Yes</ExpediteROC>

    <DialNumberList>

       <Dial>800-222-3333</Dial>

       <Dial>800-222-4444</Dial>

    </DialNumberList>  

    <DocumentList>

        <Document>

            <DocumentID>1122</DocumentID>

<FileTitle><![CDATA[TEST 1122.PDF]]</FileTitle>

            <FileNotes><![CDATA[test]]></FileNotes>

        </Document>

        <Document>

            <DocumentID>3344</DocumentID>

     <FileTitle><![CDATA[TEST 3344.PDF]]</FileTitle>

            <FileNotes><![CDATA[test]]></FileNotes>

        </Document>

    </DocumentList>

</NewIncomingChangeRequestNotification>

 

Response Specification: NewIncomingChangeRequestNotification

In response xml, StatusCode can have following values:

  1. If we get 0 (zero) in StatusCode, it means false or failure of receipt request.
  2. If we get 1 in StatusCode, it means successful calling.
  3. If we get 2 in StatusCode, then a Notification failure error message will be sent to the Help Desk as well as the Resp Org. The notification will include the number of attempts as 2nd and include and optional parameter ErrorReason received in the response.

Successful Sample XML for the NewIncomingChangeRequestNotification Response:

 

<!-- NEWINCOMINGCHANGEREQUESTNOTIFICATION RESPONSE-->

  <NewIncomingChangeRequestNotificationResponse>

       <StatusCode>1</StatusCode>

  </NewIncomingChangeRequestNotificationResponse>

    

Unsuccessful Sample XML for the NewIncomingChangeRequestNotification Response:

 

<!-- NEWINCOMINGCHANGEREQUESTNOTIFICATION RESPONSE-->

  <NewIncomingChangeRequestNotificationResponse>

       <StatusCode>2</StatusCode>

       <ErrorReason>NewIncomingChangeRequestNotification failed to deserialize the response</ErrorReason>

  </NewIncomingChangeRequestNotificationResponse>

 

Operation: ProcessedOutgoingChangeRequestNotification

This operation will be called to notify the subscribed submitting (new) Resp Org when a change is processed to an outgoing ROC request. This method can be called multiple times if a ROC request contains more than one Dial number since processing can occur in batches.

If Resp Org Change Web Service Interface is not available, method will be called again within an hour. No other retries will be made. An email will be sent to the registered email address informing the Resp Org of an issue with the published Web Service.

 

Request Specification: ProcessedOutgoingChangeRequestNotification

Sample XML for the ProcessedOutgoingChangeRequestNotification Request:

 

<!-- PROCESSEDOUTGOINGCHANGEREQUESTNOTIFICATION REQUEST-->

<ProcessedOutgoingChangeRequestNotification>

  <RegistrationCode>ADAD4DSsdf5545dfsdfA</RegistrationCode>

  <TxnID>62540B86-0709-8A36-D308-B2C4027GCFB6</TxnID>

    <DialNumberList>

       <DialNumber>

          <Dial>800-222-3333</Dial>

          <CurrentRespOrg>CCDDD</CurrentRespOrg>

          <CompanyName>Test-1 Resp Org</CompanyName>

          <Status>Ported</Status>

          <ProcessedDateTime>2018-07-11T12:30:23.51</ProcessedDateTime>

       </DialNumber>

       <DialNumber>

          <Dial>800-333-444</Dial>

   <CurrentRespOrg>BBDDD</CurrentRespOrg>

   <CompanyName>Test-2 Resp Org</CompanyName>

   <Status>Declined</Status>

   <RejectNote>Test Reject Notes</RejectNote>

   <ProcessedDateTime>2018-07-11T12:30:23.51</ProcessedDateTime>

   <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>

       </DialNumber>

  </DialNumberList>

 <Notes>Test ROC Notes</Notes>

</ProcessedOutgoingChangeRequestNotification>

 

Response Specification: ProcessedOutgoingChangeRequestNotification

In response xml, StatusCode can have following values:

  1. If we get 0 (zero) in StatusCode, it means false or failure of receipt request.
  2. If we get 1 in StatusCode, it means successful calling.
  3. If we get 2 in StatusCode, then a Notification failure error message will be sent to the Help Desk as well as the Resp Org. The notification will include the number of attempts as 2nd and include and optional parameter ErrorReason received in the response.

Successful Sample XML for the ProcessedOutgoingChangeRequestNotification Response:

 

<!--PROCESSEDOUTGOINGCHANGEREQUESTNOTIFICATION RESPONSE-->

  <ProcessedOutgoingChangeRequestNotificationResponse>

    <StatusCode>1</StatusCode>

    </ProcessedOutgoingChangeRequestNotificationResponse>

 

Unsuccessful Sample XML for the ProcessedOutgoingChangeRequestNotification Response:

 

<!--PROCESSEDOUTGOINGCHANGEREQUESTNOTIFICATION RESPONSE-->

  <ProcessedOutgoingChangeRequestNotificationResponse>

    <StatusCode>2</StatusCode>

    <ErrorReason>ProcessedOutgoingChangeRequestNotification failed to deserialize the response</ErrorReason>

  </ProcessedOutgoingChangeRequestNotificationResponse>

 

Operation: PushedToRespOrgs

This operation will be called to notify the subscribed submitting Resp Org when their submitted ROC request has been sent to all involved controlling Resp Orgs. This notification call is made at the Resp Org ID level.

If Resp Org Web Service interface is not available, method will be called again within an hour. No other retries will be made. An email will be sent to the registered email address informing the Resp Org of an issue with the published Web Service.

 

Request Specification: PushedToRespOrgs

Sample XML for the PushedToRespOrgs Request:

 

<!—PUSHEDTORESPORGS REQUEST-->

 <PushedToRespOrgsRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

    <RegistrationCode>ADAD4DSsdf5545dfsdfA</RegistrationCode>

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

    <DialNumberDetailList>

        <DialNumber>

            <Dial>8552725004</Dial>

            <CurrentRespOrgID>AAM01</CurrentRespOrgID>

            <CompanyName><![CDATA[W&amp;W Resp Org]]</CompanyName>

        </DialNumber>

        <DialNumber>

            <Dial>8552725006</Dial>

            <CurrentRespOrgID>AAM01</CurrentRespOrgID>

            <CompanyName><![CDATA[W&amp;W Resp Org]]</CompanyName>

        </DialNumber>

        <DialNumber>

            <Dial>8552725008</Dial>

            <CurrentRespOrgID>AAM01</CurrentRespOrgID>

            <CompanyName><![CDATA[W&amp;W Resp Org]]</CompanyName>

        </DialNumber>

        <DialNumber>

            <Dial>8552725010</Dial>

            <CurrentRespOrgID>AAM01</CurrentRespOrgID>

            <CompanyName><![CDATA[W&amp;W Resp Org]]</CompanyName>

        </DialNumber>

        <DialNumber>

            <Dial>8552725012</Dial>

            <CurrentRespOrgID>AAM01</CurrentRespOrgID>

            <CompanyName><![CDATA[W&amp;W Resp Org]]</CompanyName>

        </DialNumber>

        <DialNumber>

            <Dial>8554722209</Dial>

            <CurrentRespOrgID>AAM01</CurrentRespOrgID>

            <CompanyName><![CDATA[W&amp;W Resp Org]]</CompanyName>

        </DialNumber>

        <DialNumber>

            <Dial>8554722211</Dial>

            <CurrentRespOrgID>AAM01</CurrentRespOrgID>

            <CompanyName><![CDATA[W&amp;W Resp Org]]</CompanyName>

        </DialNumber>

    </DialNumberDetailList>

  </PushedToRespOrgsRequest>

 

Response Specification: PushedToRespOrgs

In response xml, StatusCode can have following values:

  1. If we get 0 (zero) in StatusCode, it means false or failure of receipt request.
  2. If we get 1 in StatusCode, it means successful calling.
  3. If we get 2 in StatusCode, then a Notification failure error message will be sent to the Help Desk as well as the Resp Org. The notification will include the number of attempts as 2nd and include and optional parameter ErrorReason received in the response.

Successful Sample XML for the PushedToRespOrgs Response:

 

<!--PUSHEDTORESPORGS RESPONSE-->

  <PushedToRespOrgsResponse>

    <StatusCode>1</StatusCode>   

  </PushedToRespOrgsResponse>

 

Unsuccessful Sample XML for the PushedToRespOrgs Response:

 

<!--PUSHEDTORESPORGS RESPONSE-->

  <PushedToRespOrgsResponse>

    <StatusCode>2</StatusCode>

    <ErrorReason>PushedToRespOrgs failed to deserialize the response</ErrorReason>

  </PushedToRespOrgsResponse>

 

Operation: ProcessedIncomingChangeRequestNotification

This operation will be called to notify the subscribed controlling Resp Org when a change is processed to an incoming ROC request. This operation can be called multiple times if a ROC request contains more than one Dial number since processing can occur in batches.

If Resp Org Change Web Service Interface is not available, method will be called again within an hour. No other retries will be made. An email will be sent to the registered email address informing the Resp Org of an issue with the published Web Service.

 

Request Specification: ProcessedIncomingChangeRequestNotification

Sample XML for the ProcessedIncomingChangeRequestNotification Request:

 

<!--PROCESSEDINCOMINGCHANGEREQUESTNOTIFICATION REQUEST-->

<ProcessedIncomingChangeRequestNotification>

  <RegistrationCode>ADAD4DSsdf5545dfsdfA</RegistrationCode>

  <TxnID>62540B86-0709-8A36-D308-B2C4027GCFB6</TxnID>

    <DialNumberList>

       <DialNumber>

          <Dial>800-222-3333</Dial>

          <CurrentRespOrg>CCDDD</CurrentRespOrg>

          <CompanyName>Test-1 Resp Org</CompanyName>

          <Status>Ported</Status>

          <ProcessedDateTime>2018-07-10T12:30:23.51</ProcessedDateTime>

       </DialNumber>

       <DialNumber>

          <Dial>800-333-444</Dial>

   <CurrentRespOrg>BBDDD</CurrentRespOrg>

   <CompanyName>Test-2 Resp Org</CompanyName>

   <Status>Declined</Status>

   <ProcessedDateTime>2018-07-10T12:30:23.51</ProcessedDateTime>

   <RejectNote>Test Reject Notes</RejectNote>

   <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>

       </DialNumber>

  </DialNumberList>

 <Notes>Test ROC Notes</Notes>

</ProcessedIncomingChangeRequestNotification>

 

Response Specification: ProcessedIncomingChangeRequestNotification

In response xml, StatusCode can have following values:

  1. If we get 0 (zero) in StatusCode, it means false or failure of receipt request.
  2. If we get 1 in StatusCode, it means successful calling.
  3. If we get 2 in StatusCode, then a Notification failure error message will be sent to the Help Desk as well as the Resp Org. The notification will include the number of attempts as 2nd and include and optional parameter ErrorReason received in the response.

Successful  Sample XML for the ProcessedIncomingChangeRequestNotification Response:

 

<!--PROCESSEDINCOMINGCHANGEREQUESTNOTIFICATION RESPONSE-->

  <ProcessedIncomingChangeRequestNotificationResponse>

    <StatusCode>1</StatusCode>

  </ProcessedIncomingChangeRequestNotificationResponse>

 

Unsuccessful Sample XML for the ProcessedIncomingChangeRequestNotification Response:

 

<!--PROCESSEDINCOMINGCHANGEREQUESTNOTIFICATION RESPONSE-->

  <ProcessedIncomingChangeRequestNotificationResponse>

    <StatusCode>2</StatusCode>

    <ErrorReason>ProcessedIncomingChangeRequestNotification failed to deserialize the response</ErrorReason>

  </ProcessedIncomingChangeRequestNotificationResponse>

 

Operation: ProcessedHelpDeskROCInterventionRequest

This operation will be called to notify the submitting and controlling Resp Orgs when a change is processed to a Resp Org Change Help Desk Intervention request.

If Resp Org Web Service Interface is not available, method will be called again within an hour. No other retries will be made. An email will be sent to the registered email address informing the Resp Org of an issue with the published Web Service.

Request Specification: ProcessedHelpDeskROCInterventionRequest

Sample XML for the ProcessedHelpDeskROCInterventionRequest Request:

 

<!—PROCESSEDHELPDESKROCINTERVENTIONREQUEST REQUEST-->

<ProcessedHelpDeskROCInterventionRequest>

  <RegistrationCode>00B0C917-9810-4504-88E3-BC2F7CD0XXXX</RegistrationCode>

  <TxnID>034FF29D-62F6-4B6E-A516-E90174B9C3EE</TxnID>

  <DialNumberList>

    <DialNumber>

      <Dial>8444354675</Dial>

      <CurrentRespOrg>brweb</CurrentRespOrg>

      <CompanyName><![CDATA[XYZ Company]]></CompanyName>

      <Status>Ported</Status>

    </DialNumber>

    <DialNumber>

      <Dial>8444354676</Dial>

      <CurrentRespOrg>brweb</CurrentRespOrg>

      <CompanyName><![CDATA[XYZ Company]]></CompanyName>

      <Status>Ported</Status>

    </DialNumber>

    <DialNumber>

      <Dial>8444354674</Dial>

      <CurrentRespOrg>ZATST</CurrentRespOrg>

      <CompanyName><![CDATA[ABC Training]]></CompanyName>

      <Status>Declined</Status>

      <RejectReasonList>

        <RejectReason>

          <ReasonCode>01</ReasonCode>

          <ReasonDescription>Invalid date has been selected for this request</ReasonDescription>

        </RejectReason>

        <RejectReason>

          <ReasonCode>02</ReasonCode>

          <ReasonDescription>Old Resp Org does not match Dial Number</ReasonDescription>

        </RejectReason>

      </RejectReasonList>

    </DialNumber>

  </DialNumberList>

  <RejectNote>Rejected</RejectNote>

</ProcessedHelpDeskROCInterventionRequest>

 

Response Specification: ProcessedHelpDeskROCInterventionRequest

In response xml, StatusCode can have following values:

  1. If we get 0 (zero) in StatusCode, it means false or failure of receipt request.
  2. If we get 1 in StatusCode, it means successful calling.
  3. If we get 2 in StatusCode, then a Notification failure error message will be sent to the Help Desk as well as the Resp Org. The notification will include the number of attempt as 2nd and include and optional parameter ErrorReason received in the response.

Successful  Sample XML for the ProcessedHelpDeskROCInterventionRequest Response:

 

<!—PROCESSEDHELPDESKROCINTERVENTIONREQUEST RESPONSE-->

<ProcessedHelpDeskROCInterventionNotificationResponse>

  <StatusCode>1</StatusCode>

 

</ProcessedHelpDeskROCInterventionNotificationResponse>

 

Unsuccessful  Sample XML for the ProcessedHelpDeskROCInterventionRequest Response:

 

<!—PROCESSEDHELPDESKROCINTERVENTIONREQUEST RESPONSE-->

<ProcessedHelpDeskROCInterventionNotificationResponse>

  <StatusCode>2</StatusCode>

  <ErrorReason>ProcessedHelpDeskROCInterventionRequest failed to deserialize the response</ErrorReason>

</ProcessedHelpDeskROCInterventionNotificationResponse>

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

Related articles

Powered by Zendesk