启用房间设备

客户办理入住调用,启用房间设备,如果存在门锁,会重置用户密码

公共参数

请求地址:
环境 方法 HTTP请求地址
正式环境 POST http://ota.yystart.com/api/pms/bucket/enable/{bucketId}
头部信息:
名称 类型 是否必须 描述
authId String 用户唯一标识符
authToken String 用户管理凭证
Content-TypeString固定为application/json

请求参数

名称 类型 是否必须 示例值 描述
bucketIdStringA1001用户自定义捆绑编号

响应参数

名称 类型 示例值 描述
codeInteger0返回码,0表示成功,其余为失败
msgStringsuccess返回信息,成功时信息固定为success,失败为具体的错误信息

请求示例

http://ota.yystart.com/api/pms/bucket/enable/A1001
  • JSON请求示例

                                                    

响应示例

  • JSON成功示例
{
  "code": 0,
  "msg": "success"
}

状态码解释

状态码 描述
200 请求成功
400 参数错误(请检查参数名和值是否正确)
401 管理凭证不合法(请检查authId,authToken正确性)
415 MediaType错误(请在header中添加Content-Type:application/json)
500 服务器内部错误(服务器错误,请联系管理员)

停用房间设备

客户退房调用,停用房间设备,如果存在门锁,会清空用户密码

公共参数

请求地址:
环境 方法 HTTP请求地址
正式环境 POST http://ota.yystart.com/api/pms/bucket/disable/{bucketId}
头部信息:
名称 类型 是否必须 描述
authId String 用户唯一标识符
authToken String 用户管理凭证
Content-TypeString固定为application/json

请求参数

名称 类型 是否必须 示例值 描述
bucketIdStringA1001用户自定义捆绑编号

响应参数

名称 类型 示例值 描述
codeInteger0返回码,0表示成功,其余为失败
msgStringsuccess返回信息,成功时信息固定为success,失败为具体的错误信息

请求示例

http://ota.yystart.com/api/pms/bucket/disable/A1001
  • JSON请求示例

                                                    

响应示例

  • JSON成功示例
{
  "code": 0,
  "msg": "success"
}

状态码解释

状态码 描述
200 请求成功
400 参数错误(请检查参数名和值是否正确)
401 管理凭证不合法(请检查authId,authToken正确性)
415 MediaType错误(请在header中添加Content-Type:application/json)
500 服务器内部错误(服务器错误,请联系管理员)

房间设备列表

根据房屋ID查找绑定的设备列表

公共参数

请求地址:
环境 方法 HTTP请求地址
正式环境 GET http://ota.yystart.com/api/pms/bucket/devicelist/{bucketId}
头部信息:
名称 类型 是否必须 描述
authId String 用户唯一标识符
authToken String 用户管理凭证

请求参数

名称 类型 是否必须 示例值 描述
bucketIdStringA1001用户自定义捆绑编号
typeInteger1需要查找的设备类型,无type参数为所有设备, 1门锁,2电表,3水表,4插座开关,5窗帘,6中央空调,7取电开关,8红外转发器

响应参数

名称 类型 示例值 描述
deviceIdLong244设备唯一编号,如果该设备没有绑定,则不存在该字段,是否绑定可以通过[binding]这个字段判断
deviceTypeString0100设备类型
deviceNameString三路开关设备名称
macString202020202054网关MAC地址
ieeeString00124B000B7CC466设备的IEEE
portString08设备的端口号
statusString01设备的状态位,如果是开关,00:关闭,01:开启
onlineBooleantrue是否在线
bindingBooleantrue是否已绑定房间
bucketIdStringA1001绑定标识唯一编号,由开发者自己决定,可以是房间编号,可以是用户编号
bindTimeDate1495682044234绑定时间
deviceFirmwareString1.2.3设备固件版本

请求示例

http://ota.yystart.com/api/pms/bucket/devicelist/A1001?type=1
  • JSON请求示例

                                                    

响应示例

  • JSON成功示例
[{
  "deviceId": 244,
  "deviceType": "0100",
  "deviceName": "三路开关",
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08",
  "status": "01",
  "online": true,
  "binding": true,
  "bucketId": "A1001",
  "bindTime": 1495682044234,
  "deviceFirmware": "1.2.3"
}]

状态码解释

状态码 描述
200 请求成功
400 参数错误(请检查参数名和值是否正确)
401 管理凭证不合法(请检查authId,authToken正确性)
415 MediaType错误(请在header中添加Content-Type:application/json)
500 服务器内部错误(服务器错误,请联系管理员)