与自动门交互
请求
- 功能:控制现场的自动门设备
- 方法:
POST
- 接口说明:
/callDoor
json
POST "http://host:8088/callDoor"
1
请求数据
求数据为object array
,其中每一个 object
为控制一个门的所有数据,可以同时控制多个门。
单个object
如下表所示:
Name | Type | Description | Required |
---|---|---|---|
name | string | 门的名字 | 是 |
state | int | 开关门的标识,1=开门,0=关门 | 是 |
请求示例
json
[
{
"name": "door1", // 门的名字
"state": 1 // 打开 door1
},
{
"name": "door2",
"state": 0 // 关闭 door2
}
]
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
响应
响应数据
Name | Type | Description |
---|---|---|
code | int | API 错误码,详情见API错误码 |
msg | string | API 错误码信息 |
create_on | int | API 上传时间戳 |
响应数据示例
Responses Code 200
请求成功
json
{
"code": 0,
"create_on": "2022-04-06T14:46:00.806Z",
"msg": "ok"
}
1
2
3
4
5
2
3
4
5
Responses Code 400
不支持 state 类型
json
{
"code": 50002,
"create_on": "2022-05-25T19:03:08.413Z",
"msg": "state not supported"
}
1
2
3
4
5
2
3
4
5
请求数据不为 json array
json
{
"code": 50001,
"create_on": "2022-05-25T19:15:21.262Z",
"msg": "data must be json array"
}
1
2
3
4
5
2
3
4
5
json array 格式错误
json
{
"code": 50001,
"create_on": "2022-05-25T19:05:04.472Z",
"msg": "XXXX format error"
}
1
2
3
4
5
2
3
4
5
请求数据不为 json
json
{
"code": 50000,
"create_on": "2022-05-25T19:05:54.379Z",
"msg": "parse json error"
}
1
2
3
4
5
2
3
4
5
最近更新 2022/11/28
有用
没用