Nats list affiliates
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Applies to NATS 4.0.51 and greater.
nats_list_affiliates
Prints a list of affiliates with the requested information.
Alias: list_affiliates
Parameters
(Required parameters in bold)
Parameter | Description | Possible Values | Default Value | Example |
---|---|---|---|---|
userid | Specify the user ids of the affiliates you want to retrieve information on | 1, 2, 3, 4, 5 | ALL (retrieves all affiliates) | userid="1,2,3,162" |
status | Specify the affiliates you want to list by their status | 0 (Active), 1 (Disabled), 2 (Banned), 3(Wait on Verify), 4(Pending), 5(Denied) | 0 | status="1,2,3" |
deleted | Specify if you want to list deleted affiliates when retrieving ALL affiliates | 0, 1 | 0 | deleted=1 |
data | Return the affiliates information along with the username | 0, 1 | 0 | data=1 |
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
Returns an array of the affiliates. By default the array is:
3 => "lonnyk"
When data=1 is passed in the function will return a multi-dimensional array and will have the following variables available as well:
- username
- deleted
- type
- payvia_type_id
- status
- join_date
- firstname
- lastname
- last_login
- minimum_payout
- company
- url
- tel
- icq
- aim
- msn
- address1
- address2
- city
- state
- country
- zip_code
- tax_id_or_ssn
Examples
{nats_list_affiliates data=1 deleted=1 userid="1,105,1036"}
Notes
To make an array reference, create the array using the nats_add_to_array function.