[关闭]
@soszrg 2019-12-11T11:05:18.000000Z 字数 6441 阅读 362

定时出账

anxin

服务器地址

  1. http://121.40.214.215:8001

token格式

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

参数位置

创建定时出账任务(token)

接口地址

POST /api/v1/scheduler/task/

请求示例

  1. # 每月1号的1点整对水表进行出账
  2. {
  3.     "name": "每月出账",
  4.     "project_id":49,
  5.     "crontab": {
  6.         "month": "*", 
  7.         "day": "1", 
  8.         "hour":"1", 
  9.         "minute":"0"
  10.     },
  11.     "device_type": 1,
  12.     "enabled": true,
  13.     "description": "定时出账"
  14. }

请求参数说明

参数 类型 必须 说明 位置
name string Y 任务名 body
project_id int Y 项目id body
crontab json Y 定时规则（详细内容见下面说明） body
device_type int Y 设备类型：1 水表；2 电表 body
enabled bool N 任务是否开启:true 是； false 否 body
description string N 任务描述 body

crontab说明

「*」说明: 所有字段的值都支持设置为*，表示每xx，例如month=*，表示每月

字段 类型 说明
month string 月
day string 日
hour string 时
minute string 分

返回参数

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "create crontab ok."
  5.     },
  6.     "data": {
  7.         "name": "每月出账",
  8.         "crontab": {
  9.             "month": "*",
  10.             "day": "1",
  11.             "hour": "1",
  12.             "minute": "0"
  13.         },
  14.         "natrual_key": "02c8...",
  15.         "project_id": 49,
  16.         "device_type": 1,
  17.         "last_run_at": "2019-03-11T11:37:35",
  18.         "enabled": true,
  19.         "update_time": "2019-03-11T11:37:35",
  20.         "create_time": "2019-03-11T11:37:35",
  21.         "description": "定时出账"
  22.     }
  23. }

返回参数说明

参数 类型 说明
natrual_key string 任务id
last_run_at string 上次运行时间

任务列表

接口地址

GET /api/v1/scheduler/tasks/

请求示例

  1. /api/v1/scheduler/tasks/?project_id=42&device_type=1&page_size=2&page=2
  2. {
  3. }

请求参数说明

参数 类型 必须 说明 位置
project_id int Y 项目id path
device_type int Y 类型：0 全部；1 水表；2 电表 path
page_size int N 每页条目数 path
page int N 页码 path

返回值

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "task list info"
  5.     },
  6.     "data": {
  7.         "count": 5,
  8.         "page_size": 2,
  9.         "next": true,
  10.         "previous": true,
  11.         "results": [
  12.             {
  13.                 "name": "每月1号出账",
  14.                 "crontab": {
  15.                     "month": "*",
  16.                     "day": "1",
  17.                     "hour": "1",
  18.                     "minute": "0"
  19.                 },
  20.                 "natrual_key": "c5a...",
  21.                 "project_id": 42,
  22.                 "device_type": 1,
  23.                 "enabled": true,
  24.                 "last_run_at": "2019-03-11T11:37:35",
  25.                 "description": "定时出账",
  26.                 "update_time": "2019-03-04T13:45:52",
  27.                 "create_time": "2019-03-04T13:45:52"
  28.             },
  29.             {
  30.                 "name": "每月2号出账",
  31.                 "crontab": {
  32.                     "month": "*",
  33.                     "day": "2",
  34.                     "hour": "1",
  35.                     "minute": "0"
  36.                 },
  37.                 "natrual_key": "c5a...",
  38.                 "project_id": 42,
  39.                 "device_type": 1,
  40.                 "enabled": true,
  41.                 "last_run_at": "2019-03-11T11:37:35",
  42.                 "description": "定时出账",
  43.                 "update_time": "2019-03-04T13:55:03",
  44.                 "create_time": "2019-03-04T13:55:03"
  45.             }
  46.         ]
  47.     }
  48. }

返回参数说明

参数 类型 说明
count int 总条目数
next bool 是否有上一页
previous bool 是否有上一页

单个任务详情

接口地址

GET /api/v1/scheduler/tasks/{natrual_key}/

请求示例

  1. /api/v1/scheduler/tasks/abcds.../
  2. {
  3. }

请求参数说明

参数 类型 必须 说明 位置
natrual_key string Y 任务id path

