IBC Disposition Codes Documentation
This service can be used to review or integrate the latest available copy of the IBC disposition codes.
The service responds to JSON and JSONP GET requests to the following URL:
https://api.pactrak.com/v1/res/dispositioncodes
To obtain the details for a single disposition code:
https://api.pactrak.com/v1/res/dispositioncodes/XX
XX should be the two letter disposition code requested.
The following parameters can be amended to the URL to modify the responses:
- format - Choose between 'csv', 'json' to return the content directly in the format specified.
Note: this will only respond with the content object, not the default JSON response.
For CSV responses the the headers 'code,description_en,description_es' are included in the response.
- lang - Choose between 'en' or 'es' to select the description in either English or Spanish.
- order - Choose between 'asc' or 'desc' to order the disposition code in Ascending or Descending alphabetical order.
- callback - JSONP responses will result when the callback parameter is given.
Default response JSON structure
{
/**
* The HTTP response code.
* @type Integer.
*/
"code": 200,
/**
* Response message relevant to the action requested.
* @type String.
*/
"message":"",
/**
* Response message for the developer relevant to the errors received.
* @type String.
*/
"developerMessage":"",
/**
* A link to the resource.
* @type String.
*/
"href":"https://api.pactrak.com/res",
/**
* The content object could be a simple JSON object or an array JSON Object with the results of the request.
* If a 'format=json' parameter is issued this object will be returned directly.
* @type JSON Object or JSON Array.
*/
"content":{}
}
The content object will have either be an array labeled 'list' or a single JSON object (depending on the request) with the following format:
{
/**
* The two letter IBC Disposition code.
* @type String.
*/
"code": "XX",
/**
* The description in English.
* @type String.
*/
"description_en": "Simple Test",
/**
* The description in Spanish.
* @type String.
*/
"description_es": "Prueba Simple"
}