Difference between revisions of "NATS4 API Add Option Rule"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} The Set Option Rule API function is a feature in NATS4 that allows you to Set option rule for your NATS join options usi...") |
m (→Request) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 3: | Line 3: | ||
}} | }} | ||
| − | The | + | The Add Option Rule API function is a feature in [[NATS4]] that allows you to add option rule for your NATS join options using an API call. |
==Filters== | ==Filters== | ||
This function will allow you to add option rules by optionid, 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: | This function will allow you to add option rules by optionid, 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: | ||
* optionid - '''(required)''' | * optionid - '''(required)''' | ||
| − | * rule_type- '''(required)''' ("SHOW", "HIDE" and "IGNORE") | + | * rule_type - '''(required)''' ("SHOW", "HIDE" and "IGNORE") |
| − | * affid - optional | + | * affid - (optional) |
| − | * siteid - optional | + | * siteid - (optional) |
| − | * tourid - optional | + | * tourid - (optional) |
| − | * programid - optional | + | * programid - (optional) |
| − | * billerid - optional | + | * billerid - (optional) |
| − | * country - optional | + | * country - (optional) |
| − | * start_time - optional (if empty, start time will set to be today) | + | * start_time - (optional) (if empty, start time will be set to be today) |
| − | * end_time - optional (if empty, end time will set to be NEVER) | + | * end_time - (optional) (if empty, end time will be set to be NEVER) |
| − | * cascadeid - only | + | * cascadeid - only applicable if the option is an xsell or upsell join option |
==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: |
| + | |||
| + | *optionid, rule_type, start_time, end_time | ||
| − | |||
<pre> | <pre> | ||
$data = Array( | $data = Array( | ||
| − | 'optionid' => 1, | + | 'optionid' => 1, |
| − | 'rule_type' => 'SHOW', | + | 'rule_type' => 'SHOW', |
| − | 'start_time' => '2013-12-18', | + | 'start_time' => '2013-12-18', |
| − | 'end_time' => '2013-12-21', | + | 'end_time' => '2013-12-21', |
| − | ) | + | ); |
$result = $client->call('add_option_rule', $data, 'natsapiadmin_wsdl'); | $result = $client->call('add_option_rule', $data, 'natsapiadmin_wsdl'); | ||
Latest revision as of 11:02, 26 December 2013
The Add Option Rule API function is a feature in NATS4 that allows you to add option rule for your NATS join options using an API call.
Filters
This function will allow you to add option rules by optionid, 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:
- optionid - (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 be set to be today)
- end_time - (optional) (if empty, end time will be set to be NEVER)
- cascadeid - only applicable if the option is an xsell or 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:
- optionid, rule_type, start_time, end_time
$data = Array(
'optionid' => 1,
'rule_type' => 'SHOW',
'start_time' => '2013-12-18',
'end_time' => '2013-12-21',
);
$result = $client->call('add_option_rule', $data, 'natsapiadmin_wsdl');
Response
Array
(
[0] => TRUE
[1] => Array
(
[option_rule_id] => 124
)
)
