Difference between revisions of "NATS5 REST API Adtool GET adtools"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Adtool GET adtools to NATS5 REST API Adtool GET adtools: Renaming NATS5 API pages) |
|||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
== '''GET /adtool/adtools''' == | == '''GET /adtool/adtools''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get list of adtools | * Get list of adtools | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 37: | Line 38: | ||
** optional | ** optional | ||
* '''sort_direction1''' | * '''sort_direction1''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''sort_field2''' | * '''sort_field2''' | ||
| Line 43: | Line 44: | ||
** optional | ** optional | ||
* '''sort_direction2''' | * '''sort_direction2''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''deleted''' | * '''deleted''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''groupid''' | * '''groupid''' | ||
| Line 67: | Line 68: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/adtool/adtools</nowiki><br/> | URL: <nowiki>http://domain/api/adtool/adtools</nowiki><br/> | ||
| − | Query String: <nowiki>adtool_type_id=2</nowiki><br/> | + | Query String: <nowiki>adtool_type_id=2&adtoolid=1&deleted=1</nowiki><br/> |
Response: | Response: | ||
| Line 113: | Line 114: | ||
$data = Array( | $data = Array( | ||
'adtool_type_id' => 2, | 'adtool_type_id' => 2, | ||
| + | 'adtoolid' => 1, | ||
| + | 'deleted' => 1, | ||
); | ); | ||
| Line 154: | Line 157: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_adtool_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Revision as of 15:42, 9 August 2019
GET /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);
?>
