Difference between revisions of "NATS5 REST API Biller GET cascade-rules"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Biller GET cascade-rules to NATS5 REST API Biller GET cascade-rules: Renaming NATS5 API pages) |
|
(No difference)
| |
Revision as of 15:17, 9 August 2019
GET /biller/cascade-rules
Description
Resource URL
- http://domain/api/biller/cascade-rules
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- cascadeid
- type: digit
- required
- rule_types
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional (default value: Array)
- login
- optional
- program
- optional
- site
- optional
- tour
- optional
- text_search
- optional
Example Request
Method: GET
URL: http://domain/api/biller/cascade-rules
Query String: cascadeid=1
Response:
{
"success": true,
"cascade_rules": [
{
"cascadeid": "1",
"rule_type": "1",
"identid": "1",
"start_time": "1533153286",
"end_time": "0",
"start_nice": "2018-08-01 15:54:46",
"end_nice": "FOREVER",
"rule_status": 1,
"advanced": 1,
"override_identifier_id": [
"1"
],
"ruleid": "1533153286:0:1",
"rule_type_nice": "ENABLE",
"login": [
{
"id": 0,
"name": "ALL"
}
],
"program": [
{
"id": 0,
"name": "ALL"
}
],
"site": [
{
"id": 0,
"name": "ALL"
}
],
"tour": [
{
"id": 0,
"name": "ALL"
}
]
}
]
}
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(
'cascadeid' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/cascade-rules',
'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);
?>
