接口基本说明

  1. app 采用http通信方式,端口3000
  2. http请求URL是hotekey.cn:3000/文中方法
  3. 一般从服务器读取数据方式为GET
  4. GET请求由URL携带参数
  5. 更新数据到服务器方法为PUT
  6. 新建一个对象或数据方法为POST
  7. POST请求由body携带参数，Content-Type 是 application/json
  8. 返回数据都是JSON(除登录页)

1 登录与用户

1.1 get用户登录页

方法
get(‘/login’)

请求参数
无

返回数据
成功
html文档：未登录就返回登录页，已经登录则返回首页
失败
无任何返回

1.2 用户登录

方法
post(‘/login’)

请求参数

参数 类型 必填 说明 取值范围
userid String 是 用户名 字母、数据、下划线
password String 是 密码 字母、数据、下划线 
  1. {
  2.     "userid": "hotekeypwsc2021",
  3.     "password": "8888"
  4. }

返回数据
成功
html文档：未登录就返回登录页，已经登录则返回首页
失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "登录出错：用户 smarthome 密码出错"
  3. }

1.3 退出当前登录

方法
post(‘/unlogin’)

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
unlogin Bloon 是 true,false 
  1. {
  2.     "unlogin": true
  3. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "退出登录出错"
  3. }

1.4 获得用户详细信息

方法
get(‘/users’)

请求参数
无

返回数据
成功，返回数组

参数 类型 必填 说明 取值范围
userid String 是 用户名 字母、数据、下划线
password String 是 密码 字母、数据、下划线
username String 否 名字 字母、数据、下划线 
  1. [
  2.     {
  3.         "userid": "hotekeypwsc2021",
  4.         "password": "8888",
  5.         "username": "泰基SC"
  6.     }
  7. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "出错文本信息"
  3. }

1.5 修改用户信息

方法
post(‘/users’)

请求参数

参数 类型 必填 说明 取值范围
password String 是 密码 字母、数据、下划线
username String 否 名字 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
password String 是 密码 字母、数据、下划线
username String 否 名字 字母、数据、下划线 
  1. {
  2.     "password": "8888",
  3.     "username": "泰基SC"
  4. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "修改用户信息出错"
  3. }

1.6 get新用户注册页

方法
get(‘/newUserPage’)

请求参数
无

返回数据
成功
html文档：返回新用户注册页
失败
无任何返回

1.7 注册新用户帐号

方法
post(‘/newUserPage’)

请求参数

参数 类型 必填 说明 取值范围
userid String 是 用户名 字母、数据、下划线
password String 是 密码 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
userid String 是 用户名 字母、数据、下划线
password String 是 密码 字母、数据、下划线 
  1. {
  2.     "userid": "hotekeypwsc2021",
  3.     "password": "8888"
  4. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "注册新用户出错"
  3. }

2 项目管理

2.1 获得本用户的项目列表

方法
get(‘/api/projecks’)

请求参数
无

返回数据
成功，项目数组

