门锁信息

通过设备ID查找门锁信息,包括支持的密码最大最小长度，多少组密码

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	GET	http://ota.yystart.com/api/pms/device/lock/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证

请求参数

名称	类型	是否必须	示例值	描述
deviceId	Long	是	244	设备唯一编号

响应参数

名称	类型	示例值	描述
deviceId	Long	244	设备唯一编号
deviceType	String	0100	设备类型
deviceName	String	三路开关	设备名称
mac	String	202020202054	网关MAC地址
ieee	String	00124B000B7CC466	设备的IEEE
port	String	08	设备的端口号
online	Boolean	true	是否在线
pwdMinLen	Integer	6	密码支持最小长度
pwdMaxLen	Integer	8	密码支持最大长度
pwdGroupSize	Integer	10	密码最多支持多少组
powerType	Integer	2	0电量状态值(电量正常/低压报警), 1具体电量数据mV ,2电量百分比
powerValue	String	0.681	如果查询状态为0：00电压正常 01电压异常(低压报警)，如果查询状态为1：电量电压mV，如果查询状态为2：电量百分比，

请求示例

http://ota.yystart.com/api/pms/device/lock/244

JSON请求示例

响应示例

JSON成功示例

{
  "deviceId": 244,
  "deviceType": "0100",
  "deviceName": "三路开关",
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08",
  "online": true,
  "pwdMinLen": 6,
  "pwdMaxLen": 8,
  "pwdGroupSize": 10,
  "powerType": 2,
  "powerValue": "0.681"
}

状态码解释

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

远程开锁

通过设备ID远程开启门锁

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/device/lock/open/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证
Content-Type	String	是	固定为application/json

请求参数

名称	类型	是否必须	示例值	描述
deviceId	Long	是	244	设备唯一编号
custId	String	否	111	开发者自定义ID，用于区别是谁开的门

响应参数

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

请求示例

http://ota.yystart.com/api/pms/device/lock/open/244?custId=111

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/device/lockpwd/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证

请求参数

名称	类型	是否必须	示例值	描述
deviceId	Long	是	244	设备唯一编号
pwdIndex	Integer	是	244	查找门锁密码位置，默认查找第二位

响应参数

名称	类型	示例值	描述
deviceId	Long	244	设备唯一编号
bucketId	String	A1001	用户自定义捆绑编号
deviceType	String	0100	设备类型
mac	String	202020202054	网关MAC地址
ieee	String	00124B000B7CC466	设备的IEEE
port	String	08	设备的端口号
online	Boolean	true	是否在线
pwdIndex	Integer	1	门锁密码位置
lockPwd	String	12345678	门锁密码
custId	String	1001	开发者自定义ID，用于区别谁设置的密码
resetTime	Date	1495682044263	密码重置时间

请求示例

http://ota.yystart.com/api/pms/device/lockpwd/244?pwdIndex=244

JSON请求示例

响应示例

JSON成功示例

{
  "deviceId": 244,
  "bucketId": "A1001",
  "deviceType": "0100",
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08",
  "online": true,
  "pwdIndex": 1,
  "lockPwd": "12345678",
  "custId": "1001",
  "resetTime": 1495682044263
}

状态码解释

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

门锁密码设定

通过设备ID设定指定位置的门锁密码

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/device/lockpwd/reset/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证
Content-Type	String	是	固定为application/json

请求参数

名称	类型	是否必须	示例值	描述
deviceId	Long	是	244	设备唯一编号
pwdIndex	Integer	是	2	密码设置位置，1号位是管理员密码，2号位是用户密码，力维门锁支持2组密码，遥泰门锁支持10组密码，杨格门锁支持10组密码
lockPwd	String	否	12345678	门锁密码，力维门锁支持密码位数8位，遥泰门锁支持6位或8位密码，杨格门锁支持密码位数6-8位,如果不传此参数则默认生成随机8位密码
custId	String	否	1001	开发者自定义ID，用于区别谁设置的密码
pwdType	Integer	是	1	0:管理员密码 1:普通用户密码

响应参数

