Difference between revisions of "NATS5 REST API Site GET option-rules"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Site GET option-rules to NATS5 REST API Site GET option-rules: Renaming NATS5 API pages) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''GET /site/option-rules''' == | == '''GET /site/option-rules''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
| 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 59: | Line 60: | ||
"optionid": "ALL", | "optionid": "ALL", | ||
"rule_type": "1", | "rule_type": "1", | ||
| − | "identid": " | + | "identid": "14", |
| − | "start_time": " | + | "start_time": "1565382572", |
"end_time": "0", | "end_time": "0", | ||
| − | "start_nice": "2019- | + | "start_nice": "2019-08-09 16:29:32", |
"end_nice": "FOREVER", | "end_nice": "FOREVER", | ||
"rule_status": 1, | "rule_status": 1, | ||
"advanced": 1, | "advanced": 1, | ||
"override_identifier_id": [ | "override_identifier_id": [ | ||
| − | " | + | "14" |
], | ], | ||
| − | "ruleid": " | + | "ruleid": "1565382572:0:1", |
"affiliate": { | "affiliate": { | ||
"productsupport": "productsupport" | "productsupport": "productsupport" | ||
| Line 171: | Line 172: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_site_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 /site/option-rules
Description
Resource URL
- http://domain/api/site/option-rules
- 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
- rule_types
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional (default value: Array)
- login
- optional
- option
- optional
- program
- optional
- site
- optional
- tour
- optional
- biller
- optional
- cascade
- optional
- country
- optional
- text_search
- optional
Example Request
Method: GET
URL: http://domain/api/site/option-rules
Query String: optionid=2&rule_types=1&login=1&program=1&biller=1
Response:
{
"success": true,
"option_rules": [
{
"optionid": "ALL",
"rule_type": "1",
"identid": "14",
"start_time": "1565382572",
"end_time": "0",
"start_nice": "2019-08-09 16:29:32",
"end_nice": "FOREVER",
"rule_status": 1,
"advanced": 1,
"override_identifier_id": [
"14"
],
"ruleid": "1565382572: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,
'rule_types' => '1',
'login' => '1',
'program' => '1',
'biller' => '1',
);
$request = Array(
'method' => 'GET',
'path' => 'v1/site/option-rules',
'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);
?>
