Error handling
Stay organized with collections
Save and categorize content based on your preferences.
Use the 400 Bad Request status code for all errors defined in this specification. For all other errors, manufacturers should use errors in the 4XX range for client errors, and the 5XX range for server errors. The response should always include a JSON body in the following format for all error cases:
{
"name": "camera.info",
"state": "error",
"error": {
"code": "serverError",
"message": "cannot get camera info."
}
}
name can be any of camera.info, camera.state, camera.checkForUpdates,
camera.commands.status, and camera.commandName.code should be one of the following for 400 status code:unknownCommand,
cameraInExclusiveUse, missingParameter, invalidParameterName, or
invalidParameterValue.message is defined by manufacturers and is not expected to be a localized
message.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eAlways use the \u003ccode\u003e400 Bad Request\u003c/code\u003e status code for errors defined in the specification and appropriate 4XX or 5XX codes for other client or server errors, respectively.\u003c/p\u003e\n"],["\u003cp\u003eAll error responses must include a JSON body with \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003estate\u003c/code\u003e, and an \u003ccode\u003eerror\u003c/code\u003e object containing \u003ccode\u003ecode\u003c/code\u003e and \u003ccode\u003emessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eerror.code\u003c/code\u003e field uses predefined values for 400 errors (\u003ccode\u003eunknownCommand\u003c/code\u003e, \u003ccode\u003ecameraInExclusiveUse\u003c/code\u003e, \u003ccode\u003emissingParameter\u003c/code\u003e, \u003ccode\u003einvalidParameterName\u003c/code\u003e, \u003ccode\u003einvalidParameterValue\u003c/code\u003e) while manufacturers define the \u003ccode\u003eerror.message\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ename\u003c/code\u003e field identifies the specific request, such as \u003ccode\u003ecamera.info\u003c/code\u003e or \u003ccode\u003ecamera.commands.status\u003c/code\u003e, associated with the error.\u003c/p\u003e\n"]]],["Error responses must include a JSON body with \"name,\" \"state,\" and \"error\" fields. For specified errors, use the `400 Bad Request` status code, otherwise, employ 4XX for client and 5XX for server errors. The \"name\" field can be one of several camera-related identifiers. \"Code\" within the error object must be one of five predefined error codes for 400 responses. The \"message\" field is free-form, manufacturer-defined, and non-localized.\n"],null,["# Error handling\n\nUse the `400 Bad Request` status code for all errors defined in this specification. For all other errors, manufacturers should use errors in the 4XX range for client errors, and the 5XX range for server errors. The response should always include a JSON body in the following format for ***all*** error cases: \n\n {\n \"name\": \"camera.info\",\n \"state\": \"error\",\n \"error\": {\n \"code\": \"serverError\",\n \"message\": \"cannot get camera info.\"\n }\n }\n\n- `name` can be any of `camera.info`, `camera.state`, `camera.checkForUpdates`, `camera.commands.status`, and `camera.commandName`.\n- `code` should be one of the following for 400 status code:`unknownCommand`, `cameraInExclusiveUse`, `missingParameter`, `invalidParameterName`, or `invalidParameterValue`.\n- `message` is defined by manufacturers and is not expected to be a localized message."]]