名称	类型	示例值	描述
pwdIndex	Integer	1	密码设置位置，力维门锁支持2组密码，杨格门锁支持10组密码
lockPwd	String	12345678	门锁密码
resetTime	Date	1495682044262	密码重置时间
code	Integer	0	返回码，0表示成功，其余为失败
msg	String	success	返回信息，成功时信息固定为success,失败为具体的错误信息

请求示例

http://ota.yystart.com/api/pms/device/lockpwd/reset/244

JSON请求示例

{
  "pwdIndex": 2,
  "lockPwd": "12345678",
  "custId": "1001",
  "pwdType":1
}

响应示例

JSON成功示例

{
  "pwdIndex": 1,
  "lockPwd": "12345678",
  "resetTime": 1495682044262,
  "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/device/lockpwd/list/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证

请求参数

名称	类型	是否必须	示例值	描述
deviceId	Long	是	244	设备唯一编号

响应参数

名称	类型	示例值	描述
deviceId	Long	244	设备唯一编号
bucketId	String	A1001	用户自定义捆绑编号
deviceType	String	0100	设备类型
mac	String	202020202054	网关MAC地址
ieee	String	00124B000B7CC466	设备的IEEE
port	String	08	设备的端口号
online	Boolean	true	是否在线
pwdIndex	Integer	1	门锁密码位置
lockPwd	String	12345678	门锁密码
custId	String	1001	开发者自定义ID，用于区别谁设置的密码
resetTime	Date	1495682044261	密码重置时间

请求示例

http://ota.yystart.com/api/pms/device/lockpwd/list/244

JSON请求示例

响应示例

JSON成功示例

[{
  "deviceId": 244,
  "bucketId": "A1001",
  "deviceType": "0100",
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08",
  "online": true,
  "pwdIndex": 1,
  "lockPwd": "12345678",
  "custId": "1001",
  "resetTime": 1495682044261
}]

状态码解释

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

门锁密码删除

通过设备ID删除指定位置的门锁密码

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/device/lockpwd/clean/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证
Content-Type	String	是	固定为application/json

请求参数

名称	类型	是否必须	示例值	描述
deviceId	Long	是	244	设备唯一编号
pwdIndex	Integer	是	1	密码设置位置，力维门锁支持2组密码，杨格门锁支持10组密码
pwdType	Integer	是	1	密码类型 0:管理员密码 1:用户密码

响应参数

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

请求示例

http://ota.yystart.com/api/pms/device/lockpwd/clean/244

JSON请求示例

{
  "pwdIndex": 1,
  "pwdType": 1
}

响应示例

JSON成功示例

{
  "code": 0,
  "msg": "success"
}

状态码解释

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

门锁密码清空

通过设备ID清空门锁所有密码

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/device/lockpwd/cleanall/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证
Content-Type	String	是	固定为application/json

请求参数

名称	类型	是否必须	示例值	描述
deviceId	Long	是	244	设备唯一编号

响应参数

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

请求示例

http://ota.yystart.com/api/pms/device/lockpwd/cleanall/244

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/device/locklog/{deviceId}

头部信息：

名称	类型	是否必须	描述
authId	String	是	用户唯一标识符
authToken	String	是	用户管理凭证

请求参数

名称	类型	是否必须	示例值	描述
deviceId	Long	是	244	设备唯一编号，如果设备编号不存在，则返回的是空的日志列表
start	Long	否	1490060149530	日志开始时间戳，如果指定开始时间，则从开始时间查找，如果不传则查找三个月内的门锁日志

响应参数

名称	类型	示例值	描述
deviceId	Long	244	设备唯一编号
mac	String	202020202054	网关MAC地址
ieee	String	00124B000B7CC466	设备的IEEE
port	String	08	设备的端口号
custId	String	111	开发者自定义ID
deviceType	String	0100	设备类型
operationType	Integer	10	设备操作类型 0:门卡开门 1:密码开门 2:指纹开门 10:远程开门
createTime	Date	1495682044260	开门时间

请求示例

http://ota.yystart.com/api/pms/device/locklog/244?start=1490060149530

JSON请求示例

响应示例

JSON成功示例

[{
  "deviceId": 244,
  "mac": "202020202054",
  "ieee": "00124B000B7CC466",
  "port": "08",
  "custId": "111",
  "deviceType": "0100",
  "operationType": 10,
  "createTime": 1495682044260
}]

状态码解释

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