Get Information About an Existing Callback

Operation Summary:

Retrieves information about a single, previously registered, callback

Resource URL:

http://api.compendiumblog.com/app/callback/{CallbackId}

HTTP method:

GET

HTTP Status Codes:

200 OK

403 Forbidden

HTTP Status Code Details:

201 Created: The callback information 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:

CallbackId: The system-assigned unique identifier of the callback.

Optional Parameters:

There are no optional parameters for this endpoint.

Response Values:

Success: The callback data was retrieved successfully.
Error: The callback data was not retrieved successfully.

Response Structure:

Responses are single-member objects which have a property name based on the type of result.

The Success result will look like:

{
    '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:

CallbackId: An invalid callback ID was specified.

Additional Notes:

The "Super Administrator" role may retrieve a callback either at the global scope or for any network.
The "Super Delegate" role may retrieve a callback for any assigned network.
The "Network Administrator" role may retrieve a callback for his or her own network.

Command Line Example

curl -v --insecure \
-H 'Accept: application/vnd.compendium.blog;version=2,application/json'  \
--user 'username:fwwAcHDbpcPGRKGXXLiFHvxgtEAeQ3QVOk6RRfTf'  \
https://api.test.compendiumblog.com/app/callback/9213a475-95c9-4a70-a90f...

Compendium Documentation

Help

Get Information About an Existing Callback