List Actions
From KickApps Documentation
Contents |
Overview
This method is an admin method that lists all actions defined in the system for your AS.
Request URL
http://api.kickapps.com/rest/badgeactions/list/{as}
Request Parameters
Required
- t - the user token generated via the "Create Token" API call. Must be a webmaster / moderator token.
- as - The site Id to search. as is unique for each of the affiliate's sites.
Optional
- callback. String. Optional. The name of your JavaScript callback function.
Response
Note: if callback is provided as an optional argument, the results illustrated below will be returned within the callback string provided for execution of a JavaScript function; e.g. callback=”MyCallbackFunc” will return something similar to:
MyCallbackFunc({…the success or failure response contained in curly braces you see below…});
</code>
<pre class="brush:js">
Success:
{
"status":1,
"actions":[
{
"actionId":"1234",
"name":"XXXX"
},
{
"actionId":"2345",
"name":"YYYY"
}
]
}
Failure: {"status": -1, "errorId": "123", "error": "Error Message"}
Response Parameters
- status – 1 on success and -1 on error.
- error – A message indicating the error condition
- errorId – A numeric reference to the error condition
- actions:
- actionId – The ID of the action just added into the system.
- name – Name of the action
Error codes:
- 1 = invalid token
- 18 = Insufficient user permissions for this operation
- 44 = token required
List of KickApps API Calls
Note: Occasionally (and without advanced warning) we modify our API calls by adding new parameters in the response payload. Please keep this in mind when designing your strategy for parsing our responses.
Favorites






