Possible responses to a request

All API requests return a status code and an object that provides information about the success or possible errors, such as missing information or permissions.

Possible status codes

Status code	Description	Object
200 OK	The request has succeeded.	QueryVO
201 Created	The request was successful and a new object was created.	ResultVO
202 Accepted	The request was successful but has not yet been completed. This may be the case if the request triggers a process, such as changing a configuration, which takes up to 7 minutes to be implemented.	ResultVO
400 Bad Request	The request was unsuccessful. The request was invalid or information is missing.	ViolationVO
401 Unauthorized	The request was unsuccessful because the request authentication was incorrect.	ViolationVO
403 Forbidden	The request was unsuccessful because the account used does not have the necessary permissions.	ViolationVO

Objects used

Name	Definition
QueryVO	An object QueryVO is returned when a list of objects is received from a GET request.
ResultVO	For successful POST, PUT, and DELETE requests, an object ResultVO is returned.
ViolationVO	In the case of invalid requests, an object ViolationVO is returned.