Files
jsowell-charger-web/doc/运营小程序接口文档.md
2024-08-05 14:18:21 +08:00

289 lines
11 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 查询站点的数据统计
```TEXT
接口地址http://localhost:8080/business/pile/station/getStationStatisticsInfos
请求方式POST
```
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------- | ------------ | -------- | ---------- |
| merchantId | String | N | 运营商id |
| stationIds | List<String> | N | 站点id列表 |
| startTime | String | N | 开始时间 |
| endTime | String | N | 结束时间 |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------------- | --------------------------- | -------- | ---------------- |
| stationStatisticsInfos | List<StationStatisticsInfo> | Y | 站点统计信息集合 |
#### StationStatisticsInfo
| 字段名 | 类型 | 是否必传 | 备注 |
| --------------------- | ---------- | -------- | ----------------------- |
| stationId | String | Y | 站点id |
| stationName | String | Y | 站点名称 |
| chargeDegree | BigDecimal | Y | 充电度数(度) |
| chargeAmount | BigDecimal | Y | 充电总金额(元) |
| orderQuantity | Integer | Y | 订单数量(单) |
| connectorAvailability | String | Y | ==充电枪可使用率(%== |
| chargingConnectorNum | Integer | Y | 充电中(枪口数量) |
| freeConnectorNum | Integer | Y | 空闲(枪口数量) |
| occupiedConnectorNum | Integer | Y | 占用(枪口数量) |
| hangingConnectorNum | Integer | Y | 挂起(枪口数量) |
| offlineConnectorNum | Integer | Y | 离线(枪口数量) |
| faultConnectorNum | Integer | Y | 故障(枪口数量) |
<img src="C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20240723100712169.png" alt="image-20240723100712169" style="zoom: 25%;" />
# 站点经营分析统计图
```text
接口地址http://localhost:8080/business/pile/station/getStationBusinessAnalyzeInfo
接口地址(12个月数据)http://localhost:8080/business/pile/station/getStationMonthlyBusinessAnalyzeInfo
请求方式POST
```
### 入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------- | ------------ | -------- | ------------------------------------------------------ |
| dateTime | String | N | 不传时默认查周期列表数据,传入时为用户选中某一天的日期 |
| type | String | N | 日期类型1-近7天2-近30天 |
| stationIds | List<String> | Y | 站点id列表 |
### 反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------------------- | ------------------------------- | -------- | ------------------------ |
| electricityGrowthRate | String | Y | 充电量增长率 |
| orderAmountGrowthRate | String | Y | 订单金额增长率 |
| serviceAmountGrowthRate | String | Y | 服务费增长率 |
| businessOrderDetailInfoVOList | List<BusinessOrderDetailInfoVO> | N | 运营端小程序订单详情List |
| settleOrderReportList | List<SettleOrderReport> | N | 结算订单报表List |
#### businessOrderDetailInfoVO
| 字段名 | 类型 | 是否必传 | 备注 |
| ---------------------- | ---------- | -------- | -------------------- |
| tradeDate | String | Y | 交易日期(yyyy-MM-dd) |
| sharpUsedElectricity | BigDecimal | Y | 尖时段用电量 |
| sharpAmount | BigDecimal | Y | 尖时段总金额 |
| sharpElectricityPrice | BigDecimal | Y | 尖时段电费 |
| peakUsedElectricity | BigDecimal | Y | 峰时段用电量 |
| peakAmount | BigDecimal | Y | 峰时段总金额 |
| peakElectricityPrice | BigDecimal | Y | 峰时段电费 |
| flatUsedElectricity | BigDecimal | Y | 平时段用电量 |
| flatAmount | BigDecimal | Y | 平时段总金额 |
| flatElectricityPrice | BigDecimal | Y | 平时段电费 |
| valleyUsedElectricity | BigDecimal | Y | 谷时段用电量 |
| valleyAmount | BigDecimal | Y | 谷时段总金额 |
| valleyElectricityPrice | BigDecimal | Y | 谷时段电费 |
| totalServiceAmount | BigDecimal | Y | 总服务费 |
| settleAmount | BigDecimal | Y | 结算金额 |
| totalUsedElectricity | BigDecimal | Y | 总充电量 |
#### SettleOrderReport
| 字段名 | 类型 | 是否必传 | 备注 |
| ----------------- | ---------- | -------- | ---------- |
| useElectricity | BigDecimal | Y | 用电度数 |
| totalAmount | BigDecimal | Y | 收入金额 |
| electricityAmount | BigDecimal | Y | 电费金额 |
| serviceAmount | BigDecimal | Y | 服务费金额 |
# 站点充点分布统计图
接口地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ---- |
| | | | |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ------------------------- |
| | | Y | 时间(小时) |
| | | Y | 每个时段的充电量(度) |
| | | Y | 时段充电量同比增长率(% |
# 站点订单趋势统计图
接口地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ---- |
| | | | |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | --------------------------- |
| | | Y | 日期 |
| | | Y | 每天订单数量(单) |
| | | Y | 每天订单数量同比增长率(% |
# 站点利用率趋势统计图
接口地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ---- |
| | | | |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | --------------- |
| | | Y | 日期 |
| | | Y | 枪均利用率(% |
# 站点充电实况列表
接口地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ---- |
| | | | |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | -------------------------- |
| | | Y | 站点名称 |
| | | Y | 全部枪口数量 |
| | | Y | 充电中枪口数量 |
| | | Y | 空闲枪口数量 |
| | | Y | 挂起枪口数量 |
| | | Y | 占用枪口数量 |
| | | Y | 离线枪口数量 |
| | | Y | 故障枪口数量 |
| | | Y | 充电枪编号 |
| | | Y | 充电中soc% |
| | | Y | 充电中充满剩余时长(分钟) |
| | | Y | 空闲时长(分钟) |
| | | Y | 挂起时长(分钟) |
| | | Y | 占用时长(分钟) |
| | | Y | 离线时长(分钟) |
| | | Y | 故障时长(分钟) |
# 站点充电实况搜索
接口地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ---------- |
| | | Y | 充电枪编号 |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ------------ |
| | | Y | 充电枪编号 |
| | | Y | 当前状态 |
| | | Y | 当前状态时长 |
# 充电枪情况
请求地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ---- |
| | | | |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ------------------------------------------------- |
| | | Y | 已充时长(充电中) |
| | | Y | 最新订单启动时间 |
| | | Y | 充电度数(充电中:以充电度数 / 最新订单充电度数) |
| | | Y | 起止SOC |
# 充电枪情况中订单详情
请求地址:
请求方式:
入参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ---- |
| | | | |
反参
| 字段名 | 类型 | 是否必传 | 备注 |
| ------ | ---- | -------- | ------------ |
| | | Y | 创建订单时间 |
| | | Y | 开始充电时间 |
| | | Y | 充电完成时间 |
| | | Y | 充电完成原因 |
| | | Y | 生成账单时间 |
| | | Y | 支付完成时间 |
| | | Y | 结算完成时间 |
| | | Y | 订单号 |
| | | Y | 场站名称 |
| | | Y | 订单来源 |
| | | Y | 外部订单号 |
| | | Y | 启动方式 |
| | | Y | 充电桩号 |
| | | Y | 充电枪口号 |
| | | Y | 结束SOC% |
| | | Y | 时长(分钟) |
| | | Y | 充电量(度) |
| | | Y | 停止原因 |
1、预约充电结束时间不选择即为充满自停
2、充电中的数据下拉不刷新
3、预约充电显示预约状态成功预约中失败
4、预约充电订单目前不显示实时充电数据
5、桩主需要能看到桩的实时状态