|
Campaign Fees List
Returns a list of the fees for a given campaign.
The data to be submitted to the API is composed of the following fields:
|
|
field |
|
Example |
|
Note |
|
|
|
user_id |
|
john1970 |
|
Required |
|
|
|
user_password |
|
1959caadac9b13dcb3 |
|
Required |
|
|
|
type |
|
campaign_fees |
|
Required |
|
|
|
account_id |
|
greatwidgets |
|
Required |
|
|
|
campaign_id |
|
1234567890123456 |
|
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 |
|
|
|
|
|
|
|
|
|
Notes:
- Campaign fees are only available for Points and GiftCard (Stored Value) type of campaigns.
Example PHP Request:
If you are using PHP, the $data array would look like this:
- $data['user_id'] = 'john1970';
- $data['user_password'] = '1959caadac9b13dcb3';
- $data['type'] = 'campaign_fees';
- $data['account_id'] = 'greatwidgets';
- $data['campaign_id'] = '1234567890123456';
Success XML Response:
- <response status="success">
- <campaign>
- <id>1111222233334444</id>
- </campaign>
- <fees>
- <fee>
- <id>463</id>
- <interval>1</interval>
- <interval_type>years</interval_type>
- <amount>10</amount>
- <description>Yearly account fee</description>
- </fee>
- ...
- </fees>
- </response>
Notes:
- When identifying a depreciation entry to another API call, you use the <id> that is returned in the XML construct such as the one above.
- The amount is either the amount of points or money to be deducted, depending on the campaign type.
Error XML Response:
- <response status="error">
- <error>Error message</error>
- </response>
|
|