Bulk TFN Query
The Bulk TFN API can be used to retrieve the TFN status, and other information for a list of TFNs. Currently up to 1,000 tfns in an array are allowed. The following is an example REST/JSON query request to get the details of a list of TFNs:
POST /api/v2/tss-bulk-tfn-query HTTP/1.0
Content-Type: application/json
Content-Length: <num>
{
"id":"user",
"pwd":"password",
"tfns":[ // an array of tfns to query
"8005001212",
"8005001213",
"8335001215
]
}
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-bulk-tfn-query", // positive confirmation
"tfnDetails":[ // an array of tfn details
{
"tfn":"8005551212", // positive confirmation
"status":"<seeTableBelow>", // see table below
"roName":"Resp Org Name", // OPTIONAL, see below
"routingTspid":"12345", // OPTIONAL, see below
"ownerTspid":"12345", // OPTIONAL, see below
"ownerSrName":"Owner SR Name", // OPTIONAL, see below
"routingSrName":"Routing SR Name" // OPTIONAL, see below
},
{
"tfn":"8005001213", // positive confirmation
"status":"<seeTableBelow>", // see table below
"roName":" Resp Org Name ", // OPTIONAL, see below
"routingTspid":"12345", // OPTIONAL, see below
"ownerTspid":"12345", // OPTIONAL, see below
"ownerSrName":"Owner SR Name", // OPTIONAL, see below
"routingSrName":"Routing SR Name" // OPTIONAL, see below
},
{
"tfn":"8335001215", // positive confirmation
"status":"<seeTableBelow>", // see table below
"roName":" Resp Org Name ", // OPTIONAL, see below
"routingTspid":"12345", // OPTIONAL, see below
"ownerTspid":"12345", // OPTIONAL, see below
"ownerSrName":"Owner SR Name", // OPTIONAL, see below
"routingSrName":"Routing SR Name" // OPTIONAL, see below
}
]
}
Failure responses are discussed in the Error section.
The following table enumerates the possible values for the status field on a successful request.