Response Codes
All errors are returned using standard HTTP response codes. For example, you will recognize that a 404 error means, roughly, that the object you are trying to access does not exist in the system. See the table below for an overview the main response codes.
| Error Code Response Header | HTTP Response Code | Description |
|---|---|---|
| N/A | 401 | Failed Authorization |
| CallCountExpended | 402 | You have reached your API call count for the day, and can no longer perform API calls |
| InvalidRequestDataFormat | 400 | Data in your request parameters is badly formatted |
| RequestBodyRequired | 400 | You have posted to a method that requires a request body, but did not provide a body |
| MediaTypeNotSupported | 415 | The requested media type is not supported by the API |
| MediaTypeNotSpecified | 400 | The request was made without specifying the media type (via request extension) |
| ObjectNotFound | 404 | The requested object was not found on the server |
| ServerError | 5xx | A problem occurred on the ProntoForms server. |
Response Headers
ProntoForms response headers are used to provide additional information on the request.
| Header Name | Contents |
|---|---|
| X-ProntoForms-RequestId | ID of the request. Useful when reporting problems to ProntoForms support |
| X-ProntoForms-ErrorCode | More specific error code than the HTTP Response Code. This article details the general errors you may receive. Specific method calls may have additional errors, which can be found on each method description page. |
| X-ProntoForms-ErrorMessage | Human-readable message indicating what the problem was and possible steps to fix it |
| X-ProntoForms-ErrorMessageDetails | Zero or more additional messages with deeper details about the error |
NOTE: Individual API methods may have specific error codes and response header values associated with them. Consult the documentation on the method of interest for additional information.
Comments