[关闭]
@soszrg 2019-03-25T08:39:10.000000Z 字数 6220 阅读 290

项目接口

anxin

服务器地址

  1. http://121.40.214.215:8000

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 省份
province_code string 省份代码
city string 城市
city_code string 城市代码
district string 区
district_code string 区代码
detail_address string 详细地址

返回参数

  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.     "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 省份
province_code string 省份代码
city string 城市
city_code string 城市代码
district string 区
district_code string 区代码
detail_address string 详细地址

返回参数

  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)

接口地址

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. }

返回参数说明
无

房间列表(token)

接口地址

GET /api/v1/projects/houses/

请求示例

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

请求参数说明

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

返回参数

  1. {
  2.     "meta":{
  3.         "message":"info list",
  4.         "code":0
  5.     },
  6.     "data":{
  7.         "count":2,
  8.         "page_size":10,
  9.         "next":null,
  10.         "previous":null,
  11.         "results":[
  12.             {
  13.                 "id":14,
  14.                 "creator":{
  15.                     "id":1,
  16.                     "username":"zrg"
  17.                 },
  18.                 "installer":{
  19.                     "id":6,
  20.                     "username":"zzzz"
  21.                 },
  22.                 "created_at":"2018-11-22T21:36:27",
  23.                 "project_id":10,
  24.                 "area":"绿地新丰苑",
  25.                 "building":"5号",
  26.                 "floor":"10层",
  27.                 "house":"1001",
  28.                 "room":"主卧",
  29.                 "status":0
  30.             },
  31.             {
  32.                 "id":13,
  33.                 "creator":{
  34.                     "id":1,
  35.                     "username":"zrg"
  36.                 },
  37.                 "installer":{
  38.                     "id":6,
  39.                     "username":"zzzz"
  40.                 },
  41.                 "created_at":"2018-11-22T21:36:26",
  42.                 "project_id":10,
  43.                 "area":"绿地新丰苑",
  44.                 "building":"5号",
  45.                 "floor":"10层",
  46.                 "house":"1002",
  47.                 "room":"主卧",
  48.                 "status":0
  49.             }
  50.         ]
  51.     }
  52. }

返回参数说明

参数 类型 说明
id int 房间id
creator json 创建人
installer json 安装工
project_id int 项目id
area string 小区/商场/学校等
building string 幢
floor string 层
house string 室
room string 房间
status string 安装状态：0 未安装 1 已安装

添加房间(token)

接口地址

POST /api/v1/projects/houses/

请求示例

  1. POST /api/v1/projects/houses/
  2. {
  3.     "project_id":10,
  4.     "installer_id":6,
  5.     "area":"丰庄新村",
  6.     "building":"5号",
  7.     "floor":"10层",
  8.     "house":"1室",
  9.     "room":"主卧"
  10. }

请求参数说明

参数 类型 必须 说明
project_id int Y 项目id
installer_id int N 安装工id
area string Y 小区
building string N 幢
floor string N 层
house string N 室
room string N 房间

返回参数

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"create ok"
  5.     },
  6.     "data":{
  7.         "id":15,
  8.         "creator":{
  9.             "id":1,
  10.             "username":"zrg"
  11.         },
  12.         "installer":{
  13.             "id":6,
  14.             "username":"zzzz"
  15.         },
  16.         "created_at":"2018-11-22T21:46:20",
  17.         "project_id":10,
  18.         "area":"丰庄新村",
  19.         "building":"5号",
  20.         "floor":"10层",
  21.         "house":"1室",
  22.         "room":"主卧",
  23.         "status":0
  24.     }
  25. }

返回参数说明

参数 类型 说明
id int 房间id
status int 安装状态

获取单个房间信息(token)

接口地址

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

请求示例

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

请求参数说明

参数 类型 必须 说明
id int Y 房间id

返回参数

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"house info"
  5.     },
  6.     "data":{
  7.         "id":15,
  8.         "creator":{
  9.             "id":1,
  10.             "username":"zrg"
  11.         },
  12.         "installer":{
  13.             "id":6,
  14.             "username":"zzzz"
  15.         },
  16.         "created_at":"2018-11-22T21:46:20",
  17.         "project_id":10,
  18.         "area":"丰庄新村",
  19.         "building":"5号",
  20.         "floor":"10层",
  21.         "house":"1室",
  22.         "room":"主卧",
  23.         "status":0
  24.     }
  25. }

返回参数说明

略

更新房间信息(token)

接口地址

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

请求示例

  1. PUT /api/v1/projects/houses/15/
  2. {
  3.     "project_id":10,
  4.     "installer_id":6,
  5.     "area":"丰庄新村",
  6.     "building":"5号",
  7.     "floor":"10层",
  8.     "house":"1室",
  9.     "room":"主卧"
  10. }

请求参数说明

略

返回参数

  1. {
  2.     "meta":{
  3.         "code":0,
  4.         "message":"create ok"
  5.     },
  6.     "data":{
  7.         "id":15,
  8.         "creator":{
  9.             "id":1,
  10.             "username":"zrg"
  11.         },
  12.         "installer":{
  13.             "id":6,
  14.             "username":"zzzz"
  15.         },
  16.         "created_at":"2018-11-22T21:46:20",
  17.         "project_id":10,
  18.         "area":"丰庄新村",
  19.         "building":"5号",
  20.         "floor":"10层",
  21.         "house":"1室",
  22.         "room":"主卧",
  23.         "status":0
  24.     }
  25. }

返回参数说明

参数 类型 说明
id int 项目id

删除房间(token)

接口地址

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

请求示例

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

请求参数说明

无

返回参数

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

返回参数说明
无

获取安装人列表(token)

接口地址

GET /api/v1/engineering/

请求示例

  1. GET /api/v1/engineering/
  2. {
  3. }

请求参数说明

参数 类型 必须 说明 位置

返回参数

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "engineer list"
  5.     },
  6.     "data": [
  7.         {
  8.             "id": 77,
  9.             "username": "anxin_test1"
  10.         },
  11.         {
  12.             "id": 80,
  13.             "username": "sakai1"
  14.         }
  15.     ]
  16. }

返回参数说明

参数 类型 说明
id int 安装人id
username string 用户名

更新安装人(token)

接口地址

PUT /api/v1/projects/houses/{house_id}/installer/

请求示例

  1. PUT /api/v1/projects/houses/326/installer/
  2. {
  3.     "installer_id": 80
  4. }

请求参数说明

参数 类型 必须 说明 位置
house_id int Y 房间id path
installer_id int Y 安装人id body

返回参数

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

返回参数说明

参数 类型 说明
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注