Difference between revisions of "Nats get member"
From TMM Wiki
Jump to navigationJump to search| (6 intermediate revisions by 3 users not shown) | |||
| Line 4: | Line 4: | ||
''Applies to [[NATS]] 4.0.62 and greater.'' | ''Applies to [[NATS]] 4.0.62 and greater.'' | ||
| − | = | + | = nats_get_member = |
Prints the member data selected by the input information. | Prints the member data selected by the input information. | ||
| Line 50: | Line 50: | ||
|- | |- | ||
| transaction_id | | transaction_id | ||
| − | | Specify the transaction id of the member you are looking for. | + | | Specify the the biller transaction id of a transaction associated with the member you are looking for. |
| − | | 12345 | + | | EPOCH:12345 |
| 0 | | 0 | ||
| − | | transaction_id=12345 | + | | transaction_id="EPOCH:12345" |
|- | |- | ||
| status | | status | ||
| Line 81: | Line 81: | ||
== Output == | == Output == | ||
| − | Returns an array | + | Returns an array called $get_member populated with the member data. |
== Examples == | == Examples == | ||
<pre> | <pre> | ||
| − | {nats_get_member | + | {nats_get_member memberid="12345"} |
</pre> | </pre> | ||
| Line 92: | Line 92: | ||
To make an array reference, create the array using the | To make an array reference, create the array using the | ||
[[nats_add_to_array]] function. | [[nats_add_to_array]] function. | ||
| + | |||
| + | [[Category:NATS4 Template Functions]] | ||
Latest revision as of 16:49, 9 December 2014
Applies to NATS 4.0.62 and greater.
nats_get_member
Prints the member data selected by the input information.
Alias: get_affiliates
Parameters
(Required parameters in bold)
| Parameter | Description | Possible Values | Default Value | Example |
|---|---|---|---|---|
| memberid | Specify the member id of the member you want to retrieve information on | 1 | 0 | memberid=1 |
| memberidx | Specify the memberidx of the member you want information for | RSBNATIVE:12345 | 0 | memberidx="RSBNATIVE:12345" |
| username | Specify the username of the member you're looking for. This parameter also requires siteid and email to be set | DemoUser | 0 | username="DemoUser" |
| siteid | Specify the siteid of the member you're looking for. This parameter also requires username and email to be set | 1 | 0 | siteid=1 |
| Specify the e-mail address of the member you're looking for. This parameter also requires the username and siteid | change@toomuchmedia.com | 0 | email=change@toomuchmedia.com | |
| transaction_id | Specify the the biller transaction id of a transaction associated with the member you are looking for. | EPOCH:12345 | 0 | transaction_id="EPOCH:12345" |
| status | Specify the status of the member you're looking for | 1 | 0 | status=1 |
| token_hash | Specify the token hash of the member you're looking for. | 13asd12 | 0 | token_hash="13asd12" |
| full_info | Specify if you want to retrieve all the information for the member | 1 | 0 | full_info=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 called $get_member populated with the member data.
Examples
{nats_get_member memberid="12345"}
Notes
To make an array reference, create the array using the nats_add_to_array function.
