Difference between revisions of "NATS4 API Edit Option Rule"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} The Edit Option Rule API function is a feature in NATS4 that allows you to Edit existing option rule for your NATS join ...") |
m (→Request) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 20: | Line 20: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | This example continues from the [[NATS4_API#Example|main article NuSOAP Example]]: | ||
| + | |||
=== Request === | === Request === | ||
| − | The following | + | The following is an example request you can make with this API function using the following parameters: |
| − | option_rule_id, rule_type, start_time, end_time | + | *option_rule_id, rule_type, start_time, end_time |
<pre> | <pre> | ||
$data = Array( | $data = Array( | ||
| − | 'option_rule_id' => 124, | + | 'option_rule_id' => 124, |
| − | 'rule_type' => 'HIDE', | + | 'rule_type' => 'HIDE', |
| − | 'start_time' => '2013-12-18', | + | 'start_time' => '2013-12-18', |
| − | 'end_time' => '2013-12-21', | + | 'end_time' => '2013-12-21', |
| − | ) | + | ); |
$result = $client->call('edit_option_rule', $data, 'natsapiadmin_wsdl'); | $result = $client->call('edit_option_rule', $data, 'natsapiadmin_wsdl'); | ||
Latest revision as of 11:02, 26 December 2013
The Edit Option Rule API function is a feature in NATS4 that allows you to Edit existing option rule for your NATS join options using an API call.
Filters
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. These are parameters used to specify which option rule you're adding:
- option_rule_id - (required)
- rule_type- (required) ("SHOW", "HIDE" and "IGNORE")
- affid - (optional)
- siteid - (optional)
- tourid - (optional)
- programid - (optional)
- billerid - (optional)
- country - (optional)
- start_time - (optional) (if empty, start time will set to be today)
- end_time - (optional) (if empty, end time will set to be NEVER)
- cascadeid - only work if option is a xsell/upsell join option
Examples
This example continues from the main article NuSOAP Example:
Request
The following is an example request you can make with this API function using the following parameters:
- option_rule_id, rule_type, start_time, end_time
$data = Array(
'option_rule_id' => 124,
'rule_type' => 'HIDE',
'start_time' => '2013-12-18',
'end_time' => '2013-12-21',
);
$result = $client->call('edit_option_rule', $data, 'natsapiadmin_wsdl');
Response
Array
(
[0] => TRUE
)
