New Incoming Change Request Notification
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 Toll-Free Number (TFN) related to Controlling Resp Org.
End Point Uniform Resource Identifier (URI)
/v1/ext/nicr
JSON Format
JSON API for request
{
"txnID": "",
"submittingRespOrg": "",
"submitterName": "",
"submitterPhone": "",
"submitterEmail": "",
"submitterCompanyName": "",
"newRespOrgID": "",
"controllingRespOrg": "",
"submissionDateTime": "",
"dueDateTime": "",
"loaid": "",
"loaFileName": "",
"expediteROC": "", "numList": [ request array ""
],
"documentList":[ request array
{
"fileTitle": "",
"fileNotes": "",
"documentID": ""
}
]
}
Response message
{
"status": ""
}
Parameter Description
txnID | The Transaction ID of the "New Incoming Change Request Notification." |
submittingRespOrg | Submitting RespOrg Id 5 alphanumeric characters |
submitterName | Submitter username |
submitterPhone | Submitter phone number |
submitterEmail | Submitter email id |
submitterCompanyName | Submitter company name |
newRespOrgID | New RespOrg Id 5 alphanumeric characters |
controllingRespOrg | Control RespOrg Id 5 alphanumeric characters |
submissionDateTime | Submission Date time YYYY-MM-DDTHH:MMZ |
dueDateTime | Due Date time YYYY-MM-DDTHH:MMZ |
loaid | Loa id |
loaFileName | Loa pdf file name |
expediteROC | Expedite ROC |
numList | Array of tfn |
documentList | List of { "fileTitle": "", "fileNotes": "", "documentID": "" } |
status | 0,1,2 |
Processed Outgoing Change Request Notification
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 TFN since processing can occur in batches.
End point URI
/v1/ext/pocr
JSON Format
JSON API for request
{
"txnID": "",
" notes ": "",
" loaid ": "",
" loaFileName ": "",
"numList": [ {
"currentRespOrg": "",
"companyName ": "",
"status": "",
"rejectNote": "",
"processedDatetime": "",
"rejectReasonList ": [
"reasonCode": "",
"reasonDescription":""
]
}],
"documentList":[ request array
{
"fileTitle": "",
"fileNotes": "",
"documentID": ""
}
]
}
Response message
{
"status": ""
}
Parameter Description
txnID | The Transaction ID of the "Processed Outgoing Change Request Notification." |
notes | Descriptive information |
loaid | Loa id |
loaFileName | Loa pdf file name |
numList | List of { "currentRespOrg": "", "companyName": "", "status": "", "rejectNote": "", "processedDatetime": "", "rejectReasonList ": [ "reasonCode": "", "reasonDescription":"" ] } Where Description of: CurrentRespOrg: The Current Resp Org. CompanyName:Name of the company. RejectNote: Reject Node. ProcessedDatetime: Processed Date Time. ReasonCode: Reason code ReasonDescription: Description of the reason. |
documentList | List of { "fileTitle": "", "fileNotes": "", "documentID": "" } |
Status | 0,1,2 |
Pushed To Resp Orgs
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.
End point URI
/v1/ext/ptr
JSON Format
JSON API for request
{
"txnID": "",
"numList": [ {
"num": "",
"currentRespOrg": "",
"companyName ": "",
} ]
}
Response message
{
"status": ""
}
Parameter Description
txnID | The Transaction ID of the "Pushed To Resp Orgs." |
numList | List of { "num": "", "currentRespOrg": "", "companyName": "" } Where Description of: Num: Num Value. CurrentRespOrg: The Current Resp Org. CompanyName:Name of the company. |
status | 0,1,2 |
Processed Incoming Change Request Notification
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 TFN since processing can occur in batches.
End point URI
/v1/ext/picr
JSON Format
JSON API for request
{
"txnID": "",
" notes ": "",
" loaid ": "",
" loaFileName ": "",
"numList": [
"currentRespOrg": "",
"companyName ": "",
"status": "",
"rejectNote": "",
"processedDatetime": "",
"rejectReasonList ": [
"reasonCode": "",
"reasonDescription":""
]
],
"documentList":[ request array
{
"fileTitle": "",
"fileNotes": "",
"documentID": ""
}
]
}
Response message
{
"status": ""
}
Parameter Description
txnID |
The Transaction ID of the "Processed Incoming Change Request Notification." |
notes | Descriptive information |
loaid | Loa id |
loaFileName | Loa pdf file name |
numList | List of { "currentRespOrg": "", "companyName": "", "status": "", "rejectNote": "", "processedDatetime": "", "rejectReasonList ": [ "reasonCode": "", "reasonDescription":"" ] } Where Description of: CurrentRespOrg: The Current Resp Org. CompanyName:Name of the company. RejectNote: Reject Node. ProcessedDatetime: Processed Date Time. ReasonCode: Reason code ReasonDescription: Description of the reason. |
documentList | List of { "fileTitle": "", "fileNotes": "", "documentID": "" } |
status | 0,1,2 |
Processed Help Desk ROC Intervention Request
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.
End point URI
/v1/ext/phdr
JSON Format
JSON API for request
{
"txnID": "",
" rejectNote ": "",
"numList": [
"currentRespOrg": "",
"companyName ": "",
"status": "",
"rejectNote": "",
"processedDatetime": "",
"rejectReasonList ": [
"reasonCode": "",
"reasonDescription":""
]
],
Response message
{
"status": ""
}
Parameter Description
txnID | The Transaction ID of the "Processed Help Desk ROC Intervention Request." |
rejectNote | Reject Note |
numList | List of { "currentRespOrg": "", "companyName": "" "status": "", "rejectNote": "", "processedDatetime": "", "rejectReasonList ": [ "reasonCode": "", "reasonDescription":"" ] } Where Description of: CurrentRespOrg: The Current Resp Org. CompanyName:Name of the company. RejectNote: Reject Node. ProcessedDatetime: Processed Date Time. ReasonCode: Reason code ReasonDescription: Description of the reason. |
documentList | List of { "fileTitle": "", "fileNotes": "", "documentID": "" } |
status | 0,1,2 |