[关闭]
@soszrg 2019-11-11T13:18:11.000000Z 字数 3094 阅读 334

App端接口

anxin


设备详情接口(token)

接口地址

GET /api/v1/enduser/devices/{device_id}/

请求参数示例

  1. > GET /api/v1/enduser/devices/00182001/
  2. {
  3. }

请求参数说明

参数 类型 必须 说明 位置
device_id string Y 设备id path

返回参数示例

  1. # 三相空开:
  2. {
  3. "meta": {
  4. "code": 0,
  5. "message": "ok"
  6. },
  7. "data": {
  8. "area_code": [
  9. "1",
  10. "2",
  11. "3"
  12. ]
  13. }
  14. }
  15. # 水电表:
  16. {
  17. "meta": {
  18. "code": 0,
  19. "message": "ok"
  20. },
  21. "data": {
  22. "cur_price": "3.00",
  23. "app_can_open_wm": true,
  24. "app_can_open_em": true
  25. }
  26. }

返回参数说明

参数 类型 说明
cur_price float 当前单价
app_can_open_wm bool 是否可以开关水表
app_can_open_em bool 是否可以开关电表

获取子设备信息(token)

接口地址

GET /api/v1/enduser/device/lines/

请求参数示例

  1. # 获取所有分路信息
  2. > GET /api/v1/enduser/device/lines/?device_id=aaxss...
  3. {
  4. }
  5. # 获取指定分路信息
  6. > GET /api/v1/enduser/device/lines/?device_id=aaxss...&line_id=2
  7. {
  8. }

请求参数说明

参数 类型 必须 说明 位置
device_id string Y 主设备id path

返回参数示例

  1. # 所有分路信息
  2. {
  3. "meta": {
  4. "code": 0,
  5. "message": "ok"
  6. },
  7. "data": [
  8. {
  9. "line": 2,
  10. "device_id": "3835c11ad2d511e99fe100163e00e478",
  11. "line_alias": "断路开关合约机hyj",
  12. "area": [],
  13. "area_code": [],
  14. "address": ""
  15. },
  16. {
  17. "line": 1,
  18. "device_id": "3835c11ad2d511e99fe100163e00e478",
  19. "line_alias": "塑壳1",
  20. "area": [
  21. "sh",
  22. "sh"
  23. ],
  24. "area_code": [
  25. "1",
  26. "2"
  27. ],
  28. "address": "zzz"
  29. }
  30. ]
  31. }
  32. # 指定分路信息
  33. {
  34. "meta": {
  35. "code": 0,
  36. "message": "ok"
  37. },
  38. "data": {
  39. "line": 2,
  40. "device_id": "3835c11ad2d511e99fe100163e00e478",
  41. "line_alias": "塑壳2",
  42. "area": [
  43. "天津市",
  44. "天津市"
  45. ],
  46. "area_code": [
  47. "140000",
  48. "140300"
  49. ],
  50. "address": "789888"
  51. }
  52. }

返回参数说明

参数 类型 说明
device_id string 主设备id
line int 子设备id
line_alias string 子设备别名

创建子设备(token)

接口地址

POST /api/v1/enduser/device/lines/

请求参数示例

  1. > POST /api/v1/enduser/device/lines/
  2. {
  3. "device_id": "jdkksdx...",
  4. "total_line": 10,
  5. "leak_line": [1, 2, 3]
  6. }

请求参数说明

参数 类型 必须 说明 位置
device_id string Y 主设备id body
total_line int Y 子设备数 body
leak_line int array Y 漏保id(仅用于单相电箱,其他品类传空数组[]) body

返回参数示例

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "ok"
  5. },
  6. "data": [
  7. {
  8. "device_id": "3835c11ad2d511e99fe100163e00e478",
  9. "line": 1,
  10. "line_alias": "塑壳开关",
  11. "area": [],
  12. "area_code": [],
  13. "address": ""
  14. },
  15. {
  16. "device_id": "3835c11ad2d511e99fe100163e00e478",
  17. "line": 2,
  18. "line_alias": "塑壳开关",
  19. "area": [],
  20. "area_code": [],
  21. "address": ""
  22. }
  23. ]
  24. }

返回参数说明

参数 类型 说明
device_id string 主设备id
line int 子设备id
line_alias string 子设备别名

修改子设备信息(token)

接口地址

PUT /api/v1/enduser/device/lines/

请求参数示例

  1. > PUT /api/v1/enduser/device/lines/
  2. {
  3. "device_id": "3835c11ad2d511e99fe100163e00e478",
  4. "line": 1,
  5. "line_alias": "塑壳1",
  6. "area": ["sh", "sh"],
  7. "area_code": ["1", "2"],
  8. "address": "zzzz"
  9. }

请求参数说明

参数 类型 必须 说明 位置
device_id string Y 主设备id body
line int Y 子设备id body
line_alias string Y 子设备别名 body

返回参数示例

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "ok"
  5. },
  6. "data": {}
  7. }

返回参数说明

参数 类型 说明

更新设备信息(token)

接口地址

PUT /api/v1/enduser/devices/

请求参数示例

  1. > PUT /api/v1/enduser/devices/
  2. {
  3. "device_id":"759880dce...",
  4. "area":["上海市", "上海市"],
  5. "area_code": ["1","2","3" ],
  6. "address":"一楼旁",
  7. "device_alias":"zzz"
  8. }

请求参数说明

参数 类型 必须 说明 位置
device_id string Y 设备id body
area string array N 地区信息 body
area_code int array N 地区码 body
address string N 具体地址 body
device_alias string Y 设备别名 body

返回参数示例

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "ok"
  5. },
  6. "data": {
  7. "device_id": "995"
  8. }
  9. }

返回参数说明

参数 类型 说明

移除指定用户(token)

接口地址

POST /api/v1/enduser/remove/

请求参数示例

  1. > POST /api/v1/enduser/remove/
  2. {
  3. "device_id":"759880d...",
  4. "enduser_id":"fc8c110a..."
  5. }

请求参数说明

参数 类型 必须 说明 位置
device_id string Y 设备id body
enduser_id string Y 要移除用户的id body

返回参数示例

  1. {
  2. "meta": {
  3. "code": 0,
  4. "message": "ok"
  5. },
  6. "data": {}
  7. }

返回参数说明

参数 类型 说明

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注