/jobs

POST /jobs 1003 (ready) Create a job
This request requires authentication headers to be set. See HTTP Headers below.

Create a job under an authenticated and authorized user.

There 2 options to upload images into a job:

  • FTP: you can upload images via ftp to URL sepcified in upload.ftpUrl using account credentials
  • POST: you can post files with multipart/form-data content type to URL specified in upload.postUrl

Example:

{
	name: "Job of fruits",
	invoiceReference: "Pay after all fruits are eaten",
	description: "Cleap fruits from background",
	tags: [
		"Apple",
		"Banana",
		"Cucumber"
	],
	isTest: true
}
The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

Request body Parameters

Name Type Required Default value Description Example(s)
name string true Name of the job 'Job of fruits'
description string true Description of this job 'Cleap fruits from background'
tags string false List of tags ['Apple', 'Banana', 'Cucumber']
invoiceReference string false Provide invoice reference if any 'Pay after all fruits are eaten'
isTest boolean false Indicate whether job is for testing true

Example response

{
	"id": 353413,
	"name": "Job of fruits",
	"description": "Cleap fruits from background",
	"tags": [
		"Apple",
		"Banana",
		"Cucumber"
	],
	"invoiceReference": "Pay after all fruits are eaten",
	"isTest": true,
	"upload": {
		"ftpUrl": "ftp://dev-storage01.misterclipping.com/20160513/353413/ORIGINAL/",
		"postUrl": "http://local-storage01.misterclipping.com/upload/UploadFile.ashx?jobID=353413&accountID=61731b19-5110-45d7-a321-b08373cf88a4"
	},
	"download": {
		"ftpUrl": "ftp://dev-storage01.misterclipping.com/20160513/353413/CLIPPED/",
		"getUrl": "http://local-storage01.misterclipping.com/ajax/DownloadZip.ashx?centraljobid=353413&sessionID=61731b19-5110-45d7-a321-b08373cf88a4"
	},
	"_type": "CreateJobResponseBody"
}

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}
missing_parameter A required parameter was not supplied
{
  "code": "missing_parameter",
  "message": "A required parameter was not supplied.",
  "parameterName": "email"
}
invalid_parameter A parameter was not in the right format
{
  "code": "invalid_parameter",
  "message": "A parameter was not in the right format.",
  "parameterName": "email",
  "parameterValue": "foo@example"
}

The following custom errors can be expected. They should either be handled by the developer, or require user action:

Id Target Status Code Code Default Message Localized Messages
5 developer 400 name_required Name is required.

Status Codes

201 Created
The resource has been created
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
PUT /jobs/{id} 1037 (ready) Update a job
This request requires authentication headers to be set. See HTTP Headers below.
Update a specific job.
Example:
{
	name: 'Job of vegetables',
	invoiceReference: 'Pay after all vegetables are eaten',
	description: 'Cleap vegetables from background',
	tags: [
		'Potato',
		'Onion',
		'Pear'
	]
}
The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job 353414

Request body Parameters

Name Type Required Default value Description Example(s)
name string true The name of the job 'Job of vegetables'
description string true Description of this job 'Cleap vegetables from background'
tags string false List of tags ['Potato', 'Onion', 'Pear']
invoiceReference string false Provide invoice reference if any 'Pay after all vegetables are eaten'

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}
missing_parameter A required parameter was not supplied
{
  "code": "missing_parameter",
  "message": "A required parameter was not supplied.",
  "parameterName": "email"
}
invalid_parameter A parameter was not in the right format
{
  "code": "invalid_parameter",
  "message": "A parameter was not in the right format.",
  "parameterName": "email",
  "parameterValue": "foo@example"
}

Status Codes

204 No Content
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
GET /jobs/{id} 1000 (ready) Gets a specific job
This request requires authentication headers to be set. See HTTP Headers below.

Gets a specific job, including all file info. Only the account associated with this job is authorized to access it.

"status" can have one of the following values:

