添加网关

通过mac地址和名称添加网关，将网关绑定到对应账号下

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/gateway/add

头部信息：

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

请求参数

名称	类型	是否必须	示例值	描述
mac	String	是	202020202054	网关MAC地址
name	String	否	测试网关1	网关名称

响应参数

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

请求示例

JSON请求示例

{
  "mac": "202020202054",
  "name": "测试网关1"
}

响应示例

JSON成功示例

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

状态码解释

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

网关列表

获取当前用户网关列表，会带回是否在线和在线设备数

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	GET	http://ota.yystart.com/api/pms/gateway/list

头部信息：

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

请求参数

名称	类型	是否必须	示例值	描述
mac	String	否	202020202054	模糊匹配网关MAC
name	String	否	测试网关1	模糊匹配网关名称

响应参数

名称	类型	示例值	描述
mac	String	202020202054	网关MAC地址
name	String	测试网关1	网关名称
createTime	Date	1495682044271	首次入网时间
updateTime	Date	1495682044271	网关更新时间
online	Boolean	true	网关是否在线
onlineDeviceCount	Integer	0	网关在线设备数量

请求示例

http://ota.yystart.com/api/pms/gateway/list?mac=202020202054&name=测试网关1

JSON请求示例

响应示例

JSON成功示例

[{
  "mac": "202020202054",
  "name": "测试网关1",
  "createTime": 1495682044271,
  "updateTime": 1495682044271,
  "online": true,
  "onlineDeviceCount": 0
}]

状态码解释

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

查找指定网关

通过mac地址查找对应网关信息

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	GET	http://ota.yystart.com/api/pms/gateway/single/{mac}

头部信息：

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

请求参数

名称	类型	是否必须	示例值	描述
mac	String	是	202020202054	网关MAC地址

响应参数

名称	类型	示例值	描述
mac	String	202020202054	网关MAC地址
name	String	测试网关1	网关名称
createTime	Date	1495682044272	首次入网时间
updateTime	Date	1495682044272	网关更新时间
online	Boolean	true	网关是否在线
onlineDeviceCount	Integer	0	网关在线设备数量

请求示例

http://ota.yystart.com/api/pms/gateway/single/202020202054

JSON请求示例

响应示例

JSON成功示例

{
  "mac": "202020202054",
  "name": "测试网关1",
  "createTime": 1495682044272,
  "updateTime": 1495682044272,
  "online": true,
  "onlineDeviceCount": 0
}

状态码解释

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

开放/关闭网络

开放和关闭指定mac的网络

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/gateway/network/{mac}

头部信息：

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

请求参数

名称	类型	是否必须	示例值	描述
mac	String	是	202020202054	网关MAC地址
type	Integer	是	1	设置类型 1:开放网络 2:关闭网络

响应参数

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

请求示例

http://ota.yystart.com/api/pms/gateway/network/202020202054?type=1

JSON请求示例

响应示例

JSON成功示例

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

状态码解释

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

更新网关

通过mac地址更新网关信息

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/gateway/update/{mac}

头部信息：

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

请求参数

名称	类型	是否必须	示例值	描述
mac	String	是	202020202054	网关MAC地址
name	String	是	测试网关1	网关名称

响应参数

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

请求示例

http://ota.yystart.com/api/pms/gateway/update/202020202054

JSON请求示例

{
  "name": "测试网关1"
}

响应示例

JSON成功示例

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

状态码解释

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

删除网关

通过mac地址删除对应的网关

公共参数

请求地址：

环境	方法	HTTP请求地址
正式环境	POST	http://ota.yystart.com/api/pms/gateway/delete/{mac}

头部信息：

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

请求参数

名称	类型	是否必须	示例值	描述
mac	String	是	202020202054	网关MAC地址

响应参数

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

请求示例

http://ota.yystart.com/api/pms/gateway/delete/202020202054

JSON请求示例

响应示例

JSON成功示例

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

状态码解释

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