Share:

TestBench CS Online Help 2.7

HTTP Response Codes

Advanced » Rest API » HTTP Response Codes

The TestBench REST API uses several HTTP response codes. On this page, you can find their usage and intensions in the TestBench context.

2xx Success

Code	Name	Explanation
200	OK	The request has been successfully processed.
201	Created	By processing this request, a new resource has been created.
202	Accepted	The request has been accepted for processing, but the processing has not been completed.
204	No Content	The request has been successfully processed, but there is no information to send back.

4xx Client Induced Errors

Code	Name	Explanation
400	Bad Request	The server could not parse the request due to syntactic errors such as misspelled words or wrong formats.
401	Unauthorized	You tried to log in without valid user credentials. Each REST API method that uses permissions will attempt a login.
403	Forbidden	You have insufficient permissions to run this action.
404	Not Found	The resource you are looking for could not be found. Either the element you are looking for could not be found, or the URI you requested is invalid.
409	Conflict	An essential condition to fulfill the given request is not met.
413	Entity Too Large	You tried to send a request body that is larger than the server is configured to allow. This may occur by sending a too large entity (e.g., an too big image).
415	Unsupported Media Type	You are using another media type than application/vnd.testbench+json.
422	Unprocessable Entity	Despite correct syntax, the request contains some semantically wrong values. That may occur by linking to non-existent IDs or using a list of values instead of a single value.

5xx Server Errors

Code	Name	Explanation
500	Internal Error	The server got into an unexpected state and could not process the request.

Response Model for a failure

Model	Example	Explanation
Failure { failureType (string) }	{ "failureType": "NotFound" }	This is the structure of the response model.