Difference between revisions of "Nats get option details"
| Line 38: | Line 38: | ||
== Example Code == | == Example Code == | ||
| + | You need at least pass an optionid, for example: | ||
| + | {nats_get_option_details optionid=$key} | ||
| + | |||
| + | Or, pass an optionid and billerid: | ||
{nats_get_option_details optionid=1 billerid='ALL'} | {nats_get_option_details optionid=1 billerid='ALL'} | ||
Will return the full details of option with ID 1 to the array ''{$option_details}''. | Will return the full details of option with ID 1 to the array ''{$option_details}''. | ||
[[Category:NATS4 Template Functions]] | [[Category:NATS4 Template Functions]] | ||
Revision as of 10:55, 27 December 2012
{nats_get_option_details} is a Smarty function that looks up details for a specified option-- this information will not be biller specific (duration, price, etc.) This function stores a list of the details for the given option in the {$option_details} Smarty variable.
Parameters
(Required parameters in bold)
| Parameter | Description | Possible Values | Default Value | Example |
|---|---|---|---|---|
| optionid | The ID of the option to get info for | Any valid optionid number | none | optionid="123" |
| billerid | The ID of the biller to get info for | Any valid optionid number or ALL for all billers | none | billerid="1" |
Output
A list of option details for the given option in the {$option_details} Smarty variable.
Notes
As of NATS version 4.0.73.1, you can now pass billerid=1 OR billerid=ALL to the nats_get_option_details() function. This allows you to get option details for one specific biller, or biller details for ALL billers available for that option.
Example Code
You need at least pass an optionid, for example:
{nats_get_option_details optionid=$key}
Or, pass an optionid and billerid:
{nats_get_option_details optionid=1 billerid='ALL'}
Will return the full details of option with ID 1 to the array {$option_details}.
