NATS5 REST API Adtool GET adtools
From TMM Wiki
Jump to navigationJump to searchGET /adtool/adtools
Description
- Get list of adtools
Resource URL
- http://domain/api/adtool/adtools
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- adtoolid
- type: digit
- optional
- adtool_type_id
- type: digit
- required
- start
- type: digit
- optional
- count
- type: digit
- optional (default value: 20)
- sort_field1
- type: string
- optional
- sort_direction1
- type: boolean_digit (0 or 1)
- optional
- sort_field2
- type: string
- optional
- sort_direction2
- type: boolean_digit (0 or 1)
- optional
- deleted
- type: boolean_digit (0 or 1)
- optional
- groupid
- type: digit
- optional
- loginid
- type: digit
- optional
- siteid
- type: digit
- optional
- tourid
- type: digit
- optional
- programid
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/adtool/adtools
Query String: adtool_type_id=2&adtoolid=1&deleted=1
Response:
{
"success": true,
"total_count": 1,
"adtools": [
{
"adtoolid": "1",
"networkid": "0",
"name": "test FHG",
"url": "http:\/\/www.google.com",
"type": "1",
"items": "5",
"description": "test",
"thumbnail": "",
"thumb_ext": "",
"deleted": "0",
"model": "",
"published_date": "1555646400",
"ids": [],
"var_divide": "?",
"published_date_nice": "2019-04-19 00:00:00"
}
]
}
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(
'adtool_type_id' => 2,
'adtoolid' => 1,
'deleted' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/adtool/adtools',
'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);
?>