返回值

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "task info"
  5.     },
  6.     "data": {
  7.         "crontab": {
  8.             "month": "*",
  9.             "day": "1",
  10.             "hour": "1",
  11.             "minute": "0"
  12.         },
  13.         "natrual_key": "c89d28c2453311e98d3af45c898eaab7",
  14.         "name": "dignshi",
  15.         "project_id": 49,
  16.         "device_type": 1,
  17.         "last_run_at": "2019-03-11T11:37:35",
  18.         "enabled": true,
  19.         "description": "定时出账",
  20.         "update_time": "2019-03-13T10:00:32",
  21.         "create_time": "2019-03-13T10:00:32"
  22.     }
  23. }

返回参数说明

参数 类型 说明
-- -- --

更新定时出账任务(token)

接口地址

PUT /api/v1/scheduler/tasks/{nature_key}/

请求示例

  1. # 每月1号的2点整对水表进行出账
  2. {
  3.     "name": "每月出账",
  4.     "crontab": {
  5.         "month": "*", 
  6.         "day": "2", 
  7.         "hour":"1", 
  8.         "minute":"0"
  9.     },
  10.     "enabled": true,
  11.     "description": "定时出账"
  12. }

请求参数说明

参数 类型 必须 说明 位置
nature_key string Y 任务id path
name string Y 任务名 body
crontab json Y 定时规则（详细内容见下面说明） body
enabled bool Y 任务是否开启:true 是； false 否 body
description string Y 任务描述 body

crontab说明

「*」说明: 所有字段的值都支持设置为*，表示每xx，例如month=*，表示每月

字段 类型 说明
month string 月
day string 日
hour string 时
minute string 分

返回参数

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "task update ok."
  5.     },
  6.     "data": {
  7.         "name": "每月出账",
  8.         "crontab": {
  9.             "month": "*",
  10.             "day": "1",
  11.             "hour": "1",
  12.             "minute": "0"
  13.         },
  14.         "natrual_key": "02c8...",
  15.         "project_id": 49,
  16.         "device_type": 1,
  17.         "enabled": true,
  18.         "last_run_at": "2019-03-11T11:37:35",
  19.         "update_time": "2019-03-11T11:37:35",
  20.         "create_time": "2019-03-11T11:37:35",
  21.         "description": "定时出账"
  22.     }
  23. }

返回参数说明

参数 类型 说明
-- -- --

删除定时出账任务(token)

接口地址

DELETE /api/v1/scheduler/tasks/{nature_key}/

请求示例

  1. /api/v1/scheduler/tasks/avcxd.../
  2. {
  3. }

请求参数说明

参数 类型 必须 说明 位置
nature_key string Y 任务id path

返回参数

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

返回参数说明

参数 类型 说明
-- -- --

开关定时出账任务(token)

接口地址

PUT /api/v1/scheduler/tasks/{nature_key}/status/

请求示例

  1. /api/v1/scheduler/tasks/avcxd.../
  2. {
  3.     "enabled": true
  4. }

请求参数说明

参数 类型 必须 说明 位置
nature_key string Y 任务id path
enabled bool Y 状态 body

返回参数

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

返回参数说明

参数 类型 说明
-- -- --

出账历史记录

接口地址

GET /api/v1/scheduler/history/

请求示例

  1. /api/v1/scheduler/history/?project_id=42&device_type=2&page_size=2&page=2&device_id=abc...
  2. {
  3. }

请求参数说明

参数 类型 必须 说明 位置
project_id int Y 项目id path
device_type int Y 类型：0 全部；1 水表；2 电表 path
device_id int N 设备id path
page_size int N 每页条目数 path
page int N 页码 path

返回值

  1. {
  2.     "meta": {
  3.         "message": "info list",
  4.         "code": 0
  5.     },
  6.     "data": {
  7.         "count": 4,
  8.         "page_size": 2,
  9.         "next": null,
  10.         "previous": true,
  11.         "results": [
  12.             {
  13.                 "id": "5c892dd2a90d784b33b9002c",
  14.                 "device_id": "abc...",
  15.                 "device_type": 2,
  16.                 "charge": "10.12",
  17.                 "reading_data": "20.12",
  18.                 "from_time": "2019-03-14T00:20:34",
  19.                 "to_time": "2019-03-14T00:20:34",
  20.                 "created_at": "2019-03-14T00:20:34"
  21.             },
  22.             {
  23.                 "id": "5c892dd1a90d784b33b9002b",
  24.                 "device_id": "abc...",
  25.                 "device_type": 2,
  26.                 "charge": "10.12",
  27.                 "reading_data": "20.12",
  28.                 "from_time": "2019-03-14T00:20:33",
  29.                 "to_time": "2019-03-14T00:20:33",
  30.                 "created_at": "2019-03-14T00:20:33"
  31.             }
  32.         ]
  33.     }
  34. }