Value Meaning
CJ_ACCEPTJob accepted, ready for editing by the Mister Clipping production location
CJ_ARCHIVEDJob is archived, zip and image files are deleted from Mister Clipping storage
CJ_AUTO_ACCEPTAutoaccept - account set to auto accept job offer
CJ_CLIENT_REVIEWEDClient reviewed or is out of time
CJ_COMPLETEDJob completed, ready for downloading on storage
CJ_COMPLETED2Job completed, download reminder sent
CJ_COMPLETED3Job completed, last download reminder sent
CJ_DELETEDelete job, zip and image files are deleted from Mister Clipping storage
CJ_ERRORGeneric job error status
CJ_FETCH_ERRORFetch finished with error
CJ_FETCH_READYFetch finished, no auto request offer
CJ_FINISHEDJob finished
CJ_INIT_PUSHInitiating push job to client storage server
CJ_INIT_PUSH_ERRFailed to initiate push job at Mister Clipping storage
CJ_INIT_REJECTInitiate rejected job on Mister Clipping storage
CJ_JOB_PAIDJob has been paid online
CJ_NEED_ACCEPTANCEJob needs to be accepted by client user
CJ_NEWNewly created job
CJ_NOTIFIED_WORK_DNClient notified that job is done
CJ_NOTIFY_WORK_DONENotify client that job is done
CJ_PAID_VIA_BUCKAROOSet when online payment via Buckaroo succeeds
CJ_PART_REVIEWEDPart of job image files get rejected
CJ_PAY_INITIATEDTripledeal payment has been initiated, url received
CJ_PUSH_ERRORPush of job or image files to client storage failed
CJ_PUSH_INITPush job initiated to client storage
CJ_REJECT_DELAYDelay for client to reject done job
CJ_REJECT_ERRORRejected job on Mister Clipping storage failed to create
CJ_REJECT_INITRejected job on Mister Clipping storage initiated
CJ_REJECT_NOTIFYNotify production location when rejected job is created
CJ_REJECT_READYRejected job on Mister Clipping storage created: scan missing files
CJ_REJECT_READY2Rejected job on Mister Clipping storage created
CJ_REQUEST_OFFERJob offer has been requested, scan missing files
CJ_REQUEST_OFFER_PREJob offer has been requested, prepare for Mister Clipping production location
CJ_REQUEST_OFFER_SYNJob offer has been requested, sync files
CJ_REQUEST_OFFER_VALValidate amount of images for job
CJ_REVIEWEDJob has been reviewed by Mister Clipping: sync file info
CJ_REVIEWED2Job has been reviewed by Mister Clipping: Calculate price, Check autoaccept
CJ_REVIEWINGOffer reviewed by Mister Clipping production location
CJ_TD_PAY_CANCELEDPayment via Buckaroo cancelled
CJ_TD_PAY_CHARGEBACKPayment charge back
CJ_TD_PAY_ERRORPayment error
CJ_TD_PAY_NEWNew payment via Buckaroo
CJ_TD_PAY_PAIDPaid via Buckaroo
CJ_TD_PAY_PAYINGPayment via Buckaroo in progress
CJ_TD_PAY_PENDINGJob waiting for payment via Buckaroo
CJ_TD_PAY_TIMEOUTTimeout during payment via Buckaroo
CJ_TD_PAY_UPDATEPayment update
CJ_TRASH_CANCELLEDTrash cancelled job, remove from job overview, delete image files
CJ_USER_CANCELEDJob cancelled by client user, trash cancelled will be initiated
CJ_WAIT_ACCEPTANCEJob waits to be accepted by client user
CJ_WAIT_ACCEPTANCE2Job waits to be accepted by client user, reminder sent
CJ_WORK_DONEJob ready, images can be downloaded by client
CJ_WORK_DONE_REMINDReminder sent to client that job is done
CJ_WORK_PROGRESSJob in progress, images are being edited
CJ_ZIP_ERRORError creating ZIP file on Mister Clipping storage
CJ_ZIP_INITCreating ZIP file on Mister Clipping storage has been initiated
CJ_ZIP_READYZIP file ready
ERRORGeneral error
TIMECAROUSELDelayed status transition, status update is expected
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job

Example response

