Balluff BVS ID-M1280 F1 Series, Configuration Manual

Page: 224 / 316

BVS ID-M1280xF1-xx-xxx
66 english
As for the request responses, the defined return codes for the API are:
Status Code Description
200 OK GET: The request was successful; the resource is returned as JSON.
204 OK POST: The request was successful; the return value in HTTP header only, resource is not returned.
400 Bad Request A required attribute or argument of the API request is missing or invalid.
403 Forbidden Access is (temporarily) forbidden, e.g. some parameters are locked.
404 Not Found A resource could not be accessed; e.g. an ID for a resource could not be found.
405 Method not allowed POST: wrong method or syntax error in URL
429 Too many requests Rate limited due to excessive request frequency.
500 Internal Server Error An internal server error occurred, i.e. with incompatibilities in TLS encryption
The following product specific codes describes the error in detail .
Status Code Description
1202 JSON data value invalid, password length is less than 12 or greater than 64.
1207 JSON data set incomplete (empty username)
1403 invalid credentials
1404 user not activated
1405 invalid username
1410 user already logged in
1411 other " expert " logged in
A detailed description of every code and request can be found in the YAML file. This file is located on the
camera using the following URL
http://HOSTNAME/api/balluff/v1/apidocs . The YAML file can be visualized via a
swagger editor e.g. https://swagger.io/tools/swagger-editor/ .