返回参数说明

参数 类型 说明
id string 出账id
device_id string 设备id或表号
device_type int 设备类型
charge float 收费额
reading_data float 总读数（如：总电量或总水量）
from_time string 账单起始时间
to_time string 账单截止时间
created_at string 账单生成时间

按时间获取出账历史记录

接口地址

GET /api/v1/scheduler/history/time/

请求示例

  1. /api/v1/scheduler/history/time/?project_id=28&device_id=avc..&device_type=0&start_date=2019-9-21&end_date=2019-11-21&wm_type=自来水表
  2. {
  3. }

请求参数说明

参数 类型 必须 说明 位置
project_id int Y 项目id path
device_type int Y 类型：10 全部；0 电表；1 水表 path
device_id int N 设备id path
wm_type string N 水表类型：自来水表和纯净水表 path
start_date string Y 开始日期 path
end_date string Y 结束日期 path

返回值

  1. {
  2.     "meta": {
  3.         "code": 0,
  4.         "message": "success"
  5.     },
  6.     "data": [
  7.         {
  8.             "id": "5dbb0500152d9a01c13c2fee",
  9.             "house_address": [
  10.                 "安心e家",
  11.                 "",
  12.                 "",
  13.                 "",
  14.                 "空调房"
  15.             ],
  16.             "residents": [
  17.                 {
  18.                     "name": "卢博腾",
  19.                     "cellphone": "13336915622"
  20.                 },
  21.                 {
  22.                     "name": "程-庆科",
  23.                     "cellphone": "15921574273"
  24.                 },
  25.                 {
  26.                     "name": "方浩伟",
  27.                     "cellphone": "13336911233"
  28.                 },
  29.                 {
  30.                     "name": "刘-庆科",
  31.                     "cellphone": "15715604269"
  32.                 },
  33.                 {
  34.                     "name": "高帅",
  35.                     "cellphone": "13336919098"
  36.                 }
  37.             ],
  38.             "device_id": "000090502121",
  39.             "device_type": 0,
  40.             "charge": "63.79",
  41.             "previous_reading_data": "394.83",
  42.             "reading_data": "114.95",
  43.             "from_time": "2019-10-01T00:00:00",
  44.             "to_time": "2019-11-01T00:00:00",
  45.             "created_at": "2019-11-01T00:00:00"
  46.         },
  47.         {
  48.             "id": "5d922680152d9a0e2381e711",
  49.             "house_address": [
  50.                 "安心e家",
  51.                 "",
  52.                 "",
  53.                 "",
  54.                 "空调房"
  55.             ],
  56.             "residents": [
  57.                 {
  58.                     "name": "卢博腾",
  59.                     "cellphone": "13336915622"
  60.                 },
  61.                 {
  62.                     "name": "程-庆科",
  63.                     "cellphone": "15921574273"
  64.                 },
  65.                 {
  66.                     "name": "方浩伟",
  67.                     "cellphone": "13336911233"
  68.                 },
  69.                 {
  70.                     "name": "刘-庆科",
  71.                     "cellphone": "15715604269"
  72.                 },
  73.                 {
  74.                     "name": "高帅",
  75.                     "cellphone": "13336919098"
  76.                 }
  77.             ],
  78.             "device_id": "000090502121",
  79.             "device_type": 0,
  80.             "charge": "236.40",
  81.             "previous_reading_data": "1501.58",
  82.             "reading_data": "394.83",
  83.             "from_time": "2019-09-01T00:00:00",
  84.             "to_time": "2019-10-01T00:00:00",
  85.             "created_at": "2019-10-01T00:00:00"
  86.         }
  87.     ]
  88. }

返回参数说明

参数 类型 说明
id string 出账id
device_id string 设备id或表号
device_type int 设备类型
charge float 收费额
residents array 户主
reading_data float 总读数（如：总电量或总水量）
from_time string 账单起始时间
to_time string 账单截止时间
created_at string 账单生成时间
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注