{
	"id": 353413,
	"guid": "192ddbda-edc5-41cf-8a97-a7e5fb328801",
	"status": "CJ_REVIEWING",
	"createdDate": "2016-05-13T13:30:52.363Z",
	"accountId": 23147,
	"name": "Job of fruits",
	"description": "Cleap fruits from background",
	"invoiceReference": "Pay after all fruits are eaten",
	"tags": [
		"Apple",
		"Banana",
		"Cucumber"
	],
	"fileCount": 3,
	"masterJobId": null,
	"sentDate": null,
	"acceptedDate": null,
	"orderedDate": null,
	"paidDate": null,
	"deliveredDate": null,
	"reviewedDate": null,
	"isDeleted": false,
	"operatorRemarks": null,
	"isAutoFetch": false,
	"parentJobId": null,
	"productionDate": null,
	"cancelledDate": null,
	"isTest": true,
	"upload": {
		"ftpUrl": "ftp://dev-storage01.misterclipping.com/20160513/353413/ORIGINAL/",
		"postUrl": "http://local-storage01.misterclipping.com/upload/UploadFile.ashx?jobID=353413&accountID=61731b19-5110-45d7-a321-b08373cf88a4"
	},
	"download": {
		"ftpUrl": "ftp://dev-storage01.misterclipping.com/20160513/353413/CLIPPED/",
		"getUrl": "http://local-storage01.misterclipping.com/ajax/DownloadZip.ashx?centraljobid=353413&sessionID=61731b19-5110-45d7-a321-b08373cf88a4"
	}
	"_type": "JobResponseBody"
}

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)
GET /jobs/{id}/status 1008 (ready) Get status of a job
This request requires authentication headers to be set. See HTTP Headers below.
Get status of a job. Expected results :
Value Meaning
CJ_ACCEPTJob accepted, ready for editing by the Mister Clipping production location
CJ_ARCHIVEDJob is archived, zip and image files are deleted from Mister Clipping storage
CJ_AUTO_ACCEPTAutoaccept - account set to auto accept job offer
CJ_CLIENT_REVIEWEDClient reviewed or is out of time
CJ_COMPLETEDJob completed, ready for downloading on storage
CJ_COMPLETED2Job completed, download reminder sent
CJ_COMPLETED3Job completed, last download reminder sent
CJ_DELETEDelete job, zip and image files are deleted from Mister Clipping storage
CJ_ERRORGeneric job error status
CJ_FETCH_ERRORFetch finished with error
CJ_FETCH_READYFetch finished, no auto request offer
CJ_FINISHEDJob finished
CJ_INIT_PUSHInitiating push job to client storage server
CJ_INIT_PUSH_ERRFailed to initiate push job at Mister Clipping storage
CJ_INIT_REJECTInitiate rejected job on Mister Clipping storage
CJ_JOB_PAIDJob has been paid online
CJ_NEED_ACCEPTANCEJob needs to be accepted by client user
CJ_NEWNewly created job
CJ_NOTIFIED_WORK_DNClient notified that job is done
CJ_NOTIFY_WORK_DONENotify client that job is done
CJ_PAID_VIA_BUCKAROOSet when online payment via Buckaroo succeeds
CJ_PART_REVIEWEDPart of job image files get rejected
CJ_PAY_INITIATEDTripledeal payment has been initiated, url received
CJ_PUSH_ERRORPush of job or image files to client storage failed
CJ_PUSH_INITPush job initiated to client storage
CJ_REJECT_DELAYDelay for client to reject done job
CJ_REJECT_ERRORRejected job on Mister Clipping storage failed to create
CJ_REJECT_INITRejected job on Mister Clipping storage initiated
CJ_REJECT_NOTIFYNotify production location when rejected job is created
CJ_REJECT_READYRejected job on Mister Clipping storage created: scan missing files
CJ_REJECT_READY2Rejected job on Mister Clipping storage created
CJ_REQUEST_OFFERJob offer has been requested, scan missing files
CJ_REQUEST_OFFER_PREJob offer has been requested, prepare for Mister Clipping production location
CJ_REQUEST_OFFER_SYNJob offer has been requested, sync files
CJ_REQUEST_OFFER_VALValidate amount of images for job
CJ_REVIEWEDJob has been reviewed by Mister Clipping: sync file info
CJ_REVIEWED2Job has been reviewed by Mister Clipping: Calculate price, Check autoaccept
CJ_REVIEWINGOffer reviewed by Mister Clipping production location
CJ_TD_PAY_CANCELEDPayment via Buckaroo cancelled
CJ_TD_PAY_CHARGEBACKPayment charge back
CJ_TD_PAY_ERRORPayment error
CJ_TD_PAY_NEWNew payment via Buckaroo
CJ_TD_PAY_PAIDPaid via Buckaroo
CJ_TD_PAY_PAYINGPayment via Buckaroo in progress
CJ_TD_PAY_PENDINGJob waiting for payment via Buckaroo
CJ_TD_PAY_TIMEOUTTimeout during payment via Buckaroo
CJ_TD_PAY_UPDATEPayment update
CJ_TRASH_CANCELLEDTrash cancelled job, remove from job overview, delete image files
CJ_USER_CANCELEDJob cancelled by client user, trash cancelled will be initiated
CJ_WAIT_ACCEPTANCEJob waits to be accepted by client user
CJ_WAIT_ACCEPTANCE2Job waits to be accepted by client user, reminder sent
CJ_WORK_DONEJob ready, images can be downloaded by client
CJ_WORK_DONE_REMINDReminder sent to client that job is done
CJ_WORK_PROGRESSJob in progress, images are being edited
CJ_ZIP_ERRORError creating ZIP file on Mister Clipping storage
CJ_ZIP_INITCreating ZIP file on Mister Clipping storage has been initiated
CJ_ZIP_READYZIP file ready
ERRORGeneral error
TIMECAROUSELDelayed status transition, status update is expected
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job

Example response

{
	"status": "CJ_NEW"
}

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)
GET /jobs/{id}/files 1074 (ready) Get list of files
This request requires authentication headers to be set. See HTTP Headers below.
Get list of files
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job 353414

Example response

