API Guide > Technical Reference > Error Responses
|
Developer Forum - Ask the LiquidPlanner development team questions. Note that the LP iPhone app uses this same API. |
|
API Sample Code – See the API in action then give it a try. |
Enter a search term or try the Dev Forums for more answers.
LiquidPlanner uses a RESTful web service API. You can download the API Guide (PDF) for offline reference. Most actions that you can perform within the application can be automated using the API -- for example, you can create a task, comment on the task, track time against it, and then mark it done.
NEED HELP? Please post API questions in the API forums
Response Body
When returning an error, the response body contains details of the error represented as a JSON hash.
For example, requesting the invalid “/bad_url” results in:
% curl https://app.liquidplanner.com/api/bad_url
{
"type": "Error",
"message": "Probably a typo (or junk) in your request: /api/bad_url",
"error": "BadRequest"
}
Status: 400Hash Keys
The hash keys in an error response include:
- type
- the literal string “Error”
- error
- specific kind of error, e.g. “NotFound” or “BadRequest”
- message
- descriptive or explanatory message
