Responses and Error Handling

Responses in APIs built with the API designer all come back with a standard envelope:

{
    Success : < true/false >,
    Message : < string containing the error message if Success is false >
    Data : {  User defined data }
}

The Success parameter will be false if significant error occured and the Message will have information on the nature of the error. All the user defined response data as defined in the response message is nested under the Data tag.

Because of this well defined structure it makes it easy to write clients for these APIs.

Currently we do not support the full set of possible RESTful APIs with the API designer, this is the next feature we planned in our road map.

 

Leave A Comment?