Difference between revisions of "NATS5 REST API Service GET rule-condition-data"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Service GET rule-condition-data to NATS5 REST API Service GET rule-condition-data: Renaming NATS5 API pages) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_service_section = true |
}} | }} | ||
== '''GET /service/rule-condition-data''' == | == '''GET /service/rule-condition-data''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get the info for rule conditions | * Get the info for rule conditions | ||
| 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 31: | Line 32: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/service/rule-condition-data</nowiki><br/> | URL: <nowiki>http://domain/api/service/rule-condition-data</nowiki><br/> | ||
| − | Query String: <nowiki>type=adtool</nowiki><br/> | + | Query String: <nowiki>type=adtool&siteid=1</nowiki><br/> |
Response: | Response: | ||
| Line 39: | Line 40: | ||
"condition_data": { | "condition_data": { | ||
"program": [ | "program": [ | ||
| + | { | ||
| + | "id": 3, | ||
| + | "name": "account rep (Disabled)" | ||
| + | }, | ||
{ | { | ||
"id": 2, | "id": 2, | ||
| − | "name": " | + | "name": "updated program name" |
}, | }, | ||
{ | { | ||
| Line 81: | Line 86: | ||
$data = Array( | $data = Array( | ||
'type' => 'adtool', | 'type' => 'adtool', | ||
| + | 'siteid' => 1, | ||
); | ); | ||
| Line 122: | Line 128: | ||
</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 --> | [[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-condition-data
Description
- Get the info for rule conditions
Resource URL
- http://domain/api/service/rule-condition-data
- 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
- siteid
- type: digit
- optional
Example Request
Method: GET
URL: http://domain/api/service/rule-condition-data
Query String: type=adtool&siteid=1
Response:
{
"success": true,
"condition_data": {
"program": [
{
"id": 3,
"name": "account rep (Disabled)"
},
{
"id": 2,
"name": "updated program name"
},
{
"id": -1,
"name": "Type-In Traffic"
}
],
"site": [
{
"id": 1,
"name": "Membership Site A"
}
],
"tour": [
{
"id": 1,
"name": "(member_a) 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(
'type' => 'adtool',
'siteid' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/service/rule-condition-data',
'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);
?>
