Difference between revisions of "NATS5 REST API Service GET rule-info"
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_service_section = true |
}} | }} | ||
== '''GET /service/rule-info''' == | == '''GET /service/rule-info''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get the info for building rules | * Get the info for building rules | ||
| 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 25: | Line 26: | ||
** required | ** required | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/service/rule-info</nowiki><br/> | ||
| + | Query String: <nowiki>type=adtool</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "ruleinfo": { | ||
| + | "title": "Adtool", | ||
| + | "key_field": "adtoolid", | ||
| + | "page": "admin_adtools.php", | ||
| + | "page_view": "edit_rule", | ||
| + | "add_action": "add_rule", | ||
| + | "edit_action": "edit_rule", | ||
| + | "disable_action": "disable_rule", | ||
| + | "submit_array": "adtool", | ||
| + | "api": { | ||
| + | "list": "adtool_api\/adtool-rules", | ||
| + | "item": "adtool_api\/adtool-rule", | ||
| + | "add": "adtool_api\/adtool-rule", | ||
| + | "edit": "adtool_api\/adtool-rule", | ||
| + | "delete": "adtool_api\/adtool-rule" | ||
| + | }, | ||
| + | "return_array": "adtool_rules", | ||
| + | "return_item": "adtool_rule", | ||
| + | "table": "adtool_rule", | ||
| + | "sql_field": "adtoolid", | ||
| + | "sql_id": "adtool_rule_id", | ||
| + | "simple_fields": [ | ||
| + | "login", | ||
| + | "program", | ||
| + | "site" | ||
| + | ], | ||
| + | "fields": [ | ||
| + | "login", | ||
| + | "program", | ||
| + | "site", | ||
| + | "tour" | ||
| + | ], | ||
| + | "rule_types": [ | ||
| + | { | ||
| + | "value": 0, | ||
| + | "name": "IGNORE" | ||
| + | }, | ||
| + | { | ||
| + | "value": 1, | ||
| + | "name": "SHOW" | ||
| + | }, | ||
| + | { | ||
| + | "value": 2, | ||
| + | "name": "HIDE" | ||
| + | } | ||
| + | ], | ||
| + | "field_info": { | ||
| + | "login": { | ||
| + | "description": "Affiliates" | ||
| + | }, | ||
| + | "program": { | ||
| + | "description": "Programs" | ||
| + | }, | ||
| + | "site": { | ||
| + | "description": "Sites" | ||
| + | }, | ||
| + | "tour": { | ||
| + | "description": "Tours" | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 38: | Line 114: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'type' => 'adtool', | |
); | ); | ||
| Line 81: | Line 157: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_service_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 16:01, 9 August 2019
GET /service/rule-info
Description
- Get the info for building rules
Resource URL
- http://domain/api/service/rule-info
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- type
- type: string
- required
Example Request
Method: GET
URL: http://domain/api/service/rule-info
Query String: type=adtool
Response:
{
"success": true,
"ruleinfo": {
"title": "Adtool",
"key_field": "adtoolid",
"page": "admin_adtools.php",
"page_view": "edit_rule",
"add_action": "add_rule",
"edit_action": "edit_rule",
"disable_action": "disable_rule",
"submit_array": "adtool",
"api": {
"list": "adtool_api\/adtool-rules",
"item": "adtool_api\/adtool-rule",
"add": "adtool_api\/adtool-rule",
"edit": "adtool_api\/adtool-rule",
"delete": "adtool_api\/adtool-rule"
},
"return_array": "adtool_rules",
"return_item": "adtool_rule",
"table": "adtool_rule",
"sql_field": "adtoolid",
"sql_id": "adtool_rule_id",
"simple_fields": [
"login",
"program",
"site"
],
"fields": [
"login",
"program",
"site",
"tour"
],
"rule_types": [
{
"value": 0,
"name": "IGNORE"
},
{
"value": 1,
"name": "SHOW"
},
{
"value": 2,
"name": "HIDE"
}
],
"field_info": {
"login": {
"description": "Affiliates"
},
"program": {
"description": "Programs"
},
"site": {
"description": "Sites"
},
"tour": {
"description": "Tours"
}
}
}
}
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(
'type' => 'adtool',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/service/rule-info',
'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);
?>