{{
	"files": [{
		"id": 217667,
		"fileName": "koala.jpg",
		"isOriginal": true,
		"size": 6398,
		"complexityId": 15,
		"mD5": "D4-1D-8C-D9-8F-00-B2-04-E9-80-09-98-EC-F8-42-7E",
		"status": "THUMB_OK",
		"remarkToProcessor": null,
		"remarkFromProcessor": null,
		"isRejected": true,
		"rejectionReason": "Rejected by 2 reasons:\ntest_rejection_type_10\ntest_rejection_type_11",
		"reviewDate": "2016-06-14T13:33:25.76Z",
		"isReviewed": true,
		"reviews": {
			"fileId": 217667,
			"rejects": [{
				"imageId": 217671,
				"rejects": [{
					"positions": [{
						"xPercent": 0.24222222222222223,
						"yPercent": 0.2869822485207101
					},
					{
						"xPercent": 0.6088888888888889,
						"yPercent": 0.17455621301775148
					}],
					"reason": "test_rejection_type_10"
				},
				{
					"positions": [],
					"reason": "test_rejection_type_11"
				}]
			}]
		},
		"previousReviews": null,
		"tags": [],
		"createdDate": "2016-06-08T21:15:51.1Z",
		"downloadUrl": "https://dev-storage01.misterclipping.com/ajax/DownloadBin.ashx?fileID=217667&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e",
		"original": {
			"imageId": 217667,
			"preview": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217667&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=original&ispreview=true",
			"thumbnail": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217667&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=original&ispreview=false",
			"real": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217667&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=original&ispreview=original"
		},
		"clipped": [{
			"imageId": 217671,
			"preview": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217671&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=clipped&ispreview=true",
			"thumbnail": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217671&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=clipped&ispreview=false",
			"real": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217671&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=clipped&ispreview=original"
		}]
	},
	{
		"id": 217668,
		"fileName": "lighthouse.jpg",
		"isOriginal": true,
		"size": 568129,
		"complexityId": 15,
		"mD5": "D4-1D-8C-D9-8F-00-B2-04-E9-80-09-98-EC-F8-42-7E",
		"status": "THUMB_OK",
		"remarkToProcessor": null,
		"remarkFromProcessor": null,
		"isRejected": true,
		"rejectionReason": "Rejected by 1 reasons:\ntest_rejection_type_10",
		"reviewDate": "2016-06-14T12:53:17.317Z",
		"isReviewed": true,
		"reviews": {
			"fileId": 217668,
			"rejects": [{
				"imageId": 217672,
				"rejects": [{
					"positions": [{
						"xPercent": 0.6444444444444445,
						"yPercent": 0.21301775147928995
					},
					{
						"xPercent": 0.7822222222222223,
						"yPercent": 0.363905325443787
					},
					{
						"xPercent": 0.8622222222222222,
						"yPercent": 0.14497041420118342
					}],
					"reason": "test_rejection_type_10"
				}]
			}]
		},
		"previousReviews": null,
		"tags": [],
		"createdDate": "2016-06-08T21:15:52.347Z",
		"downloadUrl": "https://dev-storage01.misterclipping.com/ajax/DownloadBin.ashx?fileID=217668&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e",
		"original": {
			"imageId": 217668,
			"preview": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217668&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=original&ispreview=true",
			"thumbnail": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217668&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=original&ispreview=false",
			"real": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217668&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=original&ispreview=original"
		},
		"clipped": [{
			"imageId": 217672,
			"preview": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217672&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=clipped&ispreview=true",
			"thumbnail": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217672&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=clipped&ispreview=false",
			"real": "https://dev-storage01.misterclipping.com/ajax/getimage.ashx?fileID=217672&sessionid=b0283fdc-a60c-4ee9-90d7-e953d7826f8e&type=clipped&ispreview=original"
		}]
	}]
}}

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)
PUT /jobs/{id}/files/{fileName} 1045 (ready) Update the file properties.
This request requires authentication headers to be set. See HTTP Headers below.
Update the file properties such as description, remarks, and tags under a job.
Example
{"name":"Chrysanthemum.jpg","remark":"add sun rays in the background", "tags":["flower"]}
The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job
fileName string true The name of the file

Example response


              

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}

The following custom errors can be expected. They should either be handled by the developer, or require user action:

Id Target Status Code Code Default Message Localized Messages
6 developer 400 no_files_to_update File is not found or request is incorrect.

Status Codes

204 No Content
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
GET /jobs/{id}/files/{fileName} 1034 (ready) Gets metadata for a specific file
This request requires authentication headers to be set. See HTTP Headers below.
Update the file properties such as description, remarks, and tags under a job.
Example
{
	"name": "Chrysanthemum.jpg",
	"description": "pretty flower",
	"remark": "add sun rays in the background",
	"tags": "flower"
}
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job
fileName string true The name of the file

Example response

