NATS5 REST API Biller GET cascade-list
From TMM Wiki
Jump to navigationJump to searchGET /biller/cascade-list
Description
- Get a cascade list
Resource URL
- http://domain/api/biller/cascade-list
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- deleted
- type: trinary_digit (0, 1, or 2)
- optional
- billerid
- type: digit
- optional
- siteid
- type: digit
- optional
- match-cascadeid
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/biller/cascade-list
Query String: deleted=1&siteid=0
Response:
{
"success": true,
"total_count": 2,
"cascades": [
{
"cascadeid": "1",
"networkid": "0",
"name": "default",
"description": "Join by Credit Card",
"weight": "50",
"deleted": "0",
"target": "",
"nontarget": "",
"active": "0",
"target_list": [
""
],
"nontarget_list": [
""
],
"type": "Standard"
},
{
"cascadeid": "2",
"networkid": "0",
"name": "testName",
"description": "test biller cascade description",
"weight": "50",
"deleted": "0",
"target": "",
"nontarget": "",
"active": "0",
"target_list": [
""
],
"nontarget_list": [
""
],
"type": "Standard"
}
]
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'deleted' => 1,
'siteid' => 0,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/cascade-list',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
