Difference between revisions of "NATS5 REST API Site GET option-rule"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Site GET option-rule to NATS5 REST API Site GET option-rule: Renaming NATS5 API pages) |
|
(No difference)
| |
Revision as of 15:21, 9 August 2019
GET /site/option-rule
Description
Resource URL
- http://domain/api/site/option-rule
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- optionid
- type: digit
- required
- ruleid
- type: string
- required
Example Request
Method: GET
URL: http://domain/api/site/option-rule
Query String: optionid=2&ruleid=1562601277%3A0%3A1
Response:
{
"success": true,
"option_rule": {
"optionid": "ALL",
"rule_type": "1",
"identid": "13",
"start_time": "1562601277",
"end_time": "0",
"start_nice": "2019-07-08 11:54:37",
"end_nice": "FOREVER",
"rule_status": 1,
"advanced": 1,
"override_identifier_id": [
"13"
],
"ruleid": "1562601277:0:1",
"affiliate": {
"productsupport": "productsupport"
},
"rule_type_nice": "SHOW",
"tour": [
{
"id": 0,
"name": "ALL"
}
],
"program": [
{
"id": "1",
"name": null
}
],
"login": [
{
"id": "1",
"name": "productsupport"
}
],
"country": [
{
"id": "EU",
"name": "Europe *"
}
],
"biller": [
{
"id": "1",
"name": "NETBILLING-1"
}
]
}
}
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(
'optionid' => 2,
'ruleid' => '1562601277:0:1',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/site/option-rule',
'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);
?>
