[关闭]
@soszrg 2019-11-30T15:05:16.000000Z 字数 5769 阅读 319

项目接口

anxin

服务器地址

  1. https://api.anxhome.cn

token格式

  1. Authorization:  token 1:d79be1d657d9a8b45f6f903620e84b06cbf225e0
  1. 登出接口(token)

项目列表(token)

接口地址

GET /api/v1/projects/

请求示例

  1. GET /api/v1/projects/?page=1&page_size=10
  3. {
  4. }

请求参数说明

参数 类型 必须 说明
page int N 页码
page_size int N 每页条目数

返回参数

  1. {
  2.     "meta":{
  3.         "message":"info list",
  4.         "code":0
  5.     },
  6.     "data":{
  7.         "count":13,
  8.         "page_size":10,
  9.         "next":true,
  10.         "previous":null,
  11.         "results":[
  12.             {
  13.                 "id":19,
  14.                 "creator":{
  15.                     "id":1,
  16.                     "username":"zrg"
  17.                 },
  18.                 "owner":{
  19.                     "id":1,
  20.                     "username":"zhang"
  21.                 },
  22.                 "created_at":"2018-11-21T15:10:45",
  23.                 "updated_at":"2018-11-21T15:55:25",
  24.                 "name":"银海华庭",
  25.                 "province":"湖北省",
  26.                 "province_code":"123456",
  27.                 "city":"武汉市",
  28.                 "city_code":"123456",
  29.                 "district":"武昌区",
  30.                 "district_code":"123456",
  31.                 "detail_address":"八一路2145号"
  32.             }
  33.         ]
  34.     }
  35. }

返回参数说明

参数 类型 说明
id int 项目id
creator json 创建人
owner json 项目方
province string 省份
province_code string 省份代码
city string 城市
city_code string 城市代码
district string 区
district_code string 区代码
detail_address string 详细地址
updated_at string 更新时间
created_at string 创建时间

添加项目(token)

接口地址

POST /api/v1/projects/

请求示例

  1. POST /api/v1/projects/
  2. {
  3.     "name":"银海华庭",
  4.     "owner_id":1,
  5.     "province":"湖北省",
  6.     "province_code":"123456",
  7.     "city":"武汉市",
  8.     "city_code":"123456",
  9.     "district":"武昌区",
  10.     "district_code":"123456",
  11.     "detail_address":"八一路501号"
  12. }

请求参数说明

参数 类型 必须 说明
name string Y 项目名
owner_id int Y 项目方
province string Y 省份
province_code string Y 省份代码
city string Y 城市
city_code string Y 城市代码
district string Y 区
district_code string Y 区代码
detail_address string Y 详细地址

返回参数

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"create ok"
  5.     },
  6.     "data":{
  7.         "id":21,
  8.         "creator":{
  9.             "id":1,
  10.             "username":"zrg"
  11.         },
  12.         "owner":{
  13.             "id":1,
  14.             "username":"zrg"
  15.         },
  16.         "created_at":"2018-11-21T17:24:14",
  17.         "updated_at":"2018-11-21T17:24:14",
  18.         "name":"银行华庭",
  19.         "province":"湖北省",
  20.         "province_code":"123456",
  21.         "city":"武汉市",
  22.         "city_code":"123456",
  23.         "district":"武昌区",
  24.         "district_code":"123456",
  25.         "detail_address":"八一路501号"
  26.     }
  27. }

返回参数说明

参数 类型 说明
id int 项目id

获取单个项目信息(token)

接口地址

GET /api/v1/projects/[id]/

请求示例

  1. GET /api/v1/projects/15/
  2. {
  3. }

请求参数说明

参数 类型 必须 说明
id int Y 项目id

返回参数

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"distributor info"
  5.     },
  6.     "data":{
  7.         "id":21,
  8.         "creator":{
  9.             "id":1,
  10.             "username":"zrg"
  11.         },
  12.         "owner":{
  13.             "id":1,
  14.             "username":"zrg"
  15.         },
  16.         "created_at":"2018-11-21T17:24:14",
  17.         "updated_at":"2018-11-21T17:24:14",
  18.         "name":"银海华庭",
  19.         "province":"湖北省",
  20.         "province_code":"123456",
  21.         "city":"武汉市",
  22.         "city_code":"123456",
  23.         "district":"武昌区",
  24.         "district_code":"123456",
  25.         "detail_address":"八一路路501号"
  26.     }
  27. }

返回参数说明

略

更新项目信息(token)

接口地址

PUT /api/v1/projects/[15]/

请求示例

  1. PUT /api/v1/projects/
  2. {
  3.     "name":"银海华庭",
  4.     "owner_id":1,
  5.     "operator_id":1,
  6.     "province":"湖北省",
  7.     "province_code":"123456",
  8.     "city":"武汉市",
  9.     "city_code":"123456",
  10.     "district":"武昌区",
  11.     "district_code":"123456",
  12.     "detail_address":"八一路501号"
  13. }

请求参数说明

参数 类型 必须 说明
name string Y 项目名
owner_id int Y 项目方id
operator_id int Y 运营/物业id
province string Y 省份
province_code string Y 省份代码
city string Y 城市
city_code string Y 城市代码
district string Y 区
district_code string Y 区代码
detail_address string Y 详细地址

