|
Membership Programs - Retrieve Information
Retrieves the configuration details of an existing 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_memberships |
|
Required |
|
|
|
action |
|
info |
|
Required |
|
|
|
membership_program_id |
|
5208143496464281 |
|
Required |
|
|
|
include_levels |
|
Y |
|
Optional |
|
|
|
|
|
|
|
|
|
|
|
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_memberships';
- $data['action'] = 'info';
- $data['account_id'] = 'greatwidgets';
- $data['membership_program_id'] = '5208143496464281';
- $data['include_membership_levels'] = 'Y';
Success XML Response
- <response status="success">
- <membership>
- <membership_program_id>5208143496464281</membership_program_id>
- <membership_program_name>Amazing Rewards Club</membership_program_name>
- <membership_custom_qualifier_name></membership_custom_qualifier_name>
- <membership_style>A</membership_style>
- <membership_time_range>12</membership_time_range>
- <membership_time_unit>M</membership_time_unit>
- <membership_campaigns_included>all</membership_campaigns_included>
- <membership_levels>
- <membership_level_id_id>43</membership_level_id>
- <membership_program_id>2303626404596905</membership_program_id>
- <membership_level_qualifier>0</membership_level_qualifier>
- <membership_level_multiplier>1</membership_level_multiplier>
- <membership_level_description>Basic</membership_level_description>
- </membership_levels>
- <membership_levels>
- <membership_level_id_id>44</membership_level_id>
- <membership_program_id>2303626404596905</membership_program_id>
- <membership_level_qualifier>2500</membership_level_qualifier>
- <membership_level_multiplier>1.20</membership_level_multiplier>
- <membership_level_description>Bronze</membership_level_description>
- </membership_levels>
- <membership_levels>
- <membership_level_id_id>45</membership_level_id>
- <membership_program_id>2303626404596905</membership_program_id>
- <membership_level_qualifier>5000</membership_level_qualifier>
- <membership_level_multiplier>1.30</membership_level_multiplier>
- <membership_level_description>Silver</membership_level_description>
- </membership_levels>
- <membership_levels>
- <membership_level_id_id>46</membership_level_id>
- <membership_program_id>2303626404596905</membership_program_id>
- <membership_level_qualifier>10000</membership_level_qualifier>
- <membership_level_multiplier>1.50</membership_level_multiplier>
- <membership_level_description>Gold</membership_level_description>
- </membership_levels>
- </membership>
- </response>
Error XML Response:
- <response status="error">
- <error>Error message</error>
- </response>
|
|