#
API清单(微服务实例名称:IOT-PARK)
编号 | API名称 | 请求路径 | 请求方法 | 版本 |
---|---|---|---|---|
1 | 锁车接口 | /v1/iot/parkinglot/iot-park/lock-log/lockCarForThird | POST | v1.0.0 |
2 | 解车接口 | /v1/iot/parkinglot/iot-park/lock-log/unlockForThird | POST | v1.0.0 |
3 | 设备统计数据 | /v1/iot/parkinglot/iot-park/device/statisticsDevice | POST | v1.0.0 |
4 | 根据省市区获取项目列表 | /v1/iot/parkinglot/iot-park/chargePile/getCommunityByLocation | POST | v1.0.0 |
5 | 充电桩统计数据 | /v1/iot/parkinglot/iot-park/chargePile/statisChargePile | POST | v1.0.0 |
6 | 充电阶段统计 | /v1/iot/parkinglot/iot-park/chargePile/phase | POST | v1.0.0 |
7 | 订单数排名 | /v1/iot/parkinglot/iot-park/chargePile/orderRank | POST | v1.0.0 |
8 | 使用率排名 | /v1/iot/parkinglot/iot-park/chargePile/useRateRank | POST | v1.0.0 |
9 | 充电桩趋势统计 | /v1/iot/parkinglot/iot-park/chargePile/trend | POST | v1.0.0 |
10 | 充电分页列表 | /v1/iot/parkinglot/iot-park/chargePile/pageChargeList | POST | v1.0.0 |
11 | 统计项目数 | /v1/iot/parkinglot/iot-park/chargePile/getCommunityCountByLocation | POST | v1.0.0 |
1.锁车接口
请求路径
*POST /v1/iot/parkinglot/iot-park/lock-log/lockCarForThird
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
car_plate_no | 是 | string | 车牌号 | |
project_id | 是 | string | 项目id | |
owner_id | 是 | string | 用户id | |
owner_name | 否 | string | 用户姓名 |
回调参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
code | 是 | string | 是否成功,000000代表成功 | |
msg | 是 | string | 返回消息 | |
data | 是 | JSONObject | json对象 | |
id | 是 | string | 锁车成功的记录id,解车时候需要 | |
owner_id | 是 | string | 锁车的用户id | |
owner_name | 是 | string | 锁车的用户姓名 | |
car_plate_no | 是 | string | 车牌号 | |
lock_date_begin | 是 | string | 锁车开始时间 | |
lock_date_end | 否 | string | 解锁时间,解车才有值 |
示例:
请求参数:
{
"car_plate_no":"粤A01040",
"project_id":"23414",
"owner_id":"21324324ewe23re",
"owner_name":"mysql"
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": {
"owner_id": "21324324ewe23re",
"owner_name": "mysql",
"car_plate_no": "粤A01040",
"lock_date_begin": "2021-02-05T03:39:56.441Z",
"lock_date_end": null,
"comment": null,
"lock_oper_man_name": "mysql",
"lock_oper_man_type": 0,
"unlock_oper_man_name": null,
"unlock_oper_man_type": null,
"id": "8be4b18f300aaffeeb7b78f77b597f47",
"project_id": "23414",
"project_name": "上华产业园项目",
"parkinglot_id": "23430",
"parkinglot_no": "0010",
"parkinglot_name": "A区园区露天停车场B",
"create_date": "2021-02-05T03:39:56.455Z",
"update_date": "2021-02-05T03:39:56.455Z",
},
"status": 200
}
2.解锁接口
请求路径
- POST /v1/iot/parkinglot/iot-park/lock-log/unlockForThird
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
lock_log_id | 是 | String | 锁车记录id | 锁车成功返回的记录id |
owner_id | 否 | String | 用户id | 非必填,可以openid之类 |
owner_name | 否 | String | 用户姓名 | 非必填:微信昵称之类 |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 |
示例:
{
"lock_log_id":"8be4b18f300aaffeeb7b78f77b597f47",
"owner_id":"21324324ewe23re",
"owner_name":"mysql"
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": "解锁成功",
"status": 200
}
3.获取设备统计结果
请求路径
- POST /v1/iot/parkinglot/iot-park/lock-log/unlockForThird
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
project_id | 否 | String | 项目id | 项目id车场id不能同时为空 |
parkinglot_id | 否 | String | 车场id | 项目id车场id不能同时为空 |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | string | 返回数据 | |
device_sum | true | int | 设备数 | |
online_device_sum | true | int | 在线设备数 | |
offline_device_sum | true | int | 离线设备数 | |
alarm_device_sum | true | int | 报警设备数 |
示例:
{ "project_id": 21906, "parkinglot_id": 21933 }
返回结果:
{ "code": "000000", "msg": "请求成功", "data": { "device_sum": 2, "online_device_sum": 0, "offline_device_sum": 2, "alarm_device_sum": 0 }, "status": 200 }
4.根据省市区获取项目列表
请求路径
- POST /v1/iot/parkinglot/iot-park/chargePile/getCommunityByLocation
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
province_no | 否 | String | 省代号 | |
city_no | 否 | String | 市代号 | |
district_no | 否 | String | 区代号 |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | string | 返回数据 |
示例:
{
"province_no":"440000",
"city_no":"440600"
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": [
{
"id": 21163,
"full_space_name": "美的天鹅湖畔1",
"org_code": "100000001100000000",
"org_id": 15274,
"space_name": "美的天鹅湖畔1",
"top_org_code": "100000001"
},
{
"id": 20670,
"full_space_name": "悦然寓111-修改6",
"org_code": "100000001100000003",
"org_id": 20669,
"space_name": "悦然寓111-修改6",
"top_org_code": "100000001"
}
],
"status": 200
}
5.充电桩统计数据
请求路径
- POST /v1/iot/parkinglot/iot-park/chargePile/statisChargePile
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
project_id | 否 | Long | 项目id |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | string | 返回数据 | |
day_income | false | Long | 今日收益 | |
day_chargeing | false | string | 今日充电量(单位 KW) | |
day_orders | false | string | 今日订单数 | |
day_users | false | string | 今日用户数 | |
total_income | false | string | 累计充电量 | |
total_chargeing | false | string | 累计收益 | |
count_start_date | false | string | 统计开始时间 |
示例:
{
"project_id": 348407
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": {
"day_income": 0,
"day_chargeing": 0,
"day_orders": 0,
"day_users": 0,
"total_income": 1080,
"total_chargeing": 13,
"count_start_date": "2022-09-08"
},
"status": 200
}
6.充电阶段统计
请求路径
- POST /v1/iot/parkinglot/iot-park/chargePile/phase
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
project_id | 否 | Long | 项目id | |
date_type | 否 | Integer | 统计维度(1-今日 2-近7天 3-近30日) |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | string | 返回数据 | |
sharp_elect_percent | true | BigDecimal | 尖期电量百分比 | |
flat_elect_percent | true | BigDecimal | 平期电量百分比 | |
feak_elect_percent | true | BigDecimal | 峰期电量百分比 | |
valley_elect_percent | true | BigDecimal | 谷期电量百分比 | |
sharp_elect | true | BigDecimal | 尖期电量 | |
flat_elect | true | BigDecimal | 平期电量 | |
feak_elect | true | BigDecimal | 峰期电量 | |
valley_elect | true | BigDecimal | 谷期电量 | |
total | true | BigDecimal | 总用电量 |
示例:
{
"project_id": 348407,
"date_type": 3
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": {
"sharp_elect_percent": "0.00",
"flat_elect_percent": "22.00",
"sharp_elect": "0.00",
"flat_elect": "2.95",
"feak_elect": "10.53",
"valley_elect": "0.01",
"feak_elect_percent": "78.00",
"valley_elect_percent": "0.00",
"total": "13.49"
},
"status": 200
}
7.订单数排名
请求路径
- POST /v1/iot/parkinglot/iot-park/chargePile/orderRank
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
date_type | 否 | Integer | 统计维度(1-今日 2-近7天 3-近30日) |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | string | 返回数据 |
示例:
{
"date_type": 3
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": [
{
"order_count": 17,
"project_id": "348407",
"project_name": "美的领贤公馆",
"rank": 1
},
{
"order_count": 1,
"project_id": "21906",
"project_name": "领贤公馆",
"rank": 2
}
],
"status": 200
}
8.使用率排名
请求路径
- POST /v1/iot/parkinglot/iot-park/chargePile/useRateRank
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
date_type | 否 | Integer | 统计维度(1-今日 2-近7天 3-近30日) |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | string | 返回数据 |
示例:
{
"date_type": 3
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": [
{
"project_id": "21906",
"project_name": "领贤公馆",
"use_rate": "2.00",
"rank": 1
},
{
"project_id": "348407",
"project_name": "美的领贤公馆",
"use_rate": "7.00",
"rank": 2
}
],
"status": 200
}
9.充电桩趋势统计
请求路径
- POST /v1/iot/parkinglot/iot-park/chargePile/trend
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
date_type | 是 | Integer | 统计维度(1-日 2-小时)) | |
project_id | 否 | Long | 项目id | |
start_day | 是 | String | yyyy-MM-dd | |
end_day | 是 | String | yyyy-MM-dd |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | string | 返回数据 |
示例:
{
"date_type":1,
"start_day": "2022-09-01",
"end_day": "2022-09-09"
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": [
{
"date": "2022-09-01",
"total": 0
},
{
"date": "2022-09-02",
"total": 0
},
{
"date": "2022-09-03",
"total": 46.95
},
{
"date": "2022-09-04",
"total": 0
},
{
"date": "2022-09-05",
"total": 10.53
},
{
"date": "2022-09-06",
"total": 0
},
{
"date": "2022-09-07",
"total": 47.22
},
{
"date": "2022-09-08",
"total": 13.49
},
{
"date": "2022-09-09",
"total": 0
}
],
"status": 200
}
10.充电订单列表
请求路径
- POST /v1/iot/parkinglot/iot-park/chargePile/pageChargeList
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
project_id | 是 | Integer | 项目id | |
page_no | 是 | Integer | 当前页 | |
page_size | 是 | Integer | 页大小 | |
name | 否 | String | 设备编号 | |
date_type | 否 | Integer | 1-今日 2-近一周 3-近一月 |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | string | 返回数据 |
示例:
{
"project_id": 21906,
"page_no": 1,
"page_size": 30
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": {
"total": 1,
"current": 1,
"pages": 1,
"size": 30,
"records": [
{
"chargeStartTime": "2022-09-07T10:48:17.000+0000",//充电开始时间
"parkName": "p220649294车场",//场站名称
"sharpElect": 0.0,//尖电量
"spaceType": "PARK_NAME",//空间类型
"typeName": "新能源汽车",//雷兴明
"chargeEndTime": "2022-09-08T00:09:04.000+0000",//充电结束时间
"feakElect": 10.53,//峰电量
"type": 1,//
"deviceId": "f9b690f8d690fc7f",//设备id
"deviceName": "捷顺充电桩1",//设备名称
"categoryName": "充电桩",//分类
"feeRate": 1.0//倍率
"spaceCode": "100000037100000001100000000",//空间位置编码
"spaceName": "地下停车场",//空间位置名称
"spaceId": 23473,//空间位置ID
"chargeGunName": "充电枪-1",//充电枪名称
"orgCode": "100000004100000002",//业务组织编码
"deviceMac": "CLA220411000191",//设备mac地址
"parkSpace": "A001",//车位名称
"stationName": "领贤公馆室外地面充电站",//充电场站名称
"valleyElect": 0.01,//谷电量
"id": 25,//
"stopChargeType": "1000",//停止充电方式
"meterTime": "2022-09-08T00:09:04.000+0000",//设备时间
"chargeStakeName": "CLA220411000191",//充电桩名称
"serviceCost": 216.0,//充电服务费
"flatElect": 2.95,//平电量
"isSummaryTable": "N",//是否总表
"totalElect": 13.49,//充电电量
"powerCost": 864.0,//充电电费
"carNumber": "1",//充电车牌号码
"itemId": "002609666166254769590041153",//流水ID
"isParkCount": "Y",//是否参与计数
"parkCode": "p220649294",//车场编码
"projectName": "领贤公馆",//项目名称
"category": 4,//所属分类名称
"projectId": 21906,//项目id
"totalCost": 1080.0,//充电总费用(分)
"reportTime": "2022-09-08T00:09:05.000+0000"//数据上报时间
}
],
"searchCount": true,
"orders": []
},
"status": 200
}
11.统计项目数
请求路径
- POST /v1/iot/parkinglot/iot-park/chargePile/getCommunityCountByLocation
请求参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
org_code | 是 | String | 组织code | |
province_no | 否 | String | 省代号(没传的时候统计各个省份,传了则统计各个省下面的市) |
返回参数
字段 | 是否必须 | 字段类型 | 描述 | 备注 |
---|---|---|---|---|
status | true | int | HTTP状态码 | |
code | true | string | 错误码,000000表示请求成功 | |
msg | true | string | 提示内容 | |
data | false | string | 返回数据 |
示例:
{
"org_code":"100000150"
}
返回结果:
{
"code": "000000",
"msg": "请求成功",
"data": [
{
"value": 39,
"code": "110000"
},
{
"value": 8,
"code": "120000"
},
{
"value": 1,
"code": "130000"
},
{
"value": 2,
"code": "140000"
},
{
"value": 3,
"code": "150000"
},
{
"value": 2,
"code": "210000"
},
{
"value": 1,
"code": "230000"
},
{
"value": 3,
"code": "310000"
},
{
"value": 2,
"code": "320000"
},
{
"value": 38,
"code": "330000"
},
{
"value": 1,
"code": "410000"
},
{
"value": 3,
"code": "420000"
},
{
"value": 1,
"code": "430000"
},
{
"value": 72,
"code": "440000"
},
{
"value": 2,
"code": "500000"
},
{
"value": 1,
"code": "540000"
},
{
"value": 1,
"code": "650000"
}
],
"status": 200
}