NATS5 REST API Include GET includes
From TMM Wiki
Jump to navigationJump to searchGET /include/includes
Description
- Get a list of include chains
Resource URL
- http://domain/api/include/includes
- 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
- template
- type: string
- optional
- track
- type: trinary_digit (0, 1, or 2)
- optional
- enabled
- type: trinary_digit (0, 1, or 2)
- optional
Example Request
Method: GET
URL: http://domain/api/include/includes
Query String: deleted=1&template=chaininclude_popup&track=1&enabled=1
Response:
{
"success": true,
"chains": [
{
"include_chain_id": "1",
"name": "test include name",
"switch": "4",
"template": "chaininclude_popup",
"track": "1",
"deleted": "0",
"enabled": "1",
"switch_details": {
"siteid": {
"siteid": "1",
"name": "Membership Site A"
},
"tourid": {
"tourid": "1",
"name": "Default Tour"
}
}
}
]
}
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,
'template' => 'chaininclude_popup',
'track' => 1,
'enabled' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/include/includes',
'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);
?>
