Bulk API to approve/reject port pending requests
The API processes a set of actions for approve and reject port-pending requests by the current owner
service registrar. This is a bulk API. Currently up to 1,000 requests in an array are allowed.
The following is an example REST/JSON update request from the user:
POST /api/v2/set-sr-pending-tfns HTTP/1.0
Content-Type: application/json
Content-Length: <num>
{
"id":"user",
"pwd":"password",
"requests":[ // an array of requests to process
{ // the start of the first request
"tfn":"8005551212",
"action":"approve"
}, // the end of the first request
{ // the start of the second request
"action":"reject",
"tfn":"8005001213"
}, // the end of the second request
{ // the start of the third request
"action":"approve",
"tfn":"8005001214"
} // the end of the third request
] // the end of the request array
}
Response:
// The HTTP header is omitted for brevity. The JSON portion follows:
{
"url":"/api/v2/set-sr-pending-tfns", // positive confirmation for
//debugging
"totalTfnCountInRequest":3, // total number of tfns in the request
"successResponse":{ // success response
"successCount":2, // total number of successful tfn updates
"responses":[ // an array of success responses to the requests
{"tfn":"8005551212","action":"<SeeActionTableBelow>"},
// first success response
{"tfn":"8005551213","action":"<SeeActionTableBelow>"}
// second success response
] // the end of the success responses array
} // the end of success response
"failureResponse":{ // failed response
"failureCount":1, // total number of failed tfn updates
"responses":[ // an array of failed responses to the requests
{"tfn":"8005551214","action":"<SeeActionTableBelow>","errorMessag
e":"<SeeErrorMessageTableBelow>"}
// first error response
] // the end of the failed responses array
} // the end of failure response
}
The tables above enumerate the possible results of approve and reject requests as well as the error
messages as a result of failed TFN approve/reject requests. If an error occurs that prevents the TSS from completing the request (such as authentication failure or bad request), then the above response is not returned and instead a failure response, as discussed in the Error section, is returned.