{
	"id": 216359,
	"fileName": "157863 - Copy.jpg",
	"isOriginal": true,
	"size": 2302847,
	"complexityId": 1,
	"mD5": "77-76-80-50-DC-BE-6D-95-12-4F-71-FE-25-6D-6A-97",
	"status": "THUMB_OK",
	"remarkToProcessor": null,
	"remarkFromProcessor": null,
	"isRejected": false,
	"rejectionReason": null,
	"tags": [],
	"createdDate": "2016-05-16T12:01:07.39Z",
	"downloadUrl": "http://local-storage01.misterclipping.com/ajax/DownloadBin.ashx?fileID=216359&sessionid=ff7d9804-0f27-49e3-a48a-c9730565151a"
}

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)
GET /jobs/{id}/filesextended/{fileId} 1112 (ready) Gets data for a specific file including the metadata
This request requires authentication headers to be set. See HTTP Headers below.
Gets data for a specific file including the metadata
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job 353458
fileId integer true The id of the file 165501

Example response

{
	"id": 216359,
	"fileName": "157863 - Copy.jpg",
	"isOriginal": true,
	"size": 2302847,
	"complexityId": 1,
	"mD5": "77-76-80-50-DC-BE-6D-95-12-4F-71-FE-25-6D-6A-97",
	"status": "THUMB_OK",
	"remarkToProcessor": null,
	"remarkFromProcessor": null,
	"isRejected": false,
	"rejectionReason": null,
	"tags": [],
	"createdDate": "2016-05-16T12:01:07.39Z",
	"downloadUrl": "http://local-storage01.misterclipping.com/ajax/DownloadBin.ashx?fileID=216359&sessionid=ff7d9804-0f27-49e3-a48a-c9730565151a"
}

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)
POST /jobs/{id}/requestoffer 1041 (ready) Request an offer for a job
This request requires authentication headers to be set. See HTTP Headers below.
Request an offer for a job.
Example:
{
	"files": [{
		"fileName": "WP_20130825_202.jpg",
		"remark": "Cleap the image from background",
		"tags": ["foo", "bar"]
	},
	{
		"fileName": "WP_20130825_143.jpg",
		"remark": "Clean the image from background",
		"tags": ["foor", "bar"]
	}]
}
The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job

Request body Parameters

Name Type Required Default value Description Example(s)
files string false List of files remarks [{ "fileName": "image1.jpg", "remark": "Image Remarks", "tags": [ "tag1" , "tag2" ] }, { "fileName": "image2.jpg", "remark": "Image Remarks", "tags": [ "tag3", "tag4" ] }]

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}

Status Codes

204 No Content
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
POST /jobs/{id}/acceptoffer 1043 (ready) Accept the offer for a job
This request requires authentication headers to be set. See HTTP Headers below.
Accept the offer for a job.
The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}

Status Codes

204 No Content
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
POST /jobs/{id}/cancel 1004 (ready) Cancels a job
This request requires authentication headers to be set. See HTTP Headers below.

Cancels a job by changing its status to CJ_USER_CANCELED.

Only jobs with the following status can be cancelled:

  • CJ_WAIT_ACCEPTANCE2
  • CJ_NEW
  • CJ_WAIT_ACCEPTANCE
  • CJ_TD_PAY_TIMEOUT
  • CJ_TD_PAY_ERROR
  • CJ_PAY_INITIATED
  • CJ_TD_PAY_CANCELED

If the status is not one of the above, 400 Bad Request is returned.

The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}

Status Codes

204 No Content
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
GET /jobs/{id}/filesforreview 1081 (ready) Get list of files for review
This request requires authentication headers to be set. See HTTP Headers below.
Get list of files for review. If Job references original Job, urls ot clipped files would be replaced with Clipped files of original job until Processor will not upload new Clipped images to current Job
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job 353414

Example response

