NATS4 REST API Get Option Rule
From TMM Wiki
Revision as of 23:12, 12 March 2015 by Tmmtobias0185 (talk | contribs) (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /option/getrule''' == '''Description''' *NATS4 supports an API resource to get option rules and their associat...")
GET /option/getrule
Description
- NATS4 supports an API resource to get option rules and their associatied info
Resource URL
- http://domain/api/v1/option/getrule
- 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: The rule type. Can be 'SHOW', 'HIDE', or 'ALL'
- type: string
- optional
Periods
| # | Name | Argument Description |
|---|---|---|
| 0 | current | Current Period |
| 1 | last | Last Period |
| 2 | today | Today |
| 3 | yesterday | Yesterday |
| 4 | week | This Week |
| 5 | month | This Month |
| 6 | year | This Year |
| 7 | all | All Time |
| 8 | free | Freeform (See also the start and end parameters above) |
Example Request
GET
http://domain/api/v1/option/getrule
- 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/v1/option/getrule?'.$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/v1/option/getrule'
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/v1/option/getrule',
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/v1/option/getrule?optionid=1&rule_type=SHOW' -H "api_key: 44b5498dbcb481a0d00b404c0169af62" -H "api_username: tmm1phrvezsbu"
