nats_list_programs

Article Topics: Smarty, Customization

nats_list_programs

Obtains a list of programs.

Alias: list_programs

Parameters

(Required parameters in bold)

Parameter	Description	Possible Values	Default Value	Example
hidden	Show hidden programs	0 or 1 (exclusive)	0. Shows only unhidden programs	hidden="1"
detailed	Get detailed info about programs	0 or 1 (exclusive)	0. Does not get detailed info	detailed="1"
include_only	Limit results to one program type. Overwritten by type parameter below	A program ID number (See also the type parameter below)	0. Gets all program types	include_only="123"
not_all_types	Same as include_only above deprecated
no_enabled	Don't get enabled programs	0 or 1 (exclusive)	0. Gets enabled programs	no_enabled="1"
get_disabled	Get enabled programs	0 or 1	0. Doesn't get enabled programs.	get_disabled="1"
no_payout_string	Don't get the payout description	0 or 1 (exclusive)	0. Gets the payout description	no_payout_string="1"
payout_array	Store payout information in this array	Any valid Smarty array name	None.	payout_array="my_array"
type	Limit results to these program types. Overwrites include_only parameter above	Comma-separated list of program type IDs to get	None. Not used by default	type="1,2,3"
assign_prefix	Prefix output variables with this word. (Click link for details)	Any valid Smarty variable name	None. (No prefix is used)	assign_prefix="myvar"

Output

Outputs the Smarty array, $programs with the following format:

Array (5)
1 => "Rev Share [up to $4.00 per Join AND u..."
3 => "revshare 2 [20% of Join AND 15% of Re..."
2 => "Xsells [$3.00 per Unq Click AND $3.00..."

Additional Notes

The parameter not_all_types is deprecated; please don't use it.

Related Articles

nats_list_campaignsnats_list_linkcodes