List a Network's Registered Callbacks

Operation Summary: 
Retrieves a list of callbacks registered for a network.
Resource URL: 
https://api.compendiumblog.com/app/callbacks
HTTP method: 
GET
HTTP Status Codes: 
200 OK
403 Forbidden
HTTP Status Code Details: 
200 OK
The callback list was retrieved successfully.
403 Forbidden
The user invoking the endpoint is not authenticated or does not have appropriate authorization to perform the operation
Response Representations: 
JSON
Permitted Roles: 
Super Administrator
Super Delegate
Network Administrator
Required Parameters: 

There are no required parameters for this endpoint.

Optional Parameters: 
Count
The maximum number of callback items to retrieve.
Page
The page offset to determine how far back in the list to retrieve.
Sort
The criterion to be used for ordering metadata. Valid values include EventName, NetworkId and CreationTimestamp.
Order
The order to be used for sorting. Valid values are Ascending and Descending.
SearchKey
The key to use for searching. One of EventName or CallbackDescriptor.
SearchTerm
Keywords to be used in filtering results. A search term is applied only to field specified by SearchKey, or EventName if unspecified.
NetworkId
The ID of the network to restrict the view to.
Response Values: 
Success
The callback listing was retrieved successfully.
Error
The callback listing was not retrieved successfully.
Response Structure: 

A successful call will result in a JSON object with the following structure:

{
    'Success' : [
        {
            'CallbackId'        : string,  // unique identifier of the callback
            'NetworkId'         : string,  // the NetworkId this callback identifier is associated with
            'EventName'         : string,  // the event that this callback is associated with
            'CreationTimestamp' : string,  // ISO 8601 formatted timestamp for when the callback was created
            'CallbackVersion'   : integer, // The callback version number
            'CallbackDescriptor': object   // the URL endpoint to perform an operation on
        },
        ...
    ]
}

The Error result will be a flat array of objects, which have keys for the message name and explanatory text.

{
     'Error' : [
       { 'Name' : string, 'Message' : string },
       { 'Name' : string, 'Message' : string },
       ...   
    ]
 }
Error Types: 
Read
An error occurred while retrieving callback list.
Count
Count must be an integer between 1 and 50.
Page
Page must be a positive integer.
Sort
An invalid sort key was was specified. Valid keys are EventName, NetworkId, or CreationTimestamp.
Order
An invalid ordering was specified.
SearchKey
An invalid SearchKey was specified.
NetworkId
An invalid network ID was specified.
Additional Notes: 
  • The "Super Administrator" role may list callbacks either at the global scope or for any network.
  • The "Super Delegate" role may list callbacks for any assigned network.
  • The "Network Administrator" role may list callbacks for his or her own network.

Command Line Example

curl -v --insecure \
-H 'Accept: application/vnd.compendium.blog;version=2,application/json'  \
--user 'username:KeKLFeBMSn4YTZgkGQ3Wq5BcpezWxF8fJrQxv2hn'  \
https://api.test.compendiumblog.com/app/callbacks?&NetworkId=4719874f-91...
Drupal 6 Appliance - Powered by TurnKey Linux