This section provides details on the fields in the various requests sent to the ROC Notification Subscriber Web Service.
Request Fields: NewIncomingChangeRequestNotification
Request Field List - NewIncomingChangeRequestNotification | |||||
|---|---|---|---|---|---|
Ref# | Name | Comments | Data Type | Required | Validation |
| 1 | Registration Code | The Registration code issued to the Resp Org. | String | Mandatory | Must be a valid string |
| 2 | TxnID | The Transaction ID of the new incoming Resp Org Change request. | String | Mandatory | Must be a valid string |
| 3 | SubmittingRespOrg | Submitting Resp org of request. | String | Mandatory | Must be a valid string |
| 4 | SubmitterName | Name of Submitting Resp Org. | String | Mandatory | Must be a valid string |
| 5 | SubmitterPhone | Phone of Submitting Resp Org. | String | Mandatory | Must be a valid string |
| 6 | SubmitterEmail | Email of Submitting Resp Org. | String | Mandatory | Must be a valid string |
| 7 | SubmitterCompanyName | Submitting Resp org Company Name. | String | Mandatory | Must be a valid string |
| 8 | SubmissionDateTime | Date when request is submitted. | DateTime | Mandatory | Must be in the format: (YYYY-MM-DDTHH:MM:SS) Example: 2016-12-01T00:00:00 |
| 9 | NewRespOrgID | New Resp Org of request. | String | Mandatory | Must be a valid string |
| 10 | ControllingRespOrg | Controlling Resp org of Dial numbers. | String | Mandatory | Must be a valid string |
| 11 | DueDateTime | Date when the request is due. | DateTime | Mandatory | Must be in the format: (YYYY-MM-DDTHH:MM:SS) Example: 2016-12-01T00:00:00 |
| 12 | LOAID | ID of submitted Letter of Agency (LOA). | String | Optional | |
| 13 | LOAFileName | Name of submitted LOA. | String | Optional | |
| 14 | ExpediteROC | Expedite Resp Org Change | String | Optional | |
| 15 | DialNumberList | A list of Dial numbers. | DialNumberList | Mandatory | It should be in the following format: <DialNumberList> <Dial>8002223333</Dial> <Dial>8002224444</Dial> </DialNumberList> |
| 16 | DocumentList | A list of additional documents. | DocumentList | Optional | It should be in the following format: <Document> <DocumentID>34</DocumentID> <FileTitle>34.PDF</FileTitle><FileNotes/> </Document> |
Request Fields: ProcessedOutgoingChangeRequestNotification
Request Field List - ProcessedOutgoingChangeRequestNotification | |||||
|---|---|---|---|---|---|
Ref# | Name | Comments | Data Type | Required | Validation |
| 1 | Registration Code | The Registration code issued to the Resp Org. | String | Mandatory |
Must be a valid string |
| 2 | TxnID | The Transaction ID of the Processed outgoing Resp Org Change request. | String | Mandatory |
Must be a valid string |
| 3 | DialNumberList | A list of Dial numbers and their controlling Resp Orgs. | DialNumberList | Optional | It should be in the following format: <DialNumber> <Dial>855-2725-012</Dial> <CurrentRespOrgID>ABC01</CurrentRespOrgID> <CompanyName>ABC Tel</CompanyName> <Status>Declined </Status> <ProcessedDateTime>2018-07-10T12:30:23.51</ProcessedDateTime> <RejectReasonList> </DialNumber> At least one DialNumber is required. |
| 4 | LOAID | ID of submitted LOA. | String | Optional | |
| 5 | LOAFileName | Name of submitted LOA. | String | Optional |
|
| 6 | DocumentList | A list of additional documents. | DocumentList | Optional | It should be in the following format: <Document> <DocumentID>34</DocumentID> <FileTitle>34.PDF</FileTitle><FileNotes/> </Document> |
| 7 | Notes | Notes related to request | String | Optional | |
Request Fields: PushedToRespOrgs
Request Field List - PushedToRespOrgs | |||||
|---|---|---|---|---|---|
Ref# | Name | Comments | Data Type | Required | Validation |
| 1 | Registration Code | The Registration code issued to the Resp Org. | String | Mandatory |
Must be a valid string |
| 2 | TxnID | The Transaction ID of the Processed Outgoing Resp Org Change request. | String | Mandatory |
Must be a valid string
|
| 3 | DialNumberDetailList | A list of Dial numbers and their controlling Resp Orgs. | DialNumberList | Mandatory | It should be in the following format: <DialNumber> <Dial>855-2725-012</Dial> <CurrentRespOrgID>ABC01</CurrentRespOrgID> <CompanyName>ABC Tel</CompanyName> </DialNumber> At least one Dial number is required. |
Request Fields: ProcessedIncomingChangeRequestNotification
Request Field List - ProcessedIncomingChangeRequestNotification | |||||
|---|---|---|---|---|---|
Ref# | Name | Comments | Data Type | Required | Validation |
| 1 | Registration Code | The Registration code issued to the Resp Org. | String | Mandatory |
Must be a valid string |
| 2 | TxnID | The Transaction ID of the Processed outgoing Resp Org Change request. | String | Mandatory |
Must be a valid string |
| 3 | DialNumberList | A list of Dial numbers and their controlling Resp Orgs. | DialNumberList | Optional | It should be in the following format: <DialNumber> <Dial>855-2725-012</Dial> <CurrentRespOrgID>ABC01</CurrentRespOrgID> <CompanyName>ABC Tel</CompanyName> <Status>Declined </Status><ProcessedDateTime>2018-07-10T12:30:23.51</ProcessedDateTime> <RejectReasonList> </DialNumber> At least one Dial number is required. |
| 4 | LOAID | ID of submitted LOA. | String | Optional | |
| 5 | LOAFileName | Name of submitted LOA. | String | Optional | |
| 6 | DocumentList | A list of additional documents. | DocumentList | Optional | It should be in the following format: <Document> <DocumentID>34</DocumentID> <FileTitle>34.PDF</FileTitle><FileNotes/> </Document> |
| 7 | Notes | Notes related to request | String | Optional | |
Request Fields: ProcessedHelpDeskROCInterventionRequest
Request Field List - ProcessedHelpDeskROCInterventionRequest | |||||
|---|---|---|---|---|---|
Ref# | Name | Comments | Data Type | Required | Validation |
| 1 | Registration Code | The Registration code issued to the Resp Org. | String | Mandatory |
Must be a valid string |
| 2 | TxnID | The Transaction ID of the Processed Help Desk Resp Org Change request. | String | Mandatory |
Must be a valid string
|
| 3 | DialNumberDetailList | A list of Dial numbers and their controlling Resp Orgs. | DialNumberList | Mandatory | It should be in the following format: <DialNumber> <Dial>855-2725-012</Dial> <CurrentRespOrgID>ABC01</CurrentRespOrgID> <CompanyName>ABC Tel</CompanyName> <Status>Ported</Status> </DialNumber> At least one Dial number is required. |
| 4 | RejectNote | Reject notes related to request | String | Optional | |
Response Fields
Response Fields List | |||||
|---|---|---|---|---|---|
Ref# | Name | Comments | Data Type | Required | Expected Value |
| 1 | StatusCode | The Transaction Status at the Resp Org end. | String | Mandatory | 0, 1 or 2 |
| 2 | ErrorReason | The exception occurred at the Resp Org end while processing this Transaction in their system. | String | Optional | Must be a valid string up to 500 commonly used characters. |