{
    "files": [
        {
            "id": 3325324,
            "fileName": "cem_test15.jpg",
            "isOriginal": true,
            "isExtraClipped": false,
            "size": 5302251,
            "complexityId": 5,
            "mD5": "D4-1D-8C-D9-8F-00-B2-04-E9-80-09-98-EC-F8-42-7E",
            "status": "THUMB_OK",
            "remarkToProcessor": null,
            "remarkFromProcessor": null,
            "isRejected": true,
            "acceptedByUser": false,
            "rejectionReason": " - Cropping",
            "reviewDate": "2018-05-17T09:24:50.27Z",
            "isReviewed": true,
            "partIsReviewed": true,
            "additionalComplexityID": null,
            "reviews": {
                "id": 3325324,
                "fileId": 3325324,
                "rejects": [
                    {
                        "imageId": 3325329,
                        "customRejection": "",
                        "rejects": [
                            {
                                "positions": [
                                    {
                                        "xPercent": 0.60599498056994816,
                                        "yPercent": 0.43625498007968128
                                    }
                                ],
                                "reason": "Cropping"
                            }
                        ]
                    }
                ]
            },
            "previousReviews": null,
            "tags": [],
            "createdDate": "2018-05-17T09:15:22.733Z",
            "downloadUrl": "https://acc2-storage02.bright-river.com/ajax/DownloadBin.ashx?fileID=3325324&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975",
            "original": {
                "imageId": 3325324,
                "fileName": "cem_test15.jpg",
                "preview": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325324&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=original&ispreview=true",
                "thumbnail": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325324&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=original&ispreview=false",
                "real": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325324&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=original&ispreview=original",
                "downloadUrl": "https://acc2-storage02.bright-river.com/ajax/DownloadBin.ashx?fileID=3325324&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975",
                "additionalComplexityID": null
            },
            "clipped": [
                {
                    "imageId": 3325329,
                    "fileName": "cem_test15.jpg",
                    "preview": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325329&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=clipped&ispreview=true",
                    "thumbnail": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325329&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=clipped&ispreview=false",
                    "real": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325329&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=clipped&ispreview=original",
                    "downloadUrl": "https://acc2-storage02.bright-river.com/ajax/DownloadBin.ashx?fileID=3325329&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975",
                    "additionalComplexityID": null
                }
            ],
            "previousClipped": null,
            "timesRejected": 1
        },
        {
            "id": 3325325,
            "fileName": "cem_test16.jpg",
            "isOriginal": true,
            "isExtraClipped": false,
            "size": 5302251,
            "complexityId": 5,
            "mD5": "D4-1D-8C-D9-8F-00-B2-04-E9-80-09-98-EC-F8-42-7E",
            "status": "THUMB_OK",
            "remarkToProcessor": null,
            "remarkFromProcessor": null,
            "isRejected": false,
            "acceptedByUser": null,
            "rejectionReason": null,
            "reviewDate": null,
            "isReviewed": false,
            "partIsReviewed": false,
            "additionalComplexityID": null,
            "reviews": null,
            "previousReviews": null,
            "tags": [],
            "createdDate": "2018-05-17T09:15:23.87Z",
            "downloadUrl": "https://acc2-storage02.bright-river.com/ajax/DownloadBin.ashx?fileID=3325325&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975",
            "original": {
                "imageId": 3325325,
                "fileName": "cem_test16.jpg",
                "preview": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325325&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=original&ispreview=true",
                "thumbnail": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325325&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=original&ispreview=false",
                "real": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325325&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=original&ispreview=original",
                "downloadUrl": "https://acc2-storage02.bright-river.com/ajax/DownloadBin.ashx?fileID=3325325&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975",
                "additionalComplexityID": null
            },
            "clipped": null,
            "previousClipped": null,
            "timesRejected": 1
        },
        {
            "id": 3325327,
            "fileName": "extra cem_test15.jpg",
            "isOriginal": false,
            "isExtraClipped": true,
            "size": 5302251,
            "complexityId": null,
            "mD5": "D4-1D-8C-D9-8F-00-B2-04-E9-80-09-98-EC-F8-42-7E",
            "status": "THUMB_OK",
            "remarkToProcessor": null,
            "remarkFromProcessor": null,
            "isRejected": true,
            "acceptedByUser": false,
            "rejectionReason": " - Color profiles",
            "reviewDate": "2018-05-17T09:24:45.757Z",
            "isReviewed": true,
            "partIsReviewed": false,
            "additionalComplexityID": null,
            "reviews": {
                "id": 0,
                "fileId": 3325327,
                "rejects": [
                    {
                        "imageId": 3325327,
                        "customRejection": "",
                        "rejects": [
                            {
                                "positions": [
                                    {
                                        "xPercent": 0.42982917746113991,
                                        "yPercent": 0.61354581673306774
                                    }
                                ],
                                "reason": "Color profiles"
                            }
                        ]
                    }
                ]
            },
            "previousReviews": null,
            "tags": [],
            "createdDate": "2018-05-17T09:18:30.67Z",
            "downloadUrl": null,
            "original": {
                "imageId": 3325327,
                "fileName": null,
                "preview": "",
                "thumbnail": "",
                "real": "",
                "downloadUrl": "",
                "additionalComplexityID": null
            },
            "clipped": [
                {
                    "imageId": 3325327,
                    "fileName": "extra cem_test15.jpg",
                    "preview": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325327&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=clipped&ispreview=true",
                    "thumbnail": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325327&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=clipped&ispreview=false",
                    "real": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325327&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=clipped&ispreview=original",
                    "downloadUrl": "https://acc2-storage02.bright-river.com/ajax/DownloadBin.ashx?fileID=3325327&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975",
                    "additionalComplexityID": null
                }
            ],
            "previousClipped": null,
            "timesRejected": 0
        },
        {
            "id": 3325328,
            "fileName": "extra cem_test16.jpg",
            "isOriginal": false,
            "isExtraClipped": true,
            "size": 5302251,
            "complexityId": null,
            "mD5": "D4-1D-8C-D9-8F-00-B2-04-E9-80-09-98-EC-F8-42-7E",
            "status": "THUMB_OK",
            "remarkToProcessor": null,
            "remarkFromProcessor": null,
            "isRejected": true,
            "acceptedByUser": false,
            "rejectionReason": " - Clipping path\n - Hair mask",
            "reviewDate": "2018-05-17T09:20:17.1Z",
            "isReviewed": true,
            "partIsReviewed": false,
            "additionalComplexityID": null,
            "reviews": {
                "id": 0,
                "fileId": 3325328,
                "rejects": [
                    {
                        "imageId": 3325328,
                        "customRejection": "",
                        "rejects": [
                            {
                                "positions": [
                                    {
                                        "xPercent": 0.42464783031088082,
                                        "yPercent": 0.50199203187251
                                    }
                                ],
                                "reason": "Clipping path"
                            },
                            {
                                "positions": [
                                    {
                                        "xPercent": 0.72257529145077726,
                                        "yPercent": 0.57768924302788849
                                    }
                                ],
                                "reason": "Hair mask"
                            }
                        ]
                    }
                ]
            },
            "previousReviews": null,
            "tags": [],
            "createdDate": "2018-05-17T09:18:32.48Z",
            "downloadUrl": null,
            "original": {
                "imageId": 3325328,
                "fileName": null,
                "preview": "",
                "thumbnail": "",
                "real": "",
                "downloadUrl": "",
                "additionalComplexityID": null
            },
            "clipped": [
                {
                    "imageId": 3325328,
                    "fileName": "extra cem_test16.jpg",
                    "preview": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325328&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=clipped&ispreview=true",
                    "thumbnail": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325328&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=clipped&ispreview=false",
                    "real": "https://acc2-storage02.bright-river.com/ajax/getimage.ashx?fileID=3325328&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975&type=clipped&ispreview=original",
                    "downloadUrl": "https://acc2-storage02.bright-river.com/ajax/DownloadBin.ashx?fileID=3325328&sessionid=f4331aef-c105-4b6e-bf62-eb787014f975",
                    "additionalComplexityID": null
                }
            ],
            "previousClipped": null,
            "timesRejected": 0
        }
    ]
}

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)
POST /jobs/{id}/accept 1113 (ready) Accept all the files of a job
This request requires authentication headers to be set. See HTTP Headers below.

