| Definitions | |
|---|---|
| Type | object |
Description: On error, HTTP status code is the 4XX range or 5XX range
Examples:
{
"name": "camera.startCapture",
"state": "error",
"error": {
"code": "canceledShooting",
"message": "shooting is canceled."
}
}
{
"state": "error",
"error": {
"code": "unknownCommand",
"message": "Command executed is unknown."
}
}
| Property | Type | Required | Description |
|---|---|---|---|
| name | string | no | The name of requested command such as “camera.takePicture” |
| state | const | yes | Command execution status |
| error | object | yes | Error information from the camera |
| Definitions | |
|---|---|
| Type | string |
Description: The name of requested command such as “camera.takePicture”
| Definitions | |
|---|---|
| Type | const |
Description: Command execution status
Specific value: "error"
| Definitions | |
|---|---|
| Type | object |
Description: Error information from the camera
| Property | Type | Required | Description |
|---|---|---|---|
| code | enum (of string) | yes | Error code. See Error code descriptions for the meaning of error codes. |
| message | string | yes | Error message |
| Definitions | |
|---|---|
| Type | enum (of string) |
Description: Error code. See Error code descriptions for the meaning of error codes.
Must be one of:
| Definitions | |
|---|---|
| Type | string |
Description: Error message