返回参数

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"create ok"
  5.     },
  6.     "data":{
  7.         "id":21,
  8.         "creator":{
  9.             "id":1,
  10.             "username":"zrg"
  11.         },
  12.         "owner":{
  13.             "id":1,
  14.             "username":"zrg"
  15.         },
  16.         "operator":{
  17.             "id":1,
  18.             "username":"zrg"
  19.         },
  20.         "created_at":"2018-11-21T17:24:14",
  21.         "updated_at":"2018-11-21T17:24:14",
  22.         "name":"银行华庭",
  23.         "province":"湖北省",
  24.         "province_code":"123456",
  25.         "city":"武汉市",
  26.         "city_code":"123456",
  27.         "district":"武昌区",
  28.         "district_code":"123456",
  29.         "detail_address":"八一路501号"
  30.     }
  31. }

返回参数说明

参数 类型 说明
id int 项目id

删除项目(token)

接口地址

DELETE /api/v1/projects/[id]/

请求示例

  1. DELETE /api/v1/projects/15/
  2. {
  3. }

请求参数说明

无

返回参数

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"delete[15:zzzzz] ok"
  5.     },
  6.     "data":{
  8.     }
  9. }

返回参数说明
无

批量创建房屋接口

POST /api/v1/projects/house/batch/

请求示例

  1. Content-Type:application/json
  2. {
  3. "project_id":2,
  4. "area":"白色小区",
  5. "floor":[1,2],
  6. "house":[1,2],
  7. "building":[1,2],
  8. "room":[1,"A",2]，
  9. "installer_id":61
  10. }

请求参数说明

参数 类型 必须 说明
project_id int Y 项目id
area char Y 小区
building list Y 楼幢信息,比如要建A和B幢就传入["A","B"]
floor list Y 楼层信息,同上
house list Y 房屋信息,同上
room list N 房间信息,同上
installer_id int N 安装工人用户ID

返回示例

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

创建一室

POST /api/v1/projects/house/single/

请求示例

  1. Content-Type:application/json
  2. {
  3. "project_id":2,
  4. "area":"白色小区",
  5. "floor":2
  6. "house":2,
  7. "building":1,
  8. "room":[1,2]，
  9. "installer_id":61
  10. }

请求参数说明

参数 类型 必须 说明
project_id int Y 项目id
area string Y 小区
building string Y 楼幢信息
floor string Y 楼层信息,同上
house strng Y 房屋信息,同上
room list N 房间信息,同上
installer_id int N 安装工人用户ID

返回示例

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

创建房间

POST /api/v1/projects/room/

请求示例

  1. Content-Type:application/json
  2. {
  3. "project_id":2,
  4. "area":"白色小区",
  5. "floor":2
  6. "house":2,
  7. "building":1,
  8. "room":2,
  9. "installer_id":61
  10. }

请求参数说明

参数 类型 必须 说明
project_id int Y 项目id
area string Y 小区
building string Y 楼幢信息
floor string Y 楼层信息,同上
house strng Y 房屋信息,同上
room string Y 房间信息,同上
installer_id int N 安装工人用户ID

返回示例

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

获取项目配置信息

GET /api/v1/projects/[project_id]/config/

请求示例

  1. GET /api/v1/projects/3/config/
  2. {
  3. }

请求参数说明

参数 类型 必须 说明 位置
project_id int Y 项目id path

返回示例

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "success"
  5.     },
  6.     "data": {
  7.         "id": 3,
  8.         "project_id": 3,
  9.         "app_can_open_wm": false,
  10.         "app_can_open_em": true,
  11.         "em_operator_code": "0000",
  12.         "em_operator_pwd": "0000",
  13.         "em_baud_rate": "2400",
  14.         "ext": {
  15.             "botelv": "3600"
  16.         },
  17.         "updated_at": "2019-05-14T16:50:28"
  18.     }
  19. }

返回参数说明

参数 类型 必须 说明
em_operator_code string Y 电表操作者代码
em_operator_pwd string Y 电表操作者密码
em_baud_rate string Y 电表波特率
app_can_open_wm bool Y app是否能开关水表
app_can_open_em bool Y app是否能开关电表
ext json Y 扩展字段

更新项目配置信息

PUT /api/v1/projects/[project_id]/config/

请求示例

  1. PUT /api/v1/projects/3/config/
  2. {       
  3.     "app_can_open_wm": false,
  4.     "app_can_open_em": true,
  5.     "em_operator_code": "0000",
  6.     "em_operator_pwd": "0000",
  7.     "em_baud_rate": "2400",
  8.     "ext": {"baud_rate":"3600"}
  9. }

请求参数说明

参数 类型 必须 说明 位置
project_id int Y 项目id path
em_operator_code string N 电表操作者代码 body
em_operator_pwd string N 电表操作者密码 body
em_baud_rate string N 电表波特率 body
app_can_open_wm bool Y app是否能开关水表 body
app_can_open_em bool Y app是否能开关电表 body
ext json Y 扩展字段 body

返回示例

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "success"
  5.     },
  6.     "data": {
  7.         "id": 3,
  8.         "project_id": 3,
  9.         "app_can_open_wm": false,
  10.         "app_can_open_em": true,
  11.         "em_operator_code": "0000",
  12.         "em_operator_pwd": "0000",
  13.         "em_baud_rate": "2400",
  14.         "ext": {
  15.             "botelv": "3600"
  16.         },
  17.         "updated_at": "2019-05-14T16:50:28"
  18.     }
  19. }

返回参数说明

参数 类型 必须 说明
em_operator_code string Y 电表操作者代码
em_operator_pwd string Y 电表操作者密码
em_baud_rate string Y 电表波特率
app_can_open_wm bool Y app是否能开关水表
app_can_open_em bool Y app是否能开关电表
ext json Y 扩展字段
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注