Accept all the files of a job

Example body:

{
  "acceptedByUser": true
}
The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job 353458

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}

Status Codes

200 OK
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
POST /jobs/{id}/files/{fileId}/accept 1107 (ready) Accept file
This request requires authentication headers to be set. See HTTP Headers below.

Accept the processed file

The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
fileId integer true The id of the file 165501
id integer true The id of the job 353458

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}

Status Codes

200 OK
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
POST /jobs/{id}/review 1085 (ready) Review all files at the same time
This request requires authentication headers to be set. See HTTP Headers below.

Review all files at the same time

Example:

{
  "reviews": [
    {
      "reason": "string"
    }
  ]
}
The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job 353414

Request body Parameters

Name Type Required Default value Description Example(s)
reviews string true List of reviews See the description.

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}
missing_parameter A required parameter was not supplied
{
  "code": "missing_parameter",
  "message": "A required parameter was not supplied.",
  "parameterName": "email"
}
invalid_parameter A parameter was not in the right format
{
  "code": "invalid_parameter",
  "message": "A parameter was not in the right format.",
  "parameterName": "email",
  "parameterValue": "foo@example"
}

Status Codes

200 OK
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
POST /jobs/{id}/files/review 1080 (ready) Review files
This request requires authentication headers to be set. See HTTP Headers below.

Review files

Example:

{
   "reviews":[  
      {  
         "fileId":246016,
         "rejects":[  
            {  
               "imageId":246021,
               "customRejection":"makes shadows brighter",
               "rejects":[  
                  {  
                     "reason":"File format",
                     "positions":[  
                        {  
                           "xPercent":0.3323308270676692,
                           "yPercent":0.45958429561200925
                        }
                     ]
                  },
                  {  
                     "reason":"Cropping",
                     "positions":[  
                        {  
                           "xPercent":0.518796992481203,
                           "yPercent":0.39260969976905313
                        }
                     ]
                  }
               ]
            }
         ]
      }
   ]
}

fileId: the id of the original image (Use GET /jobs/{id}/files to get this info)

imageId:the id of the clipped image being rejected(Use GET /jobs/{id}/files to get this info)

reason: is a standard rejection reason provide from (GET /accounts/me/rejecttypes)

customRejection: is a free text that you can provide and is not covered by the MRC standard rejections reasons.

with x,y (0,0) being the top left pixel of the image

yPercent: is the percentage from the top

xPercent: is the percentage from the left

The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job 353415

Request body Parameters

Name Type Required Default value Description Example(s)
reviews string true List of reviews for files See the description.

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}
missing_parameter A required parameter was not supplied
{
  "code": "missing_parameter",
  "message": "A required parameter was not supplied.",
  "parameterName": "email"
}
invalid_parameter A parameter was not in the right format
{
  "code": "invalid_parameter",
  "message": "A parameter was not in the right format.",
  "parameterName": "email",
  "parameterValue": "foo@example"
}

