All successfully processed API requests return a JSON response with a status of 200 and a message of OK.

{
  "status": 200,
  "message": "OK",
  "response": "..."
}

If an application error is generated when processing the request, the error is reported in the status, code and message attributes of the response.

{
  "status": 400,
  "message": "Authentication failed",
  "code": 1200,
  "response": null
}

In the case of an error, the status has a value other than 200. A descriptive explanation of the error can be found in message. The code attribute identifies the category of the error.

Here's a description of error codes returned by the API.

status

code

reason

400

1200

Authentication failed

400

1003

Request validation failure; check parameter values and types

400

2102

No permission to access this book

400

2104

No permission to access this doc

400

1401

Book not found

400

1402

Book already exists

400

6001

Form Type Not Found

400

7002

Image Group Not Found