Text Enabled TFN Inventory
The following is an example REST/JSON text enabled inventory request from the user:
POST /api/v2/tss-text-ro-inventory-tfn HTTP/1.0
Content-Type: application/json
Content-Length: <num>
{
"id":"user",
"pwd":"password",
"ror":"RespOrgID" // issue this post again for each ROR desired
"partialTfn":"8" // a single “8” means all 8xxXxxXxxx TFNs
}
This request asks the TSS to return a list of TFNs where each TFN is either in the Pending or Enabled
state for the given ror. The user can provide more digits in the partialTfn to narrow the request -- such as
“800555” would provide all enabled and pending TFNs with the pattern “800555xxxx” associated with the
ror.If the id does not have permissions for the given ror, then a failure results. The maximum size in the
response is 10,000 TFNs. Therefore, if the partialTfn results in more than the maximum, then an error
response results and the user must narrow the partialTfn in the request by providing more digits in the
partialTfn.
The response list is ordered, ascending, by TFN. A response similar to the following is issued by TSS to
the user on success:
// The HTTP header is omitted for brevity. The JSON portion follows:
{
"url": "/api/v2/tss-text-ro-inventory-tfn",// positive confirmation
"responses":[ // an array of responses
{ // the first response
"tfn":"8005001212",
"status":"Pending", // see status table below
"ownerTspid":"12345",
"date":"04/21/2015 18:03:56 GMT", // GMT, the only timezone
"businessName":"Subscriber Business Name"
}, // the end of the first response
{ // start of the second response
"tfn":"8005001213",
"status":"Enabled", // see status table below
"ownerTspid":"12345",
"date":"04/09/2015 07:49:06 GMT", // GMT, the only timezone
"businessName":"Subscriber Business Name"
} // end of the second response
]
}
Failure responses are discussed in the Error section.