Responses and Error Codes
Votiro uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed because of the information provided (for example, a required parameter was omitted), and codes in the 5xx range indicate an error with Votiro's servers.
Status Code | Code Value | Description |
---|---|---|
200 | OK | The request was successful. |
400 | Bad Request | The request included a non-existent resource, for example, an incorrect requestId. |
401 | Unauthorized | Authentication failure due to incorrect service token. Recommended action: verify the service token. |
404 | Not Found | The request failed due to high load on the system. Recommended action: retry request. |
409 | Conflict | There was an issue with the request parameters. The response includes detailed error information. |
429 | Max InProgress Requests | Maximum number of concurrent sanitization requests are reached |
500 | Internal Server Error | The server failed to process the request. |
An error response includes the following parameters:
Parameter | Description | Type |
---|---|---|
Errors | List of error description objects. | list |
Errors [n] Description | The ASCII encoded file name. If the file was processed successfully, this is the file name. If the file was blocked, then the suffix _blocked.pdf is appended to the file name. | string |
Error Response Example
"Errors": "Description": "File name is empty."
Response Data
Response Parameters
Parameter | Description | Type |
---|---|---|
Status | The status of the positive selection request | string |
Positive Selection Request Statuses
Status Name | Description |
---|---|
NotExist | The requestId of the file uploaded is not found. The requestId may be incorrect or the positive selection report data has been removed. The TTL for final statuses - Sanitization finished (Done, Blocked) is 3 minutes. After this period, if the end user sends a "GET status" request, the response received will be NotExist. Note: This status is not relevant for the sync-upload API. |
Processing | The file you uploaded is being processed by Votiro Cloud. Note: This status is not relevant for the sync-upload API. |
Done | The file you uploaded is processed, and you can download the file. |
Error | The file you uploaded was not processed because of an internal Votiro error. |
Blocked | The file you uploaded was blocked in the positive selection process. Download the file for more information on why the file was blocked. |
Response Example
"Done"
Comments
0 comments
Please sign in to leave a comment.