|
Membership Levels - List
Retrives the list of existing Membership Levels in a given Membership Program.
The data to be submitted to the API is composed of the following fields:
|
|
field |
|
Example |
|
Note |
|
|
|
API |
|
1.5 |
|
Required |
|
|
|
user_id |
|
john1970 |
|
Required |
|
|
|
user_api_key |
|
1959ca5645adac9b13dcb3 |
|
Required |
|
|
|
account_id |
|
greatwidgets |
|
Required |
|
|
|
type |
|
manage_membership_levels |
|
Required |
|
|
|
action |
|
list |
|
Required |
|
|
|
membership_program_id |
|
8121227452706343 |
|
Required |
|
|
|
|
|
|
|
|
|
|
|
Output Format: |
|
|
|
output |
|
JSON or XML |
|
Optional. If not provided, defaults to XML |
|
|
|
callback |
|
someFunctionName |
|
Optional: JSONP format |
|
|
|
condensed |
|
yes |
|
Optional (No white space) Applies only to JSON(P) output |
|
|
|
|
|
|
|
|
|
Example PHP Request:
If you are using PHP, the $data array would look like this:
- $data['API'] = '1.5';
- $data['user_id'] = 'john1970';
- $data['user_api_key'] = '1959caadac9b13dcb3';
- $data['type'] = 'manage_membership_levels';
- $data['action'] = 'info';
- $data['account_id'] = 'greatwidgets';
- $data['membership_program_id'] = '8121227452706343';
Success XML Response
- <response status="success">
- <membership_level>
- <membership_level_id>53</membership_level_id>
- <membership_program_id>8121227452706343</membership_program_id>
- <membership_level_qualifier>0</membership_level_qualifier>
- <membership_level_multiplier>1.0</membership_level_multiplier>
- <membership_level_description>Basic</membership_level_description>
- </membership_level>
- <membership_level>
- <membership_level_id>54</membership_level_id>
- <membership_program_id>8121227452706343</membership_program_id>
- <membership_level_qualifier>10000</membership_level_qualifier>
- <membership_level_multiplier>1.5</membership_level_multiplier>
- <membership_level_description>Silver</membership_level_description>
- </membership_level>
- <membership_level>
- <membership_level_id>55</membership_level_id>
- <membership_program_id>8121227452706343</membership_program_id>
- <membership_level_qualifier>50000</membership_level_qualifier>
- <membership_level_multiplier>2.0</membership_level_multiplier>
- <membership_level_description>Gold</membership_level_description>
- </membership_level>
- </response>
Error XML Response:
- <response status="error">
- <error>Error message</error>
- </response>
|
|