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...") |
|||
| Line 4: | Line 4: | ||
== '''PATCH /option/editrule''' == | == '''PATCH /option/editrule''' == | ||
'''Description''' | '''Description''' | ||
| − | *The /option/editrule endpoint 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. | + | *The /option/editrule endpoint/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''' | ||
Revision as of 00:46, 18 March 2015
PATCH /option/editrule
Description
- The /option/editrule endpoint/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/v1/option/editrule
- 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
- affid: 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/v1/option/editrule
- 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/editrule';
$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/editrule'
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/editrule',
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/editrule' -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'
