Difference between revisions of "NATS4 REST API Edit Option Rule"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''PATCH /option/editrule''' == '''Description''' *The /option/editrule endpoint is a feature in NATS4 that allows y...") |
Tmm vincent (talk | contribs) (Correcting Resource URL and loginid parameter) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
| show_api_admin_section = true | | show_api_admin_section = true | ||
}} | }} | ||
| − | == '''PATCH /option/ | + | == '''PATCH /option/rule''' == |
'''Description''' | '''Description''' | ||
| − | *The /option/ | + | *The /option/rule action is a feature in [[NATS4]] that allows you to Edit existing option rule for your NATS join options using an API call. This function will allow you to edit option rules by option rule id, rule type, loginid, siteid, tourid, programid, billerid, country, start_time, end_time and cascadeid. |
'''Resource URL''' | '''Resource URL''' | ||
| − | *<nowiki>http://domain/api | + | *<nowiki>http://domain/api/option/rule</nowiki> |
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| Line 31: | Line 31: | ||
**'''required ''' | **'''required ''' | ||
| − | *''' | + | *'''loginid''': affiliate id |
**'''''type: int''''' | **'''''type: int''''' | ||
**''' optional''' | **''' optional''' | ||
| Line 72: | Line 72: | ||
'''PATCH''' | '''PATCH''' | ||
| − | <nowiki>http://domain/api | + | <nowiki>http://domain/api/option/rule</nowiki> |
*Response: | *Response: | ||
| Line 95: | Line 95: | ||
); | ); | ||
| − | $url = 'http://domain/api/option/ | + | $url = 'http://domain/api/option/rule'; |
$headers = array( | $headers = array( | ||
| − | ' | + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username: tmm1phrvezsbu' |
); | ); | ||
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); | curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH"); | ||
| Line 121: | Line 121: | ||
import json | import json | ||
| − | url = 'http://domain/api/option/ | + | url = 'http://domain/api/option/rule' |
payload = { | payload = { | ||
| Line 131: | Line 131: | ||
headers = { | headers = { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
| Line 154: | Line 154: | ||
var options = { | var options = { | ||
| − | url: 'http://domain/api/option/ | + | url: 'http://domain/api/option/rule', |
method: 'PATCH', | method: 'PATCH', | ||
form: data, | form: data, | ||
json: true, | json: true, | ||
headers: { | headers: { | ||
| − | ' | + | 'api-key': '44b5498dbcb481a0d00b404c0169af62', |
| − | ' | + | 'api-username': 'tmm1phrvezsbu' |
} | } | ||
}; | }; | ||
| Line 180: | Line 180: | ||
'''Curl''' | '''Curl''' | ||
<pre> | <pre> | ||
| − | curl -X PATCH 'http://domain/api/option/ | + | curl -X PATCH 'http://domain/api/option/rule' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'option_rule_id=18&rule_type=HIDE&start_time=2015-03-14&end_time=2066-06-06' |
</pre> | </pre> | ||
[[Category:NATS4 API Articles]] | [[Category:NATS4 API Articles]] | ||
Latest revision as of 22:58, 8 December 2017
PATCH /option/rule
Description
- The /option/rule action is a feature in NATS4 that allows you to Edit existing option rule for your NATS join options using an API call. This function will allow you to edit option rules by option rule id, rule type, loginid, siteid, tourid, programid, billerid, country, start_time, end_time and cascadeid.
Resource URL
- http://domain/api/option/rule
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded
- option_rule_id: option rule id
- type: int
- required
- rule_type: ("SHOW", "HIDE" and "IGNORE")
- type: string
- required
- loginid: affiliate id
- type: int
- optional
- siteid: Site id
- type: int
- optional
- tourid: tour id
- type: int
- optional
- programid: The program id
- type: int
- optional
- billerid: The biller id
- type: int
- optional
- country: The country code
- type: string
- optional
- start_time: Start time to set the option rule
- type: string
- optional (if empty, start time will set to be today)
- end_time: End time to set the rule
- type: string
- optional (if empty, end time will set to be NEVER)
- cascadeid: Cascade id, only works if option is a xsell/upsell join option
- type: int
- optional
Example Request
PATCH
http://domain/api/option/rule
- Response:
{
"result": "TRUE"
}
Example Code
PHP
<?php
$curl = curl_init();
$data = array(
'option_rule_id' => '18',
'rule_type' => 'HIDE',
'start_time' => '2015-03-14',
'end_time' => '2066-06-06'
);
$url = 'http://domain/api/option/rule';
$headers = array(
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));
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
import json
url = 'http://domain/api/option/rule'
payload = {
'option_rule_id': '18',
'rule_type': 'HIDE',
'start_time': '2015-03-14',
'end_time': '2066-06-06'
}
headers = {
'api-key': '44b5498dbcb481a0d00b404c0169af62',
'api-username': 'tmm1phrvezsbu'
}
res = requests.patch(url, data=payload, 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');
data = {
'option_rule_id': '18',
'rule_type': 'HIDE',
'start_time': '2015-03-14',
'end_time': '2066-06-06'
}
var options = {
url: 'http://domain/api/option/rule',
method: 'PATCH',
form: data,
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 PATCH 'http://domain/api/option/rule' -H "api-key: 44b5498dbcb481a0d00b404c0169af62" -H "api-username: tmm1phrvezsbu" -H "Content-Type: application/x-www-form-urlencoded" -d 'option_rule_id=18&rule_type=HIDE&start_time=2015-03-14&end_time=2066-06-06'