Status Codes

200 OK
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
POST /jobs/{id}/files/{fileId}/review 1076 (ready) Review file
This request requires authentication headers to be set. See HTTP Headers below.

Update file review information.

Example:

{  
   "acceptedByUser": "false",
   "reviews":[  
      {  
         "fileId":246016,
         "rejects":[  
            {  
               "imageId":246021,
               "customRejection":"makes shadows brighter",
               "rejects":[  
                  {  
                     "reason":"File format",
                     "positions":[  
                        {  
                           "xPercent":0.3323308270676692,
                           "yPercent":0.45958429561200925
                        }
                     ]
                  },
                  {  
                     "reason":"Cropping",
                     "positions":[  
                        {  
                           "xPercent":0.518796992481203,
                           "yPercent":0.39260969976905313
                        }
                     ]
                  }
               ]
            }
         ]
      }
   ]
}

fileId: the id of the original image. If clipped image is not matched with an original image, then clipped image id could be used. (Use GET /jobs/{id}/files to get this info)

imageId:the id of the clipped image being rejected(Use GET /jobs/{id}/files to get this info)

reason: is a standard rejection reason provide from (GET /accounts/me/rejecttypes)

customRejection: is a free text that you can provide and is not covered by the Bright River standard rejections reasons.

with x,y (0,0) being the top left pixel of the image

yPercent: is the percentage from the top

xPercent: is the percentage from the left

The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job 353414
fileId integer true The id of the file 165501

Request body Parameters

Name Type Required Default value Description Example(s)
acceptedByUser boolean true whether the file is accepted or not (rejected) false
reviews string true List of reviews See the description.

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}
missing_parameter A required parameter was not supplied
{
  "code": "missing_parameter",
  "message": "A required parameter was not supplied.",
  "parameterName": "email"
}
invalid_parameter A parameter was not in the right format
{
  "code": "invalid_parameter",
  "message": "A parameter was not in the right format.",
  "parameterName": "email",
  "parameterValue": "foo@example"
}

Status Codes

200 OK
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
PUT /jobs/{id}/files/{fileName}/rejectionreasons 1068 (ready) Update the file rejection reasons
This request requires authentication headers to be set. See HTTP Headers below.

Update the file rejection reasons.

Example:

{
  "rejections": [
    {
      "rejectTypeId": 6,
      "instruction": {
        "shape": "Circle",
        "coordinates": {"x":12.34,"y":56.78,"r":5}
      },
      "remark": "wrong shadow color, change to light grey"
    },
    {
      "rejectTypeId": 6,
      "instruction": {
        "shape": "Circle",
        "coordinates": {"x":152.34,"y":156.78,"r":3}
      },
      "remark": "wrong shadow color,make it dark grey"
    }
  ],
  "generalRemark": "Wrong shadow colors applied"
}
The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job
fileName string true The name of the file which reason will be updated

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}

Status Codes

204 No Content
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
POST /jobs/{id}/close 1005 (ready) Closes a job
This request requires authentication headers to be set. See HTTP Headers below.

Closes a job by changing its status to CJ_CLIENT_REVIEWED.

The following values for Content-Type are accepted: application/x-www-form-urlencoded, application/json.
When Content-Type is any other value, 415 Unsupported Media Type is returned.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job

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"
}
invalid_json The request body could not be parsed.
{
  "code": "invalid_json",
  "message": "The request body could not be parsed."
}

Status Codes

204 No Content
The resource has been updated
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
411 Length Required
The request did not specify the length of its content, which is required by the requested resource
415 Unsupported Media Type
The Content-Type of the request is not supported. Supported are 'application/x-www-form-urlencoded' and 'application/json'
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)
GET /jobs/{id}/rejectedjobs 1013 (ready) Get rejected jobs
This request requires authentication headers to be set. See HTTP Headers below.
Get rejected jobs that have this id as their parent id.
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job

Example response

{"rejectedJobs":[
				{"id":345035,
				"createdDate":"2015-08-25T17:25:57.69",
				"name":"Rejected pictures of job #345033",
				"description":null}
				,
				{"id":345036,
				"createdDate":"2015-08-25T17:28:19.533",
				"name":"Rejected pictures of job #345033","description":null}
				,
				{"id":345037,
				"createdDate":"2015-08-25T17:29:52.69",
				"name":"Rejected pictures of job #345033",
				"description":null}
				,
				{"id":345038,
				"createdDate":"2015-08-25T17:41:58.48",
				"name":"Rejected pictures of job #345033",
				"description":null
				],
				"_type":"GetRejectedJobsResponseBody"
}

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)
GET /jobs/{id}/rejectedfilescount 1082 (ready) Get rejected files count
This request requires authentication headers to be set. See HTTP Headers below.
Get rejected files count
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

URL Parameters

Name Type Required Description Example(s)
id integer true The id of the job 353414

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)