This request requires authentication headers to be set. See HTTP Headers below.
Get job statuses with descriptions translated to Account language
The response of this request has a Content-Type
of application/json
.
Any request should supply an Accept
header explicitly accepting this Content-Type, e.g. Accept: application/json
.
When an Accept
header is missing, or it has another value, 406 Not Acceptable
is returned.
HTTP Headers
Name |
Type |
Required |
Default value |
Description |
X-Client-Token |
string |
true |
|
The token identifying the client of the API |
X-Session-Token |
string |
true |
|
The token identifying the session of the current user |
Example response
{
"statuses": [
{
"code": "CJ_ARCHIVED",
"name": "Job is completed"
},
{
"code": "CJ_FINISHED",
"name": "Job is completed"
},
{
"code": "CJ_JOB_PAID",
"name": "Work is in progress"
},
{
"code": "CJ_PREPROCESS",
"name": "Work is in progress"
},
{
"code": "CJ_REJECT_ERROR",
"name": "Rejected jobs"
},
{
"code": "CJ_REJECT_READY",
"name": "Rejected jobs"
},
{
"code": "CJ_REVIEWING",
"name": "Job is being reviewed"
},
{
"code": "CJ_WORK_PROGRESS",
"name": "Work is in progress"
}
]
}
Errors
The following 400 Bad Request
errors can be expected, and should be handled by the developer:
Code |
Message |
Example |
missing_header |
A required header was not supplied |
{
"code": "missing_header",
"message": "A required header was not supplied.",
"headerName": "X-Client-Token"
}
|
Status Codes
200 OK
- The resource was found
400 Bad Request
- The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications
401 Unauthorized
- The request requires user authentication
403 Forbidden
- The client has no permission to access the resource
404 Not Found
- The resource was not found
406 Not Acceptable
- The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request
408 Request Timeout
- The request timed out
410 Gone
- The requested resource is no longer available and will not be available again
500 Internal Server Error
- The server encountered an unexpected condition which prevented it from fulfilling the request
503 Service Unavailable
- The server is currently unavailable (because it is overloaded or down for maintenance)