NATS4 REST API Get Option Rule
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
GET /option/rule
Description
- NATS4 supports an API resource to get option rules and their associatied info
Resource URL
- http://domain/api/option/rule
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Paremeters can be sent as url encoded params.
- optionid: The option id
- type: integer
- required
- rule_type: ("SHOW", "HIDE", "ALL" or "" (empty string). "" will display both "SHOW" and "HIDE" rules.)
- type: string
- optional
Example Request
GET
http://domain/api/option/rule
- Response:
{ "result": "TRUE", "params": { "13": { "option_rule_id": "13", "optionid": "0", "rule_type": "SHOW", "identid": "4", "start_time": "2006-06-06 00:00:00", "end_time": "2006-06-06 00:00:00", "cascadeid": "0", "override_identifier_id": "4", "loginid": "0", "networkid": "0", "programid": "0", "siteid": "0", "tourid": "0", "adtoolid": "0", "subid1": "0", "subid2": "0", "billerid": "0", "countryid": "0", "promotionalid": "0" }, "16": { "option_rule_id": "16", "optionid": "0", "rule_type": "SHOW", "identid": "4", "start_time": "2014-06-12 15:27:42", "end_time": "0000-00-00", "cascadeid": "0", "override_identifier_id": "4", "loginid": "0", "networkid": "0", "programid": "0", "siteid": "0", "tourid": "0", "adtoolid": "0", "subid1": "0", "subid2": "0", "billerid": "0", "countryid": "0", "promotionalid": "0" }, "23": { "option_rule_id": "23", "optionid": "0", "rule_type": "SHOW", "identid": "4", "start_time": "2006-06-06 00:00:00", "end_time": "2014-12-31 02:26:16", "cascadeid": "0", "override_identifier_id": "4", "loginid": "0", "networkid": "0", "programid": "0", "siteid": "0", "tourid": "0", "adtoolid": "0", "subid1": "0", "subid2": "0", "billerid": "0", "countryid": "0", "promotionalid": "0" } } }
Example Code
PHP
<?php $curl = curl_init(); $data = array( 'optionid' => '1', 'rule_type' => 'SHOW' ); $data_string = http_build_query($data); $url = 'http://domain/api/option/rule?'.$data_string; $headers = array( 'api-key: 44b5498dbcb481a0d00b404c0169af62', 'api-username: tmm1phrvezsbu' ); curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_URL, $url); $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); ?>
Python
- This example requires pip and the request library which can be installed via pip by: 'pip install requests'
import requests url = 'http://domain/api/option/rule' params = { 'optionid': 1, 'rule_type': 'SHOW' } headers = { 'api-key': '44b5498dbcb481a0d00b404c0169af62', 'api-username': 'tmm1phrvezsbu' } res = requests.get(url, params=params, headers=headers) print res.json()
node.js
- This example requires npm and the request module which can be installed via npm by: 'npm install request'
var request = require('request'); var options = { url: 'http://domain/api/option/rule', method: 'GET', qs: { 'optionid': 1, 'rule_type': 'SHOW' }, json: true, headers: { 'api-key': '44b5498dbcb481a0d00b404c0169af62', 'api-username': 'tmm1phrvezsbu' } }; function callback(error, response, body) { if (!error && response.statusCode == 200) { console.log(body); } else{ console.log(body); } } request(options, callback);
Curl
curl -X GET 'http://domain/api/option/rule?optionid=1&rule_type=SHOW' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu"