• 1. MIX.IOT.2018.F.13.06-APIS API
    • 1.1. 请求地址
    • 1.2. 请求说明
    • 1.3. 响应说明
    • 1.4. 接口列表
      • 1.4.1. 获取离线数据结果集
        • 1.4.1.1. 功能描述
        • 1.4.1.2. 请求参数
        • 1.4.1.3. 响应参数
      • 1.4.2. 获取统计计算数据
        • 1.4.2.1. 功能描述
        • 1.4.2.2. 请求参数
        • 1.4.2.3. 响应参数
      • 1.4.3. 获取统计计算数据根据日期
        • 1.4.3.1. 功能描述
        • 1.4.3.2. 请求参数
        • 1.4.3.3. 响应参数
      • 1.4.4. 获取一段周期内的统计结果集
        • 1.4.4.1. 功能描述
        • 1.4.4.2. 请求参数
        • 1.4.4.3. 响应参数
      • 1.4.5. 获取前N时间单位内的计算结果集
        • 1.4.5.1. 功能描述
        • 1.4.5.2. 请求参数
        • 1.4.5.3. 响应参数
      • 1.4.6. 获取累计结果
        • 1.4.6.1. 功能描述
        • 1.4.6.2. 请求参数
        • 1.4.6.3. 响应参数
      • 1.4.7. 统计数据excel导出
        • 1.4.7.1. 功能描述
        • 1.4.7.2. 请求参数
        • 1.4.7.3. 响应参数
      • 1.4.8. Excel文件下载
        • 1.4.8.1. 功能描述
        • 1.4.8.2. 请求参数

    1. MIX.IOT.2018.F.13.06-APIS API

    • 1. MIX.IOT.2018.F.13.06-APIS API
      • 1.1. 请求地址
      • 1.2. 请求说明
      • 1.3. 响应说明
      • 1.4. 接口列表
        • 1.4.1. 获取离线数据结果集
          • 1.4.1.1. 功能描述
          • 1.4.1.2. 请求参数
          • 1.4.1.3. 响应参数
        • 1.4.2. 获取统计计算数据
          • 1.4.2.1. 功能描述
          • 1.4.2.2. 请求参数
          • 1.4.2.3. 响应参数
        • 1.4.3. 获取统计计算数据根据日期
          • 1.4.3.1. 功能描述
          • 1.4.3.2. 请求参数
          • 1.4.3.3. 响应参数
        • 1.4.4. 获取一段周期内的统计结果集
          • 1.4.4.1. 功能描述
          • 1.4.4.2. 请求参数
          • 1.4.4.3. 响应参数
        • 1.4.5. 获取前N时间单位内的计算结果集
          • 1.4.5.1. 功能描述
          • 1.4.5.2. 请求参数
          • 1.4.5.3. 响应参数
        • 1.4.6. 获取累计结果
          • 1.4.6.1. 功能描述
          • 1.4.6.2. 请求参数
          • 1.4.6.3. 响应参数
        • 1.4.7. 统计数据excel导出
          • 1.4.7.1. 功能描述
          • 1.4.7.2. 请求参数
          • 1.4.7.3. 响应参数
        • 1.4.8. Excel文件下载
          • 1.4.8.1. 功能描述
          • 1.4.8.2. 请求参数

    1.1. 请求地址

    HOST:http://xxx.com/(具体以系统部署地址为准)请求地址:HOST +下文接口中的url

    1.2. 请求说明

    固定传参

    在 http header 中传入参数,该参数来源于用户登录后获得到的验证信息,用于鉴权

    参考

    Authorization: Bearer d6nAGWraBuRY4wkEo7KLK4d3N53A4i5gMnj1iiCZQujZS783WE1SfHNkBFjkns85

    1.3. 响应说明

    所有响应都提供了遵循如下响应规则,在后面的响应说明中不再做出说明

    状态码说明:

    1.4. 接口列表

    code含义
    500错误
    200执行成功

    1.4.1. 获取离线数据结果集

    1.4.1.1. 功能描述

    属性
    url/api/apis/getCollect
    http方法post
    Content-Typex-www-form-urlencode

    1.4.1.2. 请求参数

    参数名称数据类型长度/字节描述是否必选
    equipment_idstring设备标识必选
    collect_idstring采集结果标识,允许传多个值,用逗号分隔必选
    start_timedatetime开始时间可选
    end_timedatetime结束时间可选

    1.4.1.3. 响应参数

    响应示例:

    1. {
    2. "code": 200,
    3. "msg": "操作成功",
    4. "result": {
    5. "data": {
    6. "PowerMeterRatio": [{
    7. "collect_id": "PowerMeterRatio",
    8. "data": "1000"
    9. }, {
    10. "collect_id": "PowerMeterRatio",
    11. "data": "1000"
    12. }]
    13. }
    14. }
    15. }

    1.4.2. 获取统计计算数据

    1.4.2.1. 功能描述

    属性
    url/api/apis/getStatistic
    http方法post
    Content-Typex-www-form-urlencode

    1.4.2.2. 请求参数

    参数名称数据类型长度/字节描述是否必选
    statistics_idstring采集结果标识必选
    equipment_idstring设备标识必选
    start_timedatetime开始时间可选
    end_timedatetime结束时间可选

    1.4.2.3. 响应参数

    1. {
    2. "code": 200,
    3. "msg": "操作成功",
    4. "result": {
    5. "data": {
    6. "TonnageFuel": [{
    7. "sort": 1536303600,
    8. "year": 2018,
    9. "month": 9,
    10. "day": 7,
    11. "hour": 15,
    12. "data": "4.000",
    13. "statistics_id": "TonnageFuel"
    14. }, {
    15. "sort": 1536307200,
    16. "year": 2018,
    17. "month": 9,
    18. "day": 7,
    19. "hour": 16,
    20. "data": "1.089",
    21. "statistics_id": "TonnageFuel"
    22. }]
    23. }
    24. }
    25. }

    1.4.3. 获取统计计算数据根据日期

    1.4.3.1. 功能描述

    根据日期 Y-m-d h 获取统计结果 ,当日期格式为为 Y 获取年的统计 当为 Y-m获取月的统计 以此类推。

    属性
    url/api/apis/getStatisticByDate
    http方法post
    Content-Typex-www-form-urlencode

    1.4.3.2. 请求参数

    参数名称数据类型长度/字节描述是否必选
    equipment_idstring设备标识必选
    statistics_idstring统计id,通过逗号分隔成多个必选
    datetimedatetime时间点,通过逗号分隔成多个必选

    1.4.3.3. 响应参数

    请求示例:

    1. equipment_id:1014
    2. statistics_id:max,accumulate
    3. datetime:2018-09-16,2018-09-17,2018-09-18

    响应示例:

    1. {
    2. "code": 200,
    3. "msg": "操作成功",
    4. "result": {
    5. "data": [{
    6. "accumulate": [{
    7. "sort": 1537200000,
    8. "year": 2018,
    9. "month": 9,
    10. "day": 18,
    11. "data": "0.000",
    12. "statistics_id": "accumulate"
    13. }],
    14. "max": [{
    15. "sort": 1537200000,
    16. "year": 2018,
    17. "month": 9,
    18. "day": 18,
    19. "data": "2500.000",
    20. "statistics_id": "max"
    21. }]
    22. }]
    23. }
    24. }

    1.4.4. 获取一段周期内的统计结果集

    1.4.4.1. 功能描述

    可获取当月和上月| 当周和上周的统计数据结果集,如果timeFlag为month的话则取的是上月和本月每天的统计结果集,同理week 类似。

    属性
    url/api/apis/getStatisticByPeriod
    http方法post
    Content-Typex-www-form-urlencode

    1.4.4.2. 请求参数

    参数名称数据类型长度/字节描述是否必选
    statistics_idstring统计计算标识必选
    equipment_idstring设备标识必选
    timeFlagstring月/周 month/week必选

    1.4.4.3. 响应参数

    参数名称数据类型长度/字节描述是否必选
    datastring统计结果值必选
    createdstring数据创建日期必选
    lastarray上(月/周)必选
    currentarray当(月/周)必选

    响应示例:

    1. {
    2. "code": 200,
    3. "msg": "操作成功",
    4. "result": {
    5. "last": [],
    6. "current": [{
    7. "created": "7-1",
    8. "data": "6733.000"
    9. }, {
    10. "created": "7-2",
    11. "data": "711.000"
    12. }, {
    13. "created": "7-3",
    14. "data": "2446.000"
    15. }, {
    16. "created": "7-4",
    17. "data": "7944.000"
    18. }, {
    19. "created": "7-5",
    20. "data": "1208.000"
    21. }, {
    22. "created": "7-6",
    23. "data": "5793.000"
    24. }, {
    25. "created": "7-7",
    26. "data": "254.000"
    27. }, {
    28. "created": "7-14",
    29. "data": "3306.000"
    30. }]
    31. }
    32. }

    1.4.5. 获取前N时间单位内的计算结果集

    1.4.5.1. 功能描述

    可获取除了当月|天.. 的数据之外,的数据结果集合,通过 timeValue 为1便可以获取上月上周.. 的统计结果,例如:timeFlag: month timeValue: 1 获取上月的数据

    属性
    url/api/apis/getStatisticByTimeFlag
    http方法post
    Content-Typex-www-form-urlencode

    1.4.5.2. 请求参数

    参数名称数据类型长度/字节描述是否必选
    statistics_idstring统计计算标识必选
    equipment_idstring设备标识必选
    timeValueint前N小时/天/周/…必选
    timeFlagstringyear/month/week/day/hour(年/月/周/日/小时)必选

    1.4.5.3. 响应参数

    参数名称数据类型长度/字节描述是否必选
    datastring统计结果值必选
    createdstring日期必选

    响应示例:

    1. {
    2. "code": 200,
    3. "msg": "操作成功",
    4. "result": {
    5. "cumulativeflowhourly": [{
    6. "year": 2018,
    7. "month": 7,
    8. "day": 23,
    9. "statistics_id": "cumulativeflowhourly",
    10. "data": "4,981.000"
    11. }]
    12. }
    13. }

    1.4.6. 获取累计结果

    1.4.6.1. 功能描述

    获取天|月|年|总计的累计结果, 通过timeFlag传不同的值获取,即获取当天、当月、当年的累计结果

    属性
    url/api/apis/getAggregate
    http方法post
    Content-Typex-www-form-urlencode

    1.4.6.2. 请求参数

    参数名称数据类型长度/字节描述是否必选
    statistics_idstring统计计算标识,允许多个值通过逗号分隔必选
    equipment_idString设备标识必选
    timeFlagstringday/month/year/total

    1.4.6.3. 响应参数

    响应示例:

    1. {
    2. "code": 200,
    3. "msg": "操作成功",
    4. "result": {
    5. "data": {
    6. "FuelConsumption": "20.891",
    7. "PowerConsumption": "1378.000"
    8. }
    9. }
    10. }

    1.4.7. 统计数据excel导出

    1.4.7.1. 功能描述

    属性
    url/api/apis/getStatisticsExcel
    http方法get

    1.4.7.2. 请求参数

    参数名称数据类型长度/字节描述是否必选
    statistics_idstring统计计算标识,允许多个值通过逗号分隔,如果查询该设备下所有的计算,则将 statistics_id 置为all必选
    equipment_idString设备标识必选
    page_indexint当前页数,只针对hour/day 类型
    page_sizeint每页条数,只针对hour/day 类型
    typestring导出的数据类型,hour/day/month/year/currentDay/currentYear/currentMonth/total/all all :代表所有类型的数据 hour 代表小时统计数据.currentDay 代表当天统计数据.total 表示累计统计数据 以此类推

    1.4.7.3. 响应参数

    响应示例:

    1. {
    2. "code": 200,
    3. "msg": "操作成功",
    4. "result": {
    5. "data": "app\\\\exports\\\\statistics.xls"
    6. }
    7. }

    1.4.8. Excel文件下载

    1.4.8.1. 功能描述

    属性
    url/api/apis/downloadExcel
    http方法get

    1.4.8.2. 请求参数

    参数名称数据类型长度/字节描述是否必选
    pathstring文件路径必选