参数 类型 必填 说明 取值范围
userid String 是 归属用户id 字母、数据、下划线
username String 否 用户名字 字母、数据、下划线
manage_role String 是 用户对该项目的权限 ‘UNKNOW’，’MANAGE’，’WORKER’，’GUEST’
projeck_id Bigint 是 唯一ID 正整数
projeck_name String 否 名字 字母、数据、下划线
projeck_addr String 否 地址 字母、数据、下划线
projeck_time String 否 时间 时间格式 
  1. [
  2.     {
  3.         "userid": "hotekeypwsc2021",
  4.         "username": "泰基SC",
  5.         "manage_role": "MANAGE",
  6.         "projeck_id": 17,
  7.         "projeck_name": "PWSC公寓系统",
  8.         "projeck_addr": "黄埔区科学城掬泉路3路",
  9.         "projeck_time": "2021-1-15"
  10.     }
  11. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

2.2 修改指定id的项目信息

方法
put(‘’/api/projecks/:projeck_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:projeck_id Bigint 是 项目id 正整数

请求参数

参数 类型 必填 说明 取值范围
projeck_name String 否 名字 字母、数据、下划线
projeck_addr String 否 地址 字母、数据、下划线
projeck_time String 否 时间 时间-格式

返回数据
成功

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数
projeck_name String 否 名字 字母、数据、下划线
projeck_addr String 否 地址 字母、数据、下划线
projeck_time String 否 时间 时间-格式 
  1. {
  2.     "projeck_id": 72,
  3.     "projeck_name": "测试项目",
  4.     "projeck_addr": "广州",
  5.     "projeck_time": "2021-4-23"
  6. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

2.3 在当前用户新建项目

方法
post(‘/api/projecks’)

请求参数

参数 类型 必填 说明 取值范围
projeck_name String 否 名字 字母、数据、下划线
projeck_addr String 否 地址 字母、数据、下划线
projeck_time String 否 时间 时间-格式

返回数据
成功

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数,由后台分配
projeck_name String 否 名字 字母、数据、下划线
projeck_addr String 否 地址 字母、数据、下划线
projeck_time String 否 时间 时间-格式 
  1. {
  2.     "projeck_id": 73,
  3.     "projeck_name": "未命名项目",
  4.     "projeck_addr": null,
  5.     "projeck_time": null
  6. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

2.4 删除用户的一个项目

方法
delete(‘/api/projecks/:projeck_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:projeck_id Bigint 是 项目id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数 
  1. {
  2.     "projeck_id": "73"
  3. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

2.5 指定项目给指定成员分权限

方法
post(‘/api/projecks_manage_role’)

请求参数

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数
userid String 是 名字 字母、数据、下划线
manage_role String 是 地址 ‘MANAGE’，’WORKER’， ‘GUEST’

返回数据
成功

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数
userid String 是 名字 字母、数据、下划线
manage_role String 是 地址 ‘MANAGE’，’WORKER’， ‘GUEST’ 
  1. {
  2.     "projeck_id": "11",
  3.     "userid": "smarthome2020G",
  4.     "manage_role": "GUEST"
  5. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "分权限给成员出错"
  3. }

2.6 查询项目已分享权限的成员列表

方法
get(‘/api/projecks_manage_role/:projeck_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:projeck_id Bigint 是 项目id 正整数

请求参数
无

返回数据
成功,成员权限数组

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数
userid String 是 名字 字母、数据、下划线
manage_role String 是 地址 ‘MANAGE’，’WORKER’， ‘GUEST’ 
  1. [
  2.     {
  3.         "projeck_id": 11,
  4.         "userid": "smarthome2020G",
  5.         "manage_role": "GUEST"
  6.     },
  7.     {
  8.         "projeck_id": 11,
  9.         "userid": "smarthome2020W",
  10.         "manage_role": "WORKER"
  11.     }
  12. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目分享成员出错"
  3. }

2.7 修改指定项目的指定成员权限

方法
put(‘/api/projecks_manage_role’)

请求参数

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数
userid String 是 名字 字母、数据、下划线
manage_role String 是 地址 ‘MANAGE’，’WORKER’， ‘GUEST’

返回数据
成功

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数
userid String 是 名字 字母、数据、下划线
manage_role String 是 地址 ‘MANAGE’，’WORKER’， ‘GUEST’ 
  1. {
  2.     "projeck_id": "11",
  3.     "userid": "smarthome2020G",
  4.     "manage_role": "GUEST"
  5. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目分享成员出错"
  3. }

2.8 删除指定项目已分享的权限

方法
delete(‘/api/projecks_manage_role’)

请求参数

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数
userid String 是 名字 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
projeck_id Bigint 是 唯一ID 正整数
userid String 是 名字 字母、数据、下划线 
  1. {
  2.     "projeck_id": "11",
  3.     "userid": "smarthome2020G"
  4. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

3 区域管理

3.1 获得指定项目的区域列表

方法
get(‘/api/:projeck_id/areas’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:projeck_id Bigint 是 项目id 正整数

请求参数
无

返回数据
成功，区域数组

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数 
  1. [
  2.     {
  3.         "area_id": 350,
  4.         "area_floor": "10F",
  5.         "area_name": "办公室",
  6.         "area_type": "普通房",
  7.         "projeck_id": 17
  8.     },
  9.     {
  10.         "area_id": 351,
  11.         "area_floor": "10F",
  12.         "area_name": "吉山公寓",
  13.         "area_type": "普通房",
  14.         "projeck_id": 17
  15.     }
  16. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

3.2 获取指定id的区域信息

方法
get(‘/api/areas/:area_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:area_id Bigint 是 区域id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数 
  1. {
  2.     "area_id": 350,
  3.     "area_floor": "10F",
  4.     "area_name": "办公室",
  5.     "area_type": "普通房",
  6.     "projeck_id": 17
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

3.3 修改指定id的区域信息

方法
put(‘/api/areas/:area_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:area_id Bigint 是 唯一区域ID 正整数

请求参数

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数 
  1. {
  2.     "area_id": 350,
  3.     "area_floor": "10F",
  4.     "area_name": "办公室",
  5.     "area_type": "普通房",
  6.     "projeck_id": 17
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

3.4 在指定项目新建区域

方法
post(‘/api/areas’)

请求参数

参数 类型 必填 说明 取值范围
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 是 所在项目ID 正整数

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一ID 正整数,由后台分配
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数 
  1. {
  2.     "area_id": 350,
  3.     "area_floor": "10F",
  4.     "area_name": "办公室",
  5.     "area_type": "普通房",
  6.     "projeck_id": 17
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

3.5 删除指定ID的区域

方法
delete(‘/api/areas/:area_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:area_id Bigint 是 区域id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一ID 正整数 
  1. {
  2.     "area_id": "73"
  3. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

4 网关管理

4.1 获得指定区域的网关列表

方法
get(‘/api/:area_id/netways’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:area_id Bigint 是 区域id 正整数

请求参数
无

返回数据
成功，网关数组

参数 类型 必填 说明 取值范围
net_id Bigint 是 唯一网关ID 正整数
area_id String 否 所在项目ID 正整数
net_code String 否 硬件码 22位字母、数据、下划线
net_name String 否 网关名字 字母、数据、下划线
net_type String 否 网关类型 字母、数据、下划线
net_timestamp String 否 网关上次请求时间点 日期格式 
  1. [
  2.     {
  3.         "net_id": 334,
  4.         "area_id": 350,
  5.         "net_code": "0338523633363039573435",
  6.         "net_name": "SC138",
  7.         "net_type": "HTPW100",
  8.         "net_timestamp": "2021-01-15 21:41:35"
  9.     }
  10. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得网关列表出错"
  3. }

4.2 获取指定id的网关信息

方法
get(‘/api/netways/:net_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:net_id Bigint 是 网关id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
net_id Bigint 是 唯一网关ID 正整数
area_id String 否 所在区域ID 正整数
net_code String 否 硬件码 22位字母、数据、下划线
net_name String 否 网关名字 字母、数据、下划线
net_type String 否 网关类型 字母、数据、下划线
net_timestamp String 否 网关上次请求时间点 日期格式 
  1. {
  2.     "net_id":334,
  3.     "area_id":350,
  4.     "net_code":"0338523633363039573435",
  5.     "net_name":"SC138",
  6.     "net_type":"HTPW100",
  7.     "net_timestamp":"2021-01-15 21:41:35"
  8. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

4.3 修改指定id的网关信息

方法
方法：put(‘/api/netways/:net_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:net_id Bigint 是 唯一网关ID 正整数

请求参数

参数 类型 必填 说明 取值范围
net_id Bigint 是 唯一网关ID 正整数
area_id String 否 所在区域ID 正整数
net_code String 否 硬件码 22位字母、数据、下划线
net_name String 否 网关名字 字母、数据、下划线
net_type String 否 网关类型 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
net_id Bigint 是 唯一网关ID 正整数
area_id String 否 所在项目ID 正整数
net_code String 否 硬件码 22位字母、数据、下划线
net_name String 否 网关名字 字母、数据、下划线
net_type String 否 网关类型 字母、数据、下划线
net_timestamp String 否 网关上次请求时间点 日期格式 
  1. {
  2.     "net_id":334,
  3.     "area_id":350,
  4.     "net_code":"0338523633363039573435",
  5.     "net_name":"SC138",
  6.     "net_type":"HTPW100",
  7.     "net_timestamp":"2021-01-15 21:41:35"
  8. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "修改区域出错"
  3. }

4.4 在指定区域新建网关

方法
post(‘/api/netways’)

请求参数

参数 类型 必填 说明 取值范围
area_id String 是 所在区域ID 正整数
net_code String 否 硬件码 22位字母、数据、下划线
net_name String 否 网关名字 字母、数据、下划线
net_type String 否 网关类型 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
net_id Bigint 是 唯一网关ID 正整数
area_id String 否 所在区域ID 正整数
net_code String 否 硬件码 22位字母、数据、下划线
net_name String 否 网关名字 字母、数据、下划线
net_type String 否 网关类型 字母、数据、下划线
net_timestamp String 否 网关上次请求时间点 日期格式 
  1. {
  2.     "net_id":334,
  3.     "area_id":350,
  4.     "net_code":"0338523633363039573435",
  5.     "net_name":"SC138",
  6.     "net_type":"HTPW100",
  7.     "net_timestamp":"2021-01-15 21:41:35"
  8. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

4.5 删除指定ID的网关

方法
delete(‘/api/netways/:net_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:net_id Bigint 是 网关id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
net_id Bigint 是 唯一ID 正整数 
  1. {
  2.     "net_id": "73"
  3. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

5 继电器类回路管理

5.1 获得指定网关的继电器回路列表

方法
get(‘/api/:net_id/relays’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:net_id Bigint 是 网关id 正整数

请求参数
无

返回数据
成功，继电器回路数组

参数 类型 必填 说明 取值范围
relay_id Bigint 是 唯一继电器ID 正整数
net_id Bigint 是 所在网关ID 正整数
relay_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’，’SWITCH’，’SOCKET’，’CURTAIN’，’CURT_SIMP’
relay_name String 否 名字 字母、数据、下划线
relay_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
relay_flow Int 否 电流大小 正整数
relay_devID Int 否 所在模块id 正整数
relay_devID Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. [
  2.     {
  3.         "relay_id": 2386,
  4.         "net_id": 334,
  5.         "relay_type": "LIGHT",
  6.         "relay_name": "客厅筒灯",
  7.         "relay_value": "OFF",
  8.         "relay_flow": 0,
  9.         "relay_devID": 40,
  10.         "relay_order": 1,
  11.         "room": "客厅"
  12.     },
  13.     {
  14.         "relay_id": 2385,
  15.         "net_id": 334,
  16.         "relay_type": "LIGHT",
  17.         "relay_name": "客厅射灯",
  18.         "relay_value": "OFF",
  19.         "relay_flow": 0,
  20.         "relay_devID": 40,
  21.         "relay_order": 2,
  22.         "room": "客厅"
  23.     }
  24. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得继电器回路列表出错"
  3. }

5.2 获取指定id的继电器类回路信息

方法
get(‘/api/relays/:relay_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:relay_id Bigint 是 继电器id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
relay_id Bigint 是 唯一继电器ID 正整数
net_id Bigint 是 所在网关ID 正整数
relay_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’，’SWITCH’，’SOCKET’，’CURTAIN’，’CURT_SIMP’
relay_name String 否 名字 字母、数据、下划线
relay_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
relay_flow Int 否 电流大小 正整数
relay_devID Int 否 所在模块id 正整数
relay_devID Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.     "relay_id": 2386,
  3.     "net_id": 334,
  4.     "relay_type": "LIGHT",
  5.     "relay_name": "客厅筒灯",
  6.     "relay_value": "OFF",
  7.     "relay_flow": 0,
  8.     "relay_devID": 40,
  9.     "relay_order": 1,
  10.     "room": "客厅"
  11. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得继电器出错"
  3. }

5.3 修改指定id的继电器类回路信息

方法
put(‘/api/relays/:relay_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:relay_id Bigint 是 唯一继电器ID 正整数

请求参数

参数 类型 必填 说明 取值范围
net_id Bigint 否 所在网关ID 正整数
relay_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’，’SWITCH’，’SOCKET’，’CURTAIN’，’CURT_SIMP’
relay_name String 否 名字 字母、数据、下划线
relay_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
relay_flow Int 否 电流大小 正整数
relay_devID Int 否 所在模块id 正整数
relay_devID Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
relay_id Bigint 是 唯一继电器ID 正整数
net_id Bigint 否 所在网关ID 正整数
relay_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’，’SWITCH’，’SOCKET’，’CURTAIN’，’CURT_SIMP’
relay_name String 否 名字 字母、数据、下划线
relay_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
relay_flow Int 否 电流大小 正整数
relay_devID Int 否 所在模块id 正整数
relay_devID Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.     "relay_id": 2386,
  3.     "net_id": 334,
  4.     "relay_type": "LIGHT",
  5.     "relay_name": "客厅筒灯",
  6.     "relay_value": "OFF",
  7.     "relay_flow": 0,
  8.     "relay_devID": 40,
  9.     "relay_order": 1,
  10.     "room": "客厅"
  11. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

5.4 在指定网关新建继电器类回路

方法
post(‘/api/relays’)

请求参数

参数 类型 必填 说明 取值范围
net_id Bigint 是 所在网关ID 正整数
relay_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’，’SWITCH’，’SOCKET’，’CURTAIN’，’CURT_SIMP’
relay_name String 否 名字 字母、数据、下划线
relay_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
relay_flow Int 否 电流大小 正整数
relay_devID Int 否 所在模块id 正整数
relay_devID Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
relay_id Bigint 是 唯一继电器ID 正整数，由服务器分配
net_id Bigint 否 所在网关ID 正整数
relay_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’，’SWITCH’，’SOCKET’，’CURTAIN’，’CURT_SIMP’
relay_name String 否 名字 字母、数据、下划线
relay_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
relay_flow Int 否 电流大小 正整数
relay_devID Int 否 所在模块id 正整数
relay_devID Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.     "relay_id": 2386,
  3.     "net_id": 334,
  4.     "relay_type": "LIGHT",
  5.     "relay_name": "客厅筒灯",
  6.     "relay_value": "OFF",
  7.     "relay_flow": 0,
  8.     "relay_devID": 40,
  9.     "relay_order": 1,
  10.     "room": "客厅"
  11. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "新建继电器类国回路出错"
  3. }

5.5 删除指定ID的继电器类回路

方法
delete(‘/api/relays/:relay_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:relay_id Bigint 是 区域id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
relay_id Bigint 是 唯一ID 正整数

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

6 调光类回路管理

6.1 获得指定网关的调光类回路列表

方法
get(‘/api/:net_id/dims’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:net_id Bigint 是 网关id 正整数

请求参数
无

返回数据
成功，调光类回路数组

参数 类型 必填 说明 取值范围
dim_id Bigint 是 唯一调光类ID 正整数
net_id Bigint 是 所在网关ID 正整数
dim_type String 否 连接负载类型 ‘LIGHT’
dim_name String 否 名字 字母、数据、下划线
dim_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
dim_devID Int 否 所在模块id 正整数
dim_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. [
  2.     {
  3.         "dim_id": 58,
  4.         "net_id": 352,
  5.         "dim_type": "LIGHT",
  6.         "dim_name": "台灯",
  7.         "dim_value": 100,
  8.         "dim_devID": 0,
  9.         "dim_order": 0,
  10.         "room": "客厅"
  11.     },
  12. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得调光类回路列表出错"
  3. }

6.2 获取指定id的调光类回路信息

方法
get(‘/api/dims/:dim_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:dim_id Bigint 是 调光类id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
dim_id Bigint 是 唯一调光类ID 正整数
net_id Bigint 是 所在网关ID 正整数
dim_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’
dim_name String 否 名字 字母、数据、下划线
dim_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
dim_devID Int 否 所在模块id 正整数
dim_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.    "dim_id": 58,
  3.     "net_id": 352,
  4.     "dim_type": "LIGHT",
  5.     "dim_name": "台灯",
  6.     "dim_value": 100,
  7.     "dim_devID": 0,
  8.     "dim_order": 0,
  9.     "room": null
  10. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得调光类出错"
  3. }

6.3 修改指定id的调光类回路信息

方法
put(‘/api/dims/:dim_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:dim_id Bigint 是 唯一调光类ID 正整数

请求参数

参数 类型 必填 说明 取值范围
net_id Bigint 否 所在网关ID 正整数
dim_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’
dim_name String 否 名字 字母、数据、下划线
dim_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
dim_devID Int 否 所在模块id 正整数
dim_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
dim_id Bigint 是 唯一调光类ID 正整数
net_id Bigint 否 所在网关ID 正整数
dim_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’，’SWITCH’，’SOCKET’，’CURTAIN’，’CURT_SIMP’
dim_name String 否 名字 字母、数据、下划线
dim_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
dim_devID Int 否 所在模块id 正整数
dim_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.     "dim_id": 20,
  3.     "net_id": 10,
  4.     "dim_type": "LIGHT",
  5.     "dim_name": "吧台吊灯",
  6.     "dim_value": 100,
  7.     "dim_devID": 11,
  8.     "dim_order": 2,
  9.     "room": null
  10. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得调光类出错"
  3. }

6.4 在指定网关新建调光类回路

方法
post(‘/api/dims’)

请求参数

参数 类型 必填 说明 取值范围
net_id Bigint 是 所在网关ID 正整数
dim_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’
dim_name String 否 名字 字母、数据、下划线
dim_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
dim_devID Int 否 所在模块id 正整数
dim_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
dim_id Bigint 是 唯一调光类ID 正整数，由服务器分配
net_id Bigint 否 所在网关ID 正整数
dim_type String 否 连接负载类型 ‘UNKNOW’，’LIGHT’
dim_name String 否 名字 字母、数据、下划线
dim_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
dim_devID Int 否 所在模块id 正整数
dim_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.     "dim_id": 20,
  3.     "net_id": 10,
  4.     "dim_type": "LIGHT",
  5.     "dim_name": "吧台吊灯",
  6.     "dim_value": 100,
  7.     "dim_devID": 11,
  8.     "dim_order": 2,
  9.     "room": null
  10. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "新建调光类回路出错"
  3. }

6.5 删除指定ID的调光类类回路

方法
delete(‘/api/dims/:dim_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:dim_id Bigint 是 区域id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
dim_id Bigint 是 唯一ID 正整数

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

7 传感器io类管理

7.1 获得指定网关的传感器io类回路列表

方法
get(‘/api/:net_id/dims’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:net_id Bigint 是 网关id 正整数

请求参数
无

返回数据
成功，调光类回路数组

参数 类型 必填 说明 取值范围
lso_id Bigint 是 唯一传感类ID 正整数
net_id Bigint 是 所在网关ID 正整数
lso_type String 否 连接传感类型 ‘CARD’, ‘SOS’, ‘CHKIN’, ‘CLR’, ‘DND’, ‘CHKOT’, ‘MENC’, ‘IRED’, ‘GENIC’
lso_name String 否 名字 字母、数据、下划线
lso_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
lso_devID Int 否 所在模块id 正整数
lso_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. [
  2.     {
  3.         "lso_id": 620,
  4.         "net_id": 4,
  5.         "lso_name": "清理",
  6.         "lso_value": "OFF",
  7.         "lso_type": "CLR",
  8.         "lso_devID": 21,
  9.         "lso_order": 2,
  10.         "room": "null"
  11.     },
  12.     {
  13.         "lso_id": 622,
  14.         "net_id": 4,
  15.         "lso_name": "勿扰",
  16.         "lso_value": "OFF",
  17.         "lso_type": "DND",
  18.         "lso_devID": 21,
  19.         "lso_order": 3,
  20.         "room": "null"
  21.     },
  22. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得传感类回路列表出错"
  3. }

7.2 获取指定id的传感类回路信息

方法
get(‘/api/lsos/:lso_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:lso_id Bigint 是 传感类id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
lso_id Bigint 是 唯一传感类ID 正整数
net_id Bigint 是 所在网关ID 正整数
lso_type String 否 连接负载类型 ‘CARD’, ‘SOS’, ‘CHKIN’, ‘CLR’, ‘DND’, ‘CHKOT’, ‘MENC’, ‘IRED’, ‘GENIC’
lso_name String 否 名字 字母、数据、下划线
lso_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
lso_devID Int 否 所在模块id 正整数
lso_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.    "lso_id": 20,
  3.     "net_id": 13,
  4.     "lso_name": "清理",
  5.     "lso_value": "OFF",
  6.     "lso_type": "CLR",
  7.     "lso_devID": 21,
  8.     "lso_order": 2,
  9.     "room": null
  10. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得传感类出错"
  3. }

7.3 修改指定id的传感类回路信息

方法
put(‘/api/lsos/:lso_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:lso_id Bigint 是 唯一传感类ID 正整数

请求参数

参数 类型 必填 说明 取值范围
net_id Bigint 否 所在网关ID 正整数
lso_type String 否 连接负载类型 ‘CARD’, ‘SOS’, ‘CHKIN’, ‘CLR’, ‘DND’, ‘CHKOT’, ‘MENC’, ‘IRED’, ‘GENIC’
lso_name String 否 名字 字母、数据、下划线
lso_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
lso_devID Int 否 所在模块id 正整数
lso_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
lso_id Bigint 是 唯一传感类ID 正整数
net_id Bigint 否 所在网关ID 正整数
lso_type String 否 连接负载类型 ‘CARD’, ‘SOS’, ‘CHKIN’, ‘CLR’, ‘DND’, ‘CHKOT’, ‘MENC’, ‘IRED’, ‘GENIC’
lso_name String 否 名字 字母、数据、下划线
lso_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
lso_devID Int 否 所在模块id 正整数
lso_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.     "lso_id": 20,
  3.     "net_id": 13,
  4.     "lso_name": "清理",
  5.     "lso_value": "OFF",
  6.     "lso_type": "CLR",
  7.     "lso_devID": 21,
  8.     "lso_order": 2,
  9.     "room": null
  10. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得传感类出错"
  3. }

7.4 在指定网关新建传感类回路

方法
post(‘/api/lsos’)

请求参数

参数 类型 必填 说明 取值范围
net_id Bigint 是 所在网关ID 正整数
lso_type String 否 连接负载类型 ‘CARD’, ‘SOS’, ‘CHKIN’, ‘CLR’, ‘DND’, ‘CHKOT’, ‘MENC’, ‘IRED’, ‘GENIC’
lso_name String 否 名字 字母、数据、下划线
lso_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
lso_devID Int 否 所在模块id 正整数
lso_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
lso_id Bigint 是 唯一传感类ID 正整数，由服务器分配
net_id Bigint 否 所在网关ID 正整数
lso_type String 否 连接负载类型 ‘CARD’, ‘SOS’, ‘CHKIN’, ‘CLR’, ‘DND’, ‘CHKOT’, ‘MENC’, ‘IRED’, ‘GENIC’
lso_name String 否 名字 字母、数据、下划线
lso_value String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
lso_devID Int 否 所在模块id 正整数
lso_order Int 否 模块上标号 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.     "lso_id": 20,
  3.     "net_id": 13,
  4.     "lso_name": "清理",
  5.     "lso_value": "OFF",
  6.     "lso_type": "CLR",
  7.     "lso_devID": 21,
  8.     "lso_order": 2,
  9.     "room": null
  10. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "新建传感类回路出错"
  3. }

7.5 删除指定ID的传感类回路

方法
delete(‘/api/lsos/:lso_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:lso_id Bigint 是 传感类id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
lso_id Bigint 是 唯一ID 正整数

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

8 空调系统管理

8.1 获得指定网关的空调回路列表

方法
get(‘/api/:net_id/airs’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:net_id Bigint 是 网关id 正整数

请求参数
无

返回数据
成功，空调回路数组

参数 类型 必填 说明 取值范围
air_id Bigint 是 唯一传感类ID 正整数
net_id Bigint 是 所在网关ID 正整数
NAME String 否 名字 字母、数据、下划线
POWER String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
SPEED String 否 风速 ‘UNKNOW’, ‘CLOSE’, ‘LOW’, ‘MIDDLE’, ‘HIGH’
MODE String 否 模式 ‘UNKNOW’, ‘FAN’, ‘HOT’, ‘COLD’
STMP Int 否 设定温度 正整数
TMP Int 否 当前温度 正整数
air_panID Int 否 所在模块id 正整数
air_outID Int 否 模块输出id 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. [
  2.     {
  3.         "air_id": 11,
  4.         "net_id": 4,
  5.         "air_panID": 9,
  6.         "air_outID": 9,
  7.         "NAME": "客厅空调",
  8.         "POWER": "ON",
  9.         "ATO": "UNKNOW",
  10.         "SPEED": "HIGH",
  11.         "MODE": "COLD",
  12.         "STMP": 19,
  13.         "TMP": 27,
  14.         "room": null
  15.     }
  16. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获空调列表出错"
  3. }

8.2 获取指定id的空调信息

方法
get(‘/api/airs/:air_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:air_id Bigint 是 空调id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
air_id Bigint 是 唯一传感类ID 正整数
net_id Bigint 是 所在网关ID 正整数
NAME String 否 名字 字母、数据、下划线
POWER String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
SPEED String 否 风速 ‘UNKNOW’, ‘CLOSE’, ‘LOW’, ‘MIDDLE’, ‘HIGH’
MODE String 否 模式 ‘UNKNOW’, ‘FAN’, ‘HOT’, ‘COLD’
STMP Int 否 设定温度 正整数
TMP Int 否 当前温度 正整数
air_panID Int 否 所在模块id 正整数
air_outID Int 否 模块输出id 正整数
room String 否 所在子房间 字母、数据、下划线 
  1.  {
  2.         "air_id": 11,
  3.         "net_id": 4,
  4.         "air_panID": 9,
  5.         "air_outID": 9,
  6.         "NAME": "客厅空调",
  7.         "POWER": "ON",
  8.         "ATO": "UNKNOW",
  9.         "SPEED": "HIGH",
  10.         "MODE": "COLD",
  11.         "STMP": 19,
  12.         "TMP": 27,
  13.         "room": null
  14.     }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得空调出错"
  3. }

8.3 修改指定id的空调信息

方法
put(‘/api/airs/:air_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:air_id Bigint 是 唯一空调ID 正整数

请求参数

参数 类型 必填 说明 取值范围
net_id Bigint 是 所在网关ID 正整数
NAME String 否 名字 字母、数据、下划线
POWER String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
SPEED String 否 风速 ‘UNKNOW’, ‘CLOSE’, ‘LOW’, ‘MIDDLE’, ‘HIGH’
MODE String 否 模式 ‘UNKNOW’, ‘FAN’, ‘HOT’, ‘COLD’
STMP Int 否 设定温度 正整数
TMP Int 否 当前温度 正整数
air_panID Int 否 所在模块id 正整数
air_outID Int 否 模块输出id 正整数
room String 否 所在子房间 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
air_id Bigint 是 唯一传感类ID 正整数
net_id Bigint 是 所在网关ID 正整数
NAME String 否 名字 字母、数据、下划线
POWER String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
SPEED String 否 风速 ‘UNKNOW’, ‘CLOSE’, ‘LOW’, ‘MIDDLE’, ‘HIGH’
MODE String 否 模式 ‘UNKNOW’, ‘FAN’, ‘HOT’, ‘COLD’
STMP Int 否 设定温度 正整数
TMP Int 否 当前温度 正整数
air_panID Int 否 所在模块id 正整数
air_outID Int 否 模块输出id 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.         "air_id": 11,
  3.         "net_id": 4,
  4.         "air_panID": 9,
  5.         "air_outID": 9,
  6.         "NAME": "客厅空调",
  7.         "POWER": "ON",
  8.         "ATO": "UNKNOW",
  9.         "SPEED": "HIGH",
  10.         "MODE": "COLD",
  11.         "STMP": 19,
  12.         "TMP": 27,
  13.         "room": null
  14.     }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得空调出错"
  3. }

8.4 在指定网关新建空调

方法
post(‘/api/airs’)

请求参数

参数 类型 必填 说明 取值范围
net_id Bigint 是 所在网关ID 正整数
NAME String 否 名字 字母、数据、下划线
POWER String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
SPEED String 否 风速 ‘UNKNOW’, ‘CLOSE’, ‘LOW’, ‘MIDDLE’, ‘HIGH’
MODE String 否 模式 ‘UNKNOW’, ‘FAN’, ‘HOT’, ‘COLD’
STMP Int 否 设定温度 正整数
TMP Int 否 当前温度 正整数
air_panID Int 否 所在模块id 正整数
air_outID Int 否 模块输出id 正整数
room String 否 所在子房间 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
air_id Bigint 是 唯一空调ID 正整数
net_id Bigint 是 所在网关ID 正整数
NAME String 否 名字 字母、数据、下划线
POWER String 否 状态值 ‘UNKNOW’，’OFF’，’ON’
SPEED String 否 风速 ‘UNKNOW’, ‘CLOSE’, ‘LOW’, ‘MIDDLE’, ‘HIGH’
MODE String 否 模式 ‘UNKNOW’, ‘FAN’, ‘HOT’, ‘COLD’
STMP Int 否 设定温度 正整数
TMP Int 否 当前温度 正整数
air_panID Int 否 所在模块id 正整数
air_outID Int 否 模块输出id 正整数
room String 否 所在子房间 字母、数据、下划线 
  1. {
  2.         "air_id": 11,
  3.         "net_id": 4,
  4.         "air_panID": 9,
  5.         "air_outID": 9,
  6.         "NAME": "客厅空调",
  7.         "POWER": "ON",
  8.         "ATO": "UNKNOW",
  9.         "SPEED": "HIGH",
  10.         "MODE": "COLD",
  11.         "STMP": 19,
  12.         "TMP": 27,
  13.         "room": null
  14.     }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "新建空调出错"
  3. }

8.5 删除指定ID的空调

方法
delete(‘/api/airs/:air_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:air_id Bigint 是 空调id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
air_id Bigint 是 唯一ID 正整数

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

9 场景类管理

9.1 获得指定区域的场景列表

方法
get(‘/api/:area_id/scnes’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:area_id Bigint 是 区域id 正整数

请求参数
无

返回数据
成功，网关数组

参数 类型 必填 说明 取值范围
scn_id Bigint 是 唯一场景ID 正整数
area_id String 否 所在区域ID 正整数
scn_name String 否 场景名字 22位字母、数据、下划线
scn_type String 否 场景类型 ‘DIVICE’， ‘CLOUD’
scn_num int 否 场景num 正整数
scn_json String 否 场景设备json json格式
scn_ico String 否 场景图标 字符串
scn_voc String 否 场景语音控制 ‘YES’, ‘NO’
room String 否 所在子房间 22位字母、数据、下划线 
  1. [
  2.     {
  3.         "scn_id": 1596,
  4.         "area_id": 205,
  5.         "scn_name": "睡眠模式",
  6.         "scn_type": "CLOUD",
  7.         "scn_num": 0,
  8.         "scn_json": "{\"all_relays\":[{\"relay_name\":\"窗帘\",\"relay_id\":554,\"relay_value\":\"OFF\"},{\"relay_name\":\"窗纱\",\"relay_id\":555,\"relay_value\":\"OFF\"},{\"relay_name\":\"廊灯\",\"relay_id\":543,\"relay_value\":\"OFF\"},{\"relay_name\":\"卫生间灯\",\"relay_id\":545,\"relay_value\":\"OFF\"},{\"relay_name\":\"淋浴灯\",\"relay_id\":546,\"relay_value\":\"OFF\"},{\"relay_name\":\"排气扇\",\"relay_id\":547,\"relay_value\":\"OFF\"},{\"relay_name\":\"左阅读灯\",\"relay_id\":548,\"relay_value\":\"OFF\"},{\"relay_name\":\"右阅读灯\",\"relay_id\":549,\"relay_value\":\"OFF\"},{\"relay_name\":\"夜灯\",\"relay_id\":550,\"relay_value\":\"OFF\"},{\"relay_name\":\"房灯带\",\"relay_id\":551,\"relay_value\":\"OFF\"},{\"relay_name\":\"房射灯\",\"relay_id\":552,\"relay_value\":\"OFF\"},{\"relay_name\":\"衣柜灯\",\"relay_id\":553,\"relay_value\":\"OFF\"}],\"all_dims\":[],\"all_airs\":[],\"all_lsos\":[]}",
  9.         "scn_ico": "null",
  10.         "scn_voc": "YES",
  11.         "room": null
  12.     },
  13.     {
  14.         "scn_id": 1597,
  15.         "area_id": 205,
  16.         "scn_name": "明亮模式",
  17.         "scn_type": "CLOUD",
  18.         "scn_num": 0,
  19.         "scn_json": "{\"all_relays\":[{\"relay_name\":\"廊灯\",\"relay_id\":543,\"relay_value\":\"ON\"},{\"relay_name\":\"左阅读灯\",\"relay_id\":548,\"relay_value\":\"ON\"},{\"relay_name\":\"右阅读灯\",\"relay_id\":549,\"relay_value\":\"ON\"},{\"relay_name\":\"夜灯\",\"relay_id\":550,\"relay_value\":\"ON\"},{\"relay_name\":\"房灯带\",\"relay_id\":551,\"relay_value\":\"ON\"},{\"relay_name\":\"房射灯\",\"relay_id\":552,\"relay_value\":\"ON\"},{\"relay_name\":\"衣柜灯\",\"relay_id\":553,\"relay_value\":\"ON\"}],\"all_dims\":[],\"all_airs\":[],\"all_lsos\":[]}",
  20.         "scn_ico": "null",
  21.         "scn_voc": "YES",
  22.         "room": null
  23.     },
  24. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得场景列表出错"
  3. }

9.2 获取指定id的场景信息

方法
get(‘/api/scnes/:scn_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:scn_id Bigint 是 场景id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
scn_id Bigint 是 唯一场景ID 正整数
area_id String 否 所在区域ID 正整数
scn_name String 否 场景名字 22位字母、数据、下划线
scn_type String 否 场景类型 ‘DIVICE’， ‘CLOUD’
scn_num int 否 场景num 正整数
scn_json String 否 场景设备json json格式
scn_ico String 否 场景图标 字符串
scn_voc String 否 场景语音控制 ‘YES’, ‘NO’
room String 否 所在子房间 22位字母、数据、下划线 
  1. {
  2.         "scn_id": 1596,
  3.         "area_id": 205,
  4.         "scn_name": "睡眠模式",
  5.         "scn_type": "CLOUD",
  6.         "scn_num": 0,
  7.         "scn_json": "{\"all_relays\":[{\"relay_name\":\"窗帘\",\"relay_id\":554,\"relay_value\":\"OFF\"},{\"relay_name\":\"窗纱\",\"relay_id\":555,\"relay_value\":\"OFF\"},{\"relay_name\":\"廊灯\",\"relay_id\":543,\"relay_value\":\"OFF\"},{\"relay_name\":\"卫生间灯\",\"relay_id\":545,\"relay_value\":\"OFF\"},{\"relay_name\":\"淋浴灯\",\"relay_id\":546,\"relay_value\":\"OFF\"},{\"relay_name\":\"排气扇\",\"relay_id\":547,\"relay_value\":\"OFF\"},{\"relay_name\":\"左阅读灯\",\"relay_id\":548,\"relay_value\":\"OFF\"},{\"relay_name\":\"右阅读灯\",\"relay_id\":549,\"relay_value\":\"OFF\"},{\"relay_name\":\"夜灯\",\"relay_id\":550,\"relay_value\":\"OFF\"},{\"relay_name\":\"房灯带\",\"relay_id\":551,\"relay_value\":\"OFF\"},{\"relay_name\":\"房射灯\",\"relay_id\":552,\"relay_value\":\"OFF\"},{\"relay_name\":\"衣柜灯\",\"relay_id\":553,\"relay_value\":\"OFF\"}],\"all_dims\":[],\"all_airs\":[],\"all_lsos\":[]}",
  8.         "scn_ico": "null",
  9.         "scn_voc": "YES",
  10.         "room": null
  11.     }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得场景列表出错"
  3. }

9.3 修改指定id的场景信息

方法
方法：put(‘/api/scnes/:scn_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:scn_id Bigint 是 唯一场景ID 正整数

请求参数

参数 类型 必填 说明 取值范围
scn_id Bigint 是 唯一场景ID 正整数
area_id String 否 所在区域ID 正整数
scn_name String 否 场景名字 22位字母、数据、下划线
scn_type String 否 场景类型 ‘DIVICE’， ‘CLOUD’
scn_num int 否 场景num 正整数
scn_json String 否 场景设备json json格式
scn_ico String 否 场景图标 字符串
scn_voc String 否 场景语音控制 ‘YES’, ‘NO’
room String 否 所在子房间 22位字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
scn_id Bigint 是 唯一场景ID 正整数
area_id String 否 所在区域ID 正整数
scn_name String 否 场景名字 22位字母、数据、下划线
scn_type String 否 场景类型 ‘DIVICE’， ‘CLOUD’
scn_num int 否 场景num 正整数
scn_json String 否 场景设备json json格式
scn_ico String 否 场景图标 字符串
scn_voc String 否 场景语音控制 ‘YES’, ‘NO’
room String 否 所在子房间 22位字母、数据、下划线 
  1. {
  2.         "scn_id": 1596,
  3.         "area_id": 205,
  4.         "scn_name": "睡眠模式",
  5.         "scn_type": "CLOUD",
  6.         "scn_num": 0,
  7.         "scn_json": "{\"all_relays\":[{\"relay_name\":\"窗帘\",\"relay_id\":554,\"relay_value\":\"OFF\"},{\"relay_name\":\"窗纱\",\"relay_id\":555,\"relay_value\":\"OFF\"},{\"relay_name\":\"廊灯\",\"relay_id\":543,\"relay_value\":\"OFF\"},{\"relay_name\":\"卫生间灯\",\"relay_id\":545,\"relay_value\":\"OFF\"},{\"relay_name\":\"淋浴灯\",\"relay_id\":546,\"relay_value\":\"OFF\"},{\"relay_name\":\"排气扇\",\"relay_id\":547,\"relay_value\":\"OFF\"},{\"relay_name\":\"左阅读灯\",\"relay_id\":548,\"relay_value\":\"OFF\"},{\"relay_name\":\"右阅读灯\",\"relay_id\":549,\"relay_value\":\"OFF\"},{\"relay_name\":\"夜灯\",\"relay_id\":550,\"relay_value\":\"OFF\"},{\"relay_name\":\"房灯带\",\"relay_id\":551,\"relay_value\":\"OFF\"},{\"relay_name\":\"房射灯\",\"relay_id\":552,\"relay_value\":\"OFF\"},{\"relay_name\":\"衣柜灯\",\"relay_id\":553,\"relay_value\":\"OFF\"}],\"all_dims\":[],\"all_airs\":[],\"all_lsos\":[]}",
  8.         "scn_ico": "null",
  9.         "scn_voc": "YES",
  10.         "room": null
  11.     }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "修改场景出错"
  3. }

9.4 在指定区域新建网关

方法
post(‘/api/scnes’)

请求参数

参数 类型 必填 说明 取值范围
area_id String 是 所在区域ID 正整数
scn_name String 否 场景名字 22位字母、数据、下划线
scn_type String 否 场景类型 ‘DIVICE’， ‘CLOUD’
scn_num int 否 场景num 正整数
scn_json String 否 场景设备json json格式
scn_ico String 否 场景图标 字符串
scn_voc String 否 场景语音控制 ‘YES’, ‘NO’
room String 否 所在子房间 22位字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
scn_id Bigint 是 唯一场景ID 正整数
area_id String 否 所在区域ID 正整数
scn_name String 否 场景名字 22位字母、数据、下划线
scn_type String 否 场景类型 ‘DIVICE’， ‘CLOUD’
scn_num int 否 场景num 正整数
scn_json String 否 场景设备json json格式
scn_ico String 否 场景图标 字符串
scn_voc String 否 场景语音控制 ‘YES’, ‘NO’
room String 否 所在子房间 22位字母、数据、下划线 
  1. {
  2.         "scn_id": 1596,
  3.         "area_id": 205,
  4.         "scn_name": "睡眠模式",
  5.         "scn_type": "CLOUD",
  6.         "scn_num": 0,
  7.         "scn_json": "{\"all_relays\":[{\"relay_name\":\"窗帘\",\"relay_id\":554,\"relay_value\":\"OFF\"},{\"relay_name\":\"窗纱\",\"relay_id\":555,\"relay_value\":\"OFF\"},{\"relay_name\":\"廊灯\",\"relay_id\":543,\"relay_value\":\"OFF\"},{\"relay_name\":\"卫生间灯\",\"relay_id\":545,\"relay_value\":\"OFF\"},{\"relay_name\":\"淋浴灯\",\"relay_id\":546,\"relay_value\":\"OFF\"},{\"relay_name\":\"排气扇\",\"relay_id\":547,\"relay_value\":\"OFF\"},{\"relay_name\":\"左阅读灯\",\"relay_id\":548,\"relay_value\":\"OFF\"},{\"relay_name\":\"右阅读灯\",\"relay_id\":549,\"relay_value\":\"OFF\"},{\"relay_name\":\"夜灯\",\"relay_id\":550,\"relay_value\":\"OFF\"},{\"relay_name\":\"房灯带\",\"relay_id\":551,\"relay_value\":\"OFF\"},{\"relay_name\":\"房射灯\",\"relay_id\":552,\"relay_value\":\"OFF\"},{\"relay_name\":\"衣柜灯\",\"relay_id\":553,\"relay_value\":\"OFF\"}],\"all_dims\":[],\"all_airs\":[],\"all_lsos\":[]}",
  8.         "scn_ico": "null",
  9.         "scn_voc": "YES",
  10.         "room": null
  11.     }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得场景出错"
  3. }

9.5 删除指定ID的场景

方法
delete(‘/api/scnes/:scn_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:scn_id Bigint 是 场景id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
scn_id Bigint 是 唯一ID 正整数 
  1. {
  2.     "scn_id": "73"
  3. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

10 智能音箱管理

10.1 获得指定区域的音箱列表

方法
get(‘/api/:area_id/DuerOS_cuids’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:area_id Bigint 是 区域id 正整数

请求参数
无

返回数据
成功，音箱数组

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
cuid Bigint 否 音箱编码 音箱数据
botId String 否
openUid String 否
comment String 否 音箱描述 字母、数据、下划线 
  1. [
  2.     {
  3.         "cuid": "28165aac206d115641b6679d9c63e5b7",
  4.         "botId": null,
  5.         "area_id": 201,
  6.         "openUid": null,
  7.         "comment": "小度音箱"
  8.     }
  9. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得音箱列表出错"
  3. }

10.2 获取指定id的音箱信息

方法
get(‘/api/DuerOS_cuids/:cuid’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:cuid Bigint 是 音箱id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
cuid Bigint 否 音箱编码 音箱数据
botId String 否
openUid String 否
comment String 否 音箱描述 字母、数据、下划线 
  1. {
  2.     "cuid": "28165aac206d115641b6679d9c63e5b7",
  3.     "botId": null,
  4.     "area_id": 201,
  5.     "openUid": null,
  6.     "comment": "小度音箱"
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得音箱列表出错"
  3. }

10.3 修改指定id的音箱信息

方法
put(‘/api/DuerOS_cuids/:cuid’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:cuid Bigint 是 唯一音箱ID 正整数

请求参数

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
botId String 否
openUid String 否
comment String 否 音箱描述 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
cuid Bigint 否 音箱编码 音箱数据
botId String 否
openUid String 否
comment String 否 音箱描述 字母、数据、下划线 
  1. {
  2.     "cuid": "28165aac206d115641b6679d9c63e5b7",
  3.     "botId": null,
  4.     "area_id": 201,
  5.     "openUid": null,
  6.     "comment": "小度音箱"
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得音箱列表出错"
  3. }

10.4 在指定项目新建音箱

方法
post((‘/api/DuerOS_cuids’)

请求参数

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
cuid Bigint 否 音箱编码 音箱数据
botId String 否
openUid String 否
comment String 否 音箱描述 字母、数据、下划线

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
cuid Bigint 否 音箱编码 音箱数据
botId String 否
openUid String 否
comment String 否 音箱描述 字母、数据、下划线 
  1. {
  2.     "cuid": "28165aac206d115641b6679d9c63e5b7",
  3.     "botId": null,
  4.     "area_id": 201,
  5.     "openUid": null,
  6.     "comment": "小度音箱"
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得音箱列表出错"
  3. }

10.5 删除指定ID的音箱

方法
delect(‘/api/DuerOS_cuids/:cuid’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:cuid_id Bigint 是 音箱cuid 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
cuid Bigint 是 唯一ID 正整数 
  1. {
  2.     "cuid": "73"
  3. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

11批处理管理

11.1 获得指定项目的区域列表

方法
get(‘/api/:projeck_id/batchs’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:projeck_id Bigint 是 项目id 正整数

请求参数
无

返回数据
成功，区域数组

参数 类型 必填 说明 取值范围
bat_id Bigint 是 唯一批处理ID 正整数
bat_name String 否 批处理名字 字母、数据、下划线 
  1. [
  2.     {
  3.         "bat_id": 65,
  4.         "bat_name": "nBat11000"
  5.     },
  6.     {
  7.         "bat_id": 68,
  8.         "bat_name": "nBat12021"
  9.     },
  10. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得批处理列表出错"
  3. }

11.2 获取指定id的批处理信息

方法
get(‘/api/batchs/:bat_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:bat_id Bigint 是 批处理id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
bat_id Bigint 是 唯一批处理ID 正整数
bat_name String 否 批处理名字 字母、数据、下划线
projeck_id Bigint 否 项目id 正整数
bat_json String 否 处理的设备列 json字符串
bat_ico String 否 批处理图标 数据 
  1. {
  2.     "bat_id": 65,
  3.     "projeck_id": 11,
  4.     "bat_name": "nBat11000",
  5.     "bat_json": null,
  6.     "bat_ico": null
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得批处理出错"
  3. }

11.3 修改指定id的批处理信息

方法
put’/api/batchs/:bat_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:bat_id Bigint 是 唯一批处理ID 正整数

请求参数

参数 类型 必填 说明 取值范围
bat_name String 否 批处理名字 字母、数据、下划线
bat_json String 否 处理的设备列 json字符串
bat_ico String 否 批处理图标 数据

返回数据
成功

参数 类型 必填 说明 取值范围
bat_id Bigint 是 唯一批处理ID 正整数
bat_name String 否 批处理名字 字母、数据、下划线
projeck_id Bigint 否 项目id 正整数
bat_json String 否 处理的设备列 json字符串
bat_ico String 否 批处理图标 数据 
  1. {
  2.     "bat_id": 65,
  3.     "projeck_id": 11,
  4.     "bat_name": "nBat11000",
  5.     "bat_json": null,
  6.     "bat_ico": null
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得批处理出错"
  3. }

11.4 在指定项目新建批处理

方法
post(‘/api/batchs’)

请求参数

参数 类型 必填 说明 取值范围
bat_name String 否 批处理名字 字母、数据、下划线
projeck_id Bigint 是 项目id 正整数
bat_json String 否 处理的设备列 json字符串
bat_ico String 否 批处理图标 数据

返回数据
成功

参数 类型 必填 说明 取值范围
bat_id Bigint 是 唯一批处理ID 正整数
bat_name String 否 批处理名字 字母、数据、下划线
projeck_id Bigint 否 项目id 正整数
bat_json String 否 处理的设备列 json字符串
bat_ico String 否 批处理图标 数据 
  1. {
  2.     "bat_id": 65,
  3.     "projeck_id": 11,
  4.     "bat_name": "nBat11000",
  5.     "bat_json": null,
  6.     "bat_ico": null
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得批处理出错"
  3. }

11.5 删除指定ID的批处理

方法
delect(‘/api/batchs/:bat_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:bat_id Bigint 是 批处理id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
bat_id Bigint 是 唯一ID 正整数 
  1. {
  2.     "bat_id": "73"
  3. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

12 定时任务管理

12.1 获得指定项目的定时任务列表

方法
get(‘/api/:projeck_id/timerbats’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:projeck_id Bigint 是 项目id 正整数

请求参数
无

返回数据
成功，区域数组

参数 类型 必填 说明 取值范围
id Bigint 是 唯一定时任务ID 正整数
name String 否 定时任务名字 字母、数据、下划线 
  1. [
  2.     {
  3.         "id": 67,
  4.         "name": "nTask12040"
  5.     },
  6.     {
  7.         "id": 64,
  8.         "name": "nTask14043"
  9.     },
  10. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得定时任务出错"
  3. }

12.2 获取指定id的定时任务信息

方法
get’/api/timerbats/:id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:id Bigint 是 定时任务id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
id Bigint 是 唯一定时任务ID 正整数
name String 否 定时任务名字 字母、数据、下划线
projeck_id Bigint 否 项目id 正整数
bat_id Bigint 否 批处理id 正整数
hour Number 否 小时 正整数
minute Number 否 分钟 正整数
second Number 否 秒 正整数
run String 否 运行 ‘YES’, ‘NO’
once String 否 单次运行 ‘YES’, ‘NO’
monflt array 否 月份 数组
wekflt array 否 星期 数组 
  1. {
  2.     "id": 11,
  3.     "projeck_id": 11,
  4.     "bat_id": 62,
  5.     "hour": 15,
  6.     "minute": 6,
  7.     "second": 0,
  8.     "name": "六楼全开",
  9.     "run": "NO",
  10.     "once": "NO",
  11.     "monflt": "[2,7]",
  12.     "wekflt": "[3,4]"
  13. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得定时任务出错"
  3. }

12.3 修改指定id的定时任务信息

方法
put（’/api/timerbats/:id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:id Bigint 是 唯一定时任务ID 正整数

请求参数

参数 类型 必填 说明 取值范围
name String 否 定时任务名字 字母、数据、下划线
projeck_id Bigint 否 项目id 正整数
bat_id Bigint 否 批处理id 正整数
hour Number 否 小时 正整数
minute Number 否 分钟 正整数
second Number 否 秒 正整数
run String 否 运行 ‘YES’, ‘NO’
once String 否 单次运行 ‘YES’, ‘NO’
monflt array 否 月份 数组
wekflt array 否 星期 数组

返回数据
成功

参数 类型 必填 说明 取值范围
id Bigint 是 唯一定时任务ID 正整数
name String 否 定时任务名字 字母、数据、下划线
projeck_id Bigint 否 项目id 正整数
bat_id Bigint 否 批处理id 正整数
hour Number 否 小时 正整数
minute Number 否 分钟 正整数
second Number 否 秒 正整数
run String 否 运行 ‘YES’, ‘NO’
once String 否 单次运行 ‘YES’, ‘NO’
monflt array 否 月份 数组
wekflt array 否 星期 数组 
  1. {
  2.     "id": 11,
  3.     "projeck_id": 11,
  4.     "bat_id": 62,
  5.     "hour": 15,
  6.     "minute": 6,
  7.     "second": 0,
  8.     "name": "六楼全开",
  9.     "run": "NO",
  10.     "once": "NO",
  11.     "monflt": "[2,7]",
  12.     "wekflt": "[3,4]"
  13. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得定时任务出错"
  3. }

12.4 在指定项目新建定时任务

方法
post(‘/api/timerbats’)

请求参数

参数 类型 必填 说明 取值范围
name String 否 定时任务名字 字母、数据、下划线
projeck_id Bigint 否 项目id 正整数
bat_id Bigint 否 批处理id 正整数
hour Number 否 小时 正整数
minute Number 否 分钟 正整数
second Number 否 秒 正整数
run String 否 运行 ‘YES’, ‘NO’
once String 否 单次运行 ‘YES’, ‘NO’
monflt array 否 月份 数组
wekflt array 否 星期 数组

返回数据
成功

参数 类型 必填 说明 取值范围
id Bigint 是 唯一定时任务ID 正整数
name String 否 定时任务名字 字母、数据、下划线
projeck_id Bigint 否 项目id 正整数
bat_id Bigint 否 批处理id 正整数
hour Number 否 小时 正整数
minute Number 否 分钟 正整数
second Number 否 秒 正整数
run String 否 运行 ‘YES’, ‘NO’
once String 否 单次运行 ‘YES’, ‘NO’
monflt array 否 月份 数组
wekflt array 否 星期 数组 
  1. {
  2.     "id": 11,
  3.     "projeck_id": 11,
  4.     "bat_id": 62,
  5.     "hour": 15,
  6.     "minute": 6,
  7.     "second": 0,
  8.     "name": "六楼全开",
  9.     "run": "NO",
  10.     "once": "NO",
  11.     "monflt": "[2,7]",
  12.     "wekflt": "[3,4]"
  13. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得定时任务出错"
  3. }

12.5 删除指定ID的定时任务

方法
delect(‘/api/timerbats/:id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:id Bigint 是 定时任务id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
id Bigint 是 唯一ID 正整数 
  1. {
  2.     "id": "73"
  3. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息

3 区域管理

3.1 获得指定项目的区域列表

方法
get(‘/api/:projeck_id/areas’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:projeck_id Bigint 是 项目id 正整数

请求参数
无

返回数据
成功，区域数组

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数 
  1. [
  2.     {
  3.         "area_id": 350,
  4.         "area_floor": "10F",
  5.         "area_name": "办公室",
  6.         "area_type": "普通房",
  7.         "projeck_id": 17
  8.     },
  9.     {
  10.         "area_id": 351,
  11.         "area_floor": "10F",
  12.         "area_name": "吉山公寓",
  13.         "area_type": "普通房",
  14.         "projeck_id": 17
  15.     }
  16. ]

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

3.2 获取指定id的区域信息

方法
get(‘/api/areas/:area_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:area_id Bigint 是 区域id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数 
  1. {
  2.     "area_id": 350,
  3.     "area_floor": "10F",
  4.     "area_name": "办公室",
  5.     "area_type": "普通房",
  6.     "projeck_id": 17
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

3.3 修改指定id的区域信息

方法
put(‘/api/areas/:area_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:area_id Bigint 是 唯一区域ID 正整数

请求参数

参数 类型 必填 说明 取值范围
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一区域ID 正整数
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数 
  1. {
  2.     "area_id": 350,
  3.     "area_floor": "10F",
  4.     "area_name": "办公室",
  5.     "area_type": "普通房",
  6.     "projeck_id": 17
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

3.4 在指定项目新建区域

方法
post(‘/api/areas’)

请求参数

参数 类型 必填 说明 取值范围
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 是 所在项目ID 正整数

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一ID 正整数,由后台分配
area_floor String 否 楼层 字母、数据、下划线
area_name String 否 名字 字母、数据、下划线
area_type String 否 房间类型 字母、数据、下划线
projeck_id String 否 所在项目ID 正整数 
  1. {
  2.     "area_id": 350,
  3.     "area_floor": "10F",
  4.     "area_name": "办公室",
  5.     "area_type": "普通房",
  6.     "projeck_id": 17
  7. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息 
  1. {
  2.     "err": "获得项目列表出错"
  3. }

3.5 删除指定ID的区域

方法
delect(‘/api/areas/:area_id’)

URL可变字段

可变字段 类型 必填 说明 取值范围
:area_id Bigint 是 区域id 正整数

请求参数
无

返回数据
成功

参数 类型 必填 说明 取值范围
area_id Bigint 是 唯一ID 正整数 
  1. {
  2.     "area_id": "73"
  3. }

失败

参数 类型 必填 说明 取值范围
err String 是 错误信息