NATS4 API Get Option Rule
From TMM Wiki
Jump to navigationJump to search
The Get Option Rule API function is a feature in NATS4 that allows you to get option rule for your NATS membership options using an API call.
Filters
These are parameters used to specify which option you're looking for. This function will return a list of option rule filter by optionid and rule type.
- optionid
- rule_type ("SHOW", "HIDE", "ALL" or empty *empty will display both "SHOW" and "HIDE" rule)
In order to get a return from this function, opitonid is required
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 ruel_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 ) ) )