Difference between revisions of "NATS5 REST API Adtool GET groups"
From TMM Wiki
Jump to navigationJump to search| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_adtool_section = true |
}} | }} | ||
== '''GET /adtool/groups''' == | == '''GET /adtool/groups''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get groups of adtools | * Get groups 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 36: | Line 37: | ||
{ | { | ||
"adtool_group_id": "1000", | "adtool_group_id": "1000", | ||
| − | "name": " | + | "name": "testGroup", |
"parentid": "0", | "parentid": "0", | ||
"enabled": "0" | "enabled": "0" | ||
| Line 52: | Line 53: | ||
{ | { | ||
"adtool_group_id": "1000", | "adtool_group_id": "1000", | ||
| − | "name": " | + | "name": "testGroup", |
"parentid": "0", | "parentid": "0", | ||
"enabled": "0", | "enabled": "0", | ||
| Line 120: | Line 121: | ||
</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 --> | ||
Latest revision as of 15:57, 9 August 2019
GET /adtool/groups
Description
- Get groups of adtools
Resource URL
- http://domain/api/adtool/groups
- 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
Example Request
Method: GET
URL: http://domain/api/adtool/groups
Query String: adtoolid=1
Response:
{
"groups": [
{
"adtool_group_id": "1000",
"name": "testGroup",
"parentid": "0",
"enabled": "0"
}
],
"parents": [
{
"adtool_group_id": 0,
"children": [
"1000"
]
}
],
"hierarchy": [
{
"adtool_group_id": "1000",
"name": "testGroup",
"parentid": "0",
"enabled": "0",
"children": false
}
],
"success": true
}
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(
'adtoolid' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/adtool/groups',
'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);
?>
