Difference between revisions of "NATS4 API Get Option Rule"
From TMM Wiki
Jump to navigationJump to searchm (→Requests) |
|||
| Line 3: | Line 3: | ||
}} | }} | ||
| − | The Get Option Rule API function is a feature in [[NATS4]] that allows you to get option rule for your NATS | + | The Get Option Rule API function is a feature in [[NATS4]] that allows you to get option rule details for your NATS join options using an API call. |
==Filters== | ==Filters== | ||
| − | + | This function will return a list of option rules filtered by optionid and rule type. These are parameters used to specify which option you're looking for: | |
| − | * optionid | + | * optionid - '''(required)''' |
| − | * rule_type ("SHOW", "HIDE", "ALL" or empty | + | * rule_type ("SHOW", "HIDE", "ALL" or "" (empty string). "" will display both "SHOW" and "HIDE" rules.) |
| − | |||
| − | |||
| − | |||
==Examples== | ==Examples== | ||
| Line 36: | Line 33: | ||
</pre> | </pre> | ||
| − | + | Example of the return data: | |
<pre> | <pre> | ||
Revision as of 11:45, 18 December 2013
The Get Option Rule API function is a feature in NATS4 that allows you to get option rule details for your NATS join options using an API call.
Filters
This function will return a list of option rules filtered by optionid and rule type. These are parameters used to specify which option you're looking for:
- optionid - (required)
- rule_type ("SHOW", "HIDE", "ALL" or "" (empty string). "" will display both "SHOW" and "HIDE" rules.)
Examples
Requests
The following are examples of the requests you can make with this API function:
optionid
$values = array(
'optionid' => 1,
);
$result = $client->call('get_option_rule', $values, 'natsapiadmin_wsdl');
optionid and rule_type
$values = array(
'optionid' => 1,
'rule_type' => "SHOW",
);
$result = $client->call('get_option_rule', $values, 'natsapiadmin_wsdl');
Example of the return data:
Array
(
[0] => TRUE
[1] => Array
(
[0] => Array
(
[option_rule_id] => 107
[optionid] => 0
[rule_type] => SHOW
[identid] => 3
[start_time] => 2013-12-11 15:57:24
[end_time] => 0000-00-00
[cascadeid] => 0
[override_identifier_id] => 3
[loginid] => 0
[networkid] => 0
[programid] => 1
[siteid] => 0
[tourid] => 0
[adtoolid] => 0
[subid1] => 0
[subid2] => 0
[billerid] => 0
[countryid] => 0
[promotionalid] => 0
)
[1] => Array
(
[option_rule_id] => 105
[optionid] => 0
[rule_type] => SHOW
[identid] => 7
[start_time] => 2013-12-11 15:54:12
[end_time] => 0000-00-00
[cascadeid] => 0
[override_identifier_id] => 7
[loginid] => 0
[networkid] => 0
[programid] => 0
[siteid] => 0
[tourid] => 0
[adtoolid] => 0
[subid1] => 0
[subid2] => 0
[billerid] => 0
[countryid] => 0
[promotionalid] => 0
)
[2] => Array
(
[option_rule_id] => 106
[optionid] => 0
[rule_type] => SHOW
[identid] => 7
[start_time] => 2013-12-11 15:56:10
[end_time] => 0000-00-00
[cascadeid] => 0
[override_identifier_id] => 7
[loginid] => 0
[networkid] => 0
[programid] => 0
[siteid] => 0
[tourid] => 0
[adtoolid] => 0
[subid1] => 0
[subid2] => 0
[billerid] => 0
[countryid] => 0
[promotionalid] => 0
)
)
)
