Nats list programs

From TMMwiki
Jump to: navigation, search
NATS 4
    Template Functions
nats_add_to_array
nats_adtool_replace_linkcode
nats_array_flip
nats_array_to_xml
nats_build_array_by_reference
nats_convert_bytes
nats_decode
nats_display_account_campaigns
nats_display_account_change_history
nats_display_account_notifications
nats_display_account_preview
nats_display_admin_links
nats_display_admin_message
nats_display_adtool_form
nats_display_adtool_types
nats_display_adtools
nats_display_adtools_type_limit
nats_display_choose_adtools_group
nats_display_code_info
nats_display_create_campaign
nats_display_edit_account_details
nats_display_edit_account_settings
nats_display_edit_defaults
nats_display_edit_password
nats_display_edit_payvia
nats_display_edit_payvia_info
nats_display_edit_skin
nats_display_gallery_builder
nats_display_graph
nats_display_hourly_sales
nats_display_latest_adtools
nats_display_map
nats_display_news
nats_display_page_peel
nats_display_payment_history
nats_display_payment_summary
nats_display_ratio
nats_display_reward_category
nats_display_reward_order
nats_display_reward_purchases
nats_display_signup_advanced
nats_display_signup_basic
nats_display_signup_payvia
nats_display_stats
nats_display_stats_calendar
nats_display_stats_form
nats_display_stats_referrals
nats_display_stats_retention
nats_display_stats_subscription_details
nats_display_stats_table
nats_display_timezones
nats_display_top_stats
nats_dump_data
nats_encode
nats_get_first_in_array
nats_get_period_end
nats_get_reward_categories
nats_get_member
nats_list_adtool_groups
nats_list_affiliates
nats_list_billers
nats_list_campaigns
nats_list_linkcodes
nats_list_options
nats_get_option_details
nats_list_programs
nats_list_sites
nats_list_tool_categories
nats_list_tours
nats_list_xsells
nats_smarty_function_amount_owed
nats_smarty_function_getbonus
nats_smarty_rebuild_form
nats_smarty_rebuild_link
nats_smarty_rebuild_query
nats_tooltip
tmm_admin_pagination
Template Shortcuts
add_to_array
adtool_replace_linkcode
affiliate_select_form
array_flip
array_to_xml
amount_owed
build_array_by_reference
convert_bytes
display_account_campaigns
display_account_change_history
display_account_notifications
display_account_preview
display_admin_links
display_adtool_form
display_adtool_types
display_adtools
display_adtools_type_limit
display_choose_adtools_group
display_code_info
display_create_campaign
display_gallery_builder
display_stats_referrals
display_edit_account_details
display_edit_account_settings
display_edit_defaults
display_edit_password
display_edit_payvia
display_edit_payvia_info
display_edit_skin
display_graph
display_hourly_sales
display_latest_adtools
display_map
display_news
display_page_peel
display_payment_history
display_payment_summary
display_ratio
display_reward_category
display_reward_order
display_reward_purchases
display_signup_advanced
display_signup_basic
display_signup_payvia
display_stats
display_stats_calendar
display_stats_table
display_stats_form
display_stats_retention
display_stats_subscription_details
display_top_stats
display_timezones
dump_data
get_first
get_period_end
get_reward_categories
list_billers
list_campaigns
list_linkcodes
list_options
list_programs
list_sites
list_tool_categories
list_tours
list_xsells
rebuild_form
rebuild_link
rebuild_query
reward_points
tooltip
Common Parameters
assign
assign_prefix
count
data_only
display_on_assign
start
tpl

Applies to NATS 4.0.25 and greater.

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..."

Notes

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

See Also