chargeStation.doc.md 58 KB

Factory-gateway

v1.0.0

Base URLs:

Client

GET /api/v1/clients/chargestations/resources/info

GET /api/v1/clients/chargestations/resources/info

    @param whichStation 根據輸入的時間,更新充電樁信息
    @returns 有變動的充電樁信息

请求参数

名称 位置 类型 必选 说明
LastQueryTime query string 格式“yyyy-MM-dd HH:mm:ss”,可以为空,如果不填写,则查询所有的充电站信息如果此时间之后数据没有变化将返回ItemSize为0
PageNo query number none
PageSize query number none

返回示例

200 Response

{
  "PageNo": 0,
  "PageCount": 0,
  "ItemSize": 0,
  "StationInfos": [
    {
      "StationID": "string",
      "OperatorID": "string",
      "EquipmentOwnerID": "string",
      "StationName": "string",
      "CountryCode": "string",
      "AreaCode": "string",
      "Address": "string",
      "StationTel": "string",
      "ServiceTel": "string",
      "StationType": 0,
      "StationStatus": 0,
      "ParkNums": 0,
      "StationLng": 0,
      "StationLat": "string",
      "SiteGuide": "string",
      "Construction": 0,
      "Pictures": ["string"],
      "MatchCars": "string",
      "ParkInfo": "string",
      "BusineHours": "string",
      "ElectricityFee": "string",
      "ServiceFee": "string",
      "ParkFee": "string",
      "Payment": "string",
      "SupportOrder": 0,
      "Remark": "string",
      "EquipmentInfos": [
        {
          "EquipmentID": "string",
          "ManufacturerID": "string",
          "ManufacturerName": "string",
          "EquipmentMode": "string",
          "ProductionDate": "string",
          "EquipmentType": 0,
          "ConnectorInfos": [
            {
              "ConnectorID": "string",
              "ConnectorName": "string",
              "ConnectorType": 0,
              "VoltageUpperLimits": 0,
              "VoltageLowerLimits": 0,
              "Current": 0,
              "Power": 0,
              "ParkNo": "string",
              "NationalStandard": 0
            }
          ],
          "EquipmentLng": "string",
          "EquipmentLat": "string",
          "Power": 0,
          "EquipmentName": "string"
        }
      ]
    }
  ]
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 StationsInfoResponseDto
500 Internal Server Error 500 ErrorResponseDto

GET /api/v1/clients/chargestations/resources/status

GET /api/v1/clients/chargestations/resources/status

    @param stationIDs 需要查詢的充電樁ID
    @returns  被查詢的充電樁信息

请求参数

名称 位置 类型 必选 说明
StationIDs query array[string] none

返回示例

200 Response

[
  {
    "StationID": "string",
    "OperatorID": "string",
    "EquipmentOwnerID": "string",
    "StationName": "string",
    "CountryCode": "string",
    "AreaCode": "string",
    "Address": "string",
    "StationTel": "string",
    "ServiceTel": "string",
    "StationType": 0,
    "StationStatus": 0,
    "ParkNums": 0,
    "StationLng": 0,
    "StationLat": "string",
    "SiteGuide": "string",
    "Construction": 0,
    "Pictures": ["string"],
    "MatchCars": "string",
    "ParkInfo": "string",
    "BusineHours": "string",
    "ElectricityFee": "string",
    "ServiceFee": "string",
    "ParkFee": "string",
    "Payment": "string",
    "SupportOrder": 0,
    "Remark": "string",
    "EquipmentInfos": {
      "EquipmentID": "string",
      "ManufacturerID": "string",
      "ManufacturerName": "string",
      "EquipmentMode": "string",
      "ProductionDate": "string",
      "EquipmentType": 0,
      "ConnectorInfos": {
        "ConnectorID": "string",
        "ConnectorName": "string",
        "ConnectorType": 0,
        "VoltageUpperLimits": 0,
        "VoltageLowerLimits": 0,
        "Current": 0,
        "Power": 0,
        "ParkNo": "string",
        "NationalStandard": 0
      },
      "EquipmentLng": "string",
      "EquipmentLat": "string",
      "Power": 0,
      "EquipmentName": "string"
    }
  }
]

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 Inline
500 Internal Server Error 500 ErrorResponseDto

返回数据结构

状态码 200

名称 类型 必选 约束 中文名 说明
anonymous [StationInfoDto] false none none
» StationID string true none 运营商自定义的唯一编码
» OperatorID string true none 运营商ID
» EquipmentOwnerID string true none 运营商ID
» StationName string true none 充电站名称的描述
» CountryCode string true none 充电站国家代码 比如CN
» AreaCode string true none 充电站省市辖区编码 填写内容为参照 GB/T 2260—2007
» Address string true none 详细地址
» StationTel string true none 站点电话 能够联系场站工作人员进行协助的联系电话
» ServiceTel string true none 服务电话 平台服务电话,例如400的电话
» StationType number true none 站点类型 1:公共:
50:个人;
100:公交(专用);
101:环卫(专用);
102:物流(专用);
103:出租车(专用);
255:其他
» StationStatus number true none 站点状态 0:未知;
1:建设中;
5:关闭下线;
6:维护中;
50:正常使用
» ParkNums number true none 车位数量 可停放进行充电的车位总数, 默认:0未知
» StationLng number true none 经度 GCJ-02坐标系
» StationLat string true none 纬度 GCJ-02坐标系
» SiteGuide string true none 站点引导 描述性文字,用于引导车主找到充电车位
» Construction number true none 建设场所 1:居民区;
2:公共机构
3:企事业单位;
4:写字楼;
5:工业园区;
6:交通枢纽;
7:大型文体设施;
8:城市绿地;
9:大型建筑配建停车场;10:路边停车位;
11:城际高速服务区
255:其他
» Pictures [string] false none 充电设备照片、充电车位照片、停车场入口照片
» MatchCars string false none 描述该站点接受的车大小以及类型,如大巴、物流车、私家乘用车、出租车等
» ParkInfo string false none 车位楼层以及数量信息
» BusineHours string false none 营业时间描述
» ElectricityFee string false none 充电电费率 充电费描述
» ServiceFee string false none 服务费率描述
» ParkFee string false none 停车费率描述
» Payment string false none 支付方式:刷卡、线上、现金。 其中电子钱包类卡为刷卡,身份 鉴权卡、微信/支付宝、APP为线上
» SupportOrder number false none 充电设备是否需要提前预约后才能使用。0为不支持预约;1为支持预约。不填默认为0
» Remark string false none 其他备注信息
» EquipmentInfos EquipmentDto true none 该充电站所有充电设备信息对象集合
»» EquipmentID string true none 设备唯一编码,对同一运营商,保证唯一
»» ManufacturerID string false none 设备生产商组织机构代码
»» ManufacturerName string false none 设备生产商的名称
»» EquipmentMode string false none 由设备生产商定义的设备型号
»» ProductionDate string false none 设备生产日期 YYYY-MM-DD
»» EquipmentType number true none 设备类型
1:直流设备;
2:交流设备;
3:交直流一体设备;
4:无线设备;
5:其他
»» ConnectorInfos ConnectorInfoDto true none 该充电设备所有的充电设备接口的信息对象集合
»»» ConnectorID string true none 充电设备接口编码,同一运营商内唯一
»»» ConnectorName string false none none
»»» ConnectorType number true none 1:家用插座(模式2);
2:交流接口插座(模式3,连接方式B);
3:交流接口插头(带枪线, 模式3,连接方式C);
4:直流接口枪头(带枪线, 模式4);
5:无线充电座;
6:其他
»»» VoltageUpperLimits number true none 单位: V
»»» VoltageLowerLimits number true none 单位: V
»»» Current number true none 单位: A
»»» Power number true none 单位: kW
»»» ParkNo string false none 停车场车位编号
»»» NationalStandard number true none 1: 2011
2: 2015
»» EquipmentLng string false none 充电设备经度 GCJ-02坐标系
»» EquipmentLat string false none 充电设备纬度 GCJ-02坐标系
»» Power number false none 充电设备总功率 单位: kW
»» EquipmentName string false none 充电设备名称

PUT /api/v1/clients/chargestations/resources/charge/start

PUT /api/v1/clients/chargestations/resources/charge/start

    遠程開啟充電樁充電功能,必須在充電樁設備處於‘7’時調用
    @returns  啟動結果

Body 请求参数

{
  "StartChargeSeq": "string",
  "ConnectorID": "string",
  "StopBy": 0,
  "StopValue": 0,
  "StartBalance": 0
}

请求参数

名称 位置 类型 必选 说明
body body StartChargeRequestDto none

返回示例

200 Response

{
  "StartChargeSeq": "string",
  "StartChargeSeqStat": 0,
  "ConnectorID": "string",
  "SuccStat": 0,
  "FailReason": 0
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 StartChargeResponseDto
500 Internal Server Error 500 ErrorResponseDto

GET /api/v1/clients/chargestations/resources/equip/status

GET /api/v1/clients/chargestations/resources/equip/status

    查询充电状态
    StartChargeSeq: 充电订单号

请求参数

名称 位置 类型 必选 说明
StartChargeSeq query string none

返回示例

200 Response

{
  "StartChargeSeq": "string",
  "StartChargeSeqStat": 0,
  "ConnectorID": "string",
  "ConnectorStatus": 0,
  "CurrentA": 0,
  "CurrentB": 0,
  "CurrentC": 0,
  "VoltageA": 0,
  "VoltageB": 0,
  "VoltageC": 0,
  "Soc": 0,
  "StartTime": "string",
  "EndTime": "string",
  "TotalPower": 0,
  "ElecMoney": 0,
  "SeviceMoney": 0,
  "TotalMoney": 0,
  "PriceModelID": 0,
  "PeakKwh": 0,
  "PeakCharge": 0,
  "PeakService": 0,
  "RushKwh": 0,
  "RushCharge": 0,
  "RushService": 0,
  "ElseKwh": 0,
  "ElseCharge": 0,
  "ElseService": 0,
  "OffKwh": 0,
  "OffCharge": 0,
  "OffService": 0
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 EquipChargeStatusResponseDto
500 Internal Server Error 500 ErrorResponseDto

PUT /api/v1/clients/chargestations/resources/charge/stop

PUT /api/v1/clients/chargestations/resources/charge/stop

    请求远程停止充电

Body 请求参数

{
  "StartChargeSeq": "string",
  "ConnectorID": "string"
}

请求参数

名称 位置 类型 必选 说明
body body StopChargeRequestDto none

返回示例

200 Response

{
  "StartChargeSeq": "string",
  "StartChargeSeqStat": 0,
  "SuccStat": 0,
  "FailReason": 0
}

返回结果

状态码 状态码含义 说明 数据模型
200 OK 成功 StopChargeResponseDto
500 Internal Server Error 500 ErrorResponseDto

数据模型

StopChargeResponseDto

{
  "StartChargeSeq": "string",
  "StartChargeSeqStat": 0,
  "SuccStat": 0,
  "FailReason": 0
}

属性

名称 类型 必选 约束 中文名 说明
StartChargeSeq string true none 格式“运营商ID+唯一编号”,27字符 , 见2.5
StartChargeSeqStat number true none 1:启动中;
2:充电中;
3:停止中;
4:已结束
5:未知
SuccStat number true none 0:成功;
1:失败
FailReason number true none 0: 无
1:此设备不存在
2:此设备离线
3:设备状态不正确
4: 订单号重复
5:订单号无效
99: 其它

StopChargeRequestDto

{
  "StartChargeSeq": "string",
  "ConnectorID": "string"
}

属性

名称 类型 必选 约束 中文名 说明
StartChargeSeq string true none 格式“运营商ID+唯一编号”,27字符 , 见2.5
ConnectorID string true none 接口中所有充电接口标识(ConnectorID)均为甲方建档生成的18位充电枪编号。甲方为乙方建档后乙方可在设备屏幕上或甲方后台系统中查询,乙方也可通过API获取。

EquipChargeStatusResponseDto

{
  "StartChargeSeq": "string",
  "StartChargeSeqStat": 0,
  "ConnectorID": "string",
  "ConnectorStatus": 0,
  "CurrentA": 0,
  "CurrentB": 0,
  "CurrentC": 0,
  "VoltageA": 0,
  "VoltageB": 0,
  "VoltageC": 0,
  "Soc": 0,
  "StartTime": "string",
  "EndTime": "string",
  "TotalPower": 0,
  "ElecMoney": 0,
  "SeviceMoney": 0,
  "TotalMoney": 0,
  "PriceModelID": 0,
  "PeakKwh": 0,
  "PeakCharge": 0,
  "PeakService": 0,
  "RushKwh": 0,
  "RushCharge": 0,
  "RushService": 0,
  "ElseKwh": 0,
  "ElseCharge": 0,
  "ElseService": 0,
  "OffKwh": 0,
  "OffCharge": 0,
  "OffService": 0
}

属性

名称 类型 必选 约束 中文名 说明
StartChargeSeq string true none none
StartChargeSeqStat number true none none
ConnectorID string true none none
ConnectorStatus number true none none
CurrentA number true none none
CurrentB number false none none
CurrentC number false none none
VoltageA number true none none
VoltageB number false none none
VoltageC number false none none
Soc number true none none
StartTime string true none none
EndTime string true none none
TotalPower number true none none
ElecMoney number false none none
SeviceMoney number false none none
TotalMoney number false none none
PriceModelID number true none none
PeakKwh number true none none
PeakCharge number true none none
PeakService number true none none
RushKwh number true none none
RushCharge number true none none
RushService number true none none
ElseKwh number true none none
ElseCharge number true none none
ElseService number true none none
OffKwh number true none none
OffCharge number true none none
OffService number true none none

StartChargeResponseDto

{
  "StartChargeSeq": "string",
  "StartChargeSeqStat": 0,
  "ConnectorID": "string",
  "SuccStat": 0,
  "FailReason": 0
}

属性

名称 类型 必选 约束 中文名 说明
StartChargeSeq string true none 格式“运营商ID+唯一编号”,27字符 , 见2.5
StartChargeSeqStat number true none 1:启动中;
2:充电中;
3:停止中;
4:已结束
5:未知
ConnectorID string true none 接口中所有充电接口标识(ConnectorID)均为甲方建档生成的18位充电枪编号。甲方为乙方建档后乙方可在设备屏幕上或甲方后台系统中查询,乙方也可通过API获取。
SuccStat number true none 0:成功;
1:失败
FailReason number true none 0: 无
1:此设备不存在
2:此设备离线
3:设备状态不正确
4: 订单号重复
5:订单号无效
99: 其它

StartChargeRequestDto

{
  "StartChargeSeq": "string",
  "ConnectorID": "string",
  "StopBy": 0,
  "StopValue": 0,
  "StartBalance": 0
}

属性

名称 类型 必选 约束 中文名 说明
StartChargeSeq string true none 格式“运营商ID+唯一编号”,27字符 , 见2.5
ConnectorID string true none 接口中所有充电接口标识(ConnectorID)均为甲方建档生成的18位充电枪编号。甲方为乙方建档后乙方可在设备屏幕上或甲方后台系统中查询,乙方也可通过API获取。
StopBy number true none 0: 充满停止
1: 电量(kwh);
2: 时长(分钟);
3: 金额(元)
StopValue number true none 对应stopBy的停止数值(充满停止置0,电量停止为最大充电电量,时长停止为最大充电分钟数,金额停止为最大充电金额)
StartBalance number true none 保留二位小数。无论何种停止方式,总费用达到此金额后设备立即结束充电

StationInfoDto

{
  "StationID": "string",
  "OperatorID": "string",
  "EquipmentOwnerID": "string",
  "StationName": "string",
  "CountryCode": "string",
  "AreaCode": "string",
  "Address": "string",
  "StationTel": "string",
  "ServiceTel": "string",
  "StationType": 0,
  "StationStatus": 0,
  "ParkNums": 0,
  "StationLng": 0,
  "StationLat": "string",
  "SiteGuide": "string",
  "Construction": 0,
  "Pictures": ["string"],
  "MatchCars": "string",
  "ParkInfo": "string",
  "BusineHours": "string",
  "ElectricityFee": "string",
  "ServiceFee": "string",
  "ParkFee": "string",
  "Payment": "string",
  "SupportOrder": 0,
  "Remark": "string",
  "EquipmentInfos": [
    {
      "EquipmentID": "string",
      "ManufacturerID": "string",
      "ManufacturerName": "string",
      "EquipmentMode": "string",
      "ProductionDate": "string",
      "EquipmentType": 0,
      "ConnectorInfos": [
        {
          "ConnectorID": "string",
          "ConnectorName": "string",
          "ConnectorType": 0,
          "VoltageUpperLimits": 0,
          "VoltageLowerLimits": 0,
          "Current": 0,
          "Power": 0,
          "ParkNo": "string",
          "NationalStandard": 0
        }
      ],
      "EquipmentLng": "string",
      "EquipmentLat": "string",
      "Power": 0,
      "EquipmentName": "string"
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
StationID string true none 运营商自定义的唯一编码
OperatorID string true none 运营商ID
EquipmentOwnerID string true none 运营商ID
StationName string true none 充电站名称的描述
CountryCode string true none 充电站国家代码 比如CN
AreaCode string true none 充电站省市辖区编码 填写内容为参照 GB/T 2260—2007
Address string true none 详细地址
StationTel string true none 站点电话 能够联系场站工作人员进行协助的联系电话
ServiceTel string true none 服务电话 平台服务电话,例如400的电话
StationType number true none 站点类型 1:公共:
50:个人;
100:公交(专用);
101:环卫(专用);
102:物流(专用);
103:出租车(专用);
255:其他
StationStatus number true none 站点状态 0:未知;
1:建设中;
5:关闭下线;
6:维护中;
50:正常使用
ParkNums number true none 车位数量 可停放进行充电的车位总数, 默认:0未知
StationLng number true none 经度 GCJ-02坐标系
StationLat string true none 纬度 GCJ-02坐标系
SiteGuide string true none 站点引导 描述性文字,用于引导车主找到充电车位
Construction number true none 建设场所 1:居民区;
2:公共机构
3:企事业单位;
4:写字楼;
5:工业园区;
6:交通枢纽;
7:大型文体设施;
8:城市绿地;
9:大型建筑配建停车场;10:路边停车位;
11:城际高速服务区
255:其他
Pictures [string] false none 充电设备照片、充电车位照片、停车场入口照片
MatchCars string false none 描述该站点接受的车大小以及类型,如大巴、物流车、私家乘用车、出租车等
ParkInfo string false none 车位楼层以及数量信息
BusineHours string false none 营业时间描述
ElectricityFee string false none 充电电费率 充电费描述
ServiceFee string false none 服务费率描述
ParkFee string false none 停车费率描述
Payment string false none 支付方式:刷卡、线上、现金。 其中电子钱包类卡为刷卡,身份 鉴权卡、微信/支付宝、APP为线上
SupportOrder number false none 充电设备是否需要提前预约后才能使用。0为不支持预约;1为支持预约。不填默认为0
Remark string false none 其他备注信息
EquipmentInfos EquipmentDto true none 该充电站所有充电设备信息对象集合

EquipmentDto

{
  "EquipmentID": "string",
  "ManufacturerID": "string",
  "ManufacturerName": "string",
  "EquipmentMode": "string",
  "ProductionDate": "string",
  "EquipmentType": 0,
  "ConnectorInfos": [
    {
      "ConnectorID": "string",
      "ConnectorName": "string",
      "ConnectorType": 0,
      "VoltageUpperLimits": 0,
      "VoltageLowerLimits": 0,
      "Current": 0,
      "Power": 0,
      "ParkNo": "string",
      "NationalStandard": 0
    }
  ],
  "EquipmentLng": "string",
  "EquipmentLat": "string",
  "Power": 0,
  "EquipmentName": "string"
}

属性

名称 类型 必选 约束 中文名 说明
EquipmentID string true none 设备唯一编码,对同一运营商,保证唯一
ManufacturerID string false none 设备生产商组织机构代码
ManufacturerName string false none 设备生产商的名称
EquipmentMode string false none 由设备生产商定义的设备型号
ProductionDate string false none 设备生产日期 YYYY-MM-DD
EquipmentType number true none 设备类型
1:直流设备;
2:交流设备;
3:交直流一体设备;
4:无线设备;
5:其他
ConnectorInfos ConnectorInfoDto true none 该充电设备所有的充电设备接口的信息对象集合
EquipmentLng string false none 充电设备经度 GCJ-02坐标系
EquipmentLat string false none 充电设备纬度 GCJ-02坐标系
Power number false none 充电设备总功率 单位: kW
EquipmentName string false none 充电设备名称

ConnectorInfoDto

{
  "ConnectorID": "string",
  "ConnectorName": "string",
  "ConnectorType": 0,
  "VoltageUpperLimits": 0,
  "VoltageLowerLimits": 0,
  "Current": 0,
  "Power": 0,
  "ParkNo": "string",
  "NationalStandard": 0
}

属性

名称 类型 必选 约束 中文名 说明
ConnectorID string true none 充电设备接口编码,同一运营商内唯一
ConnectorName string false none none
ConnectorType number true none 1:家用插座(模式2);
2:交流接口插座(模式3,连接方式B);
3:交流接口插头(带枪线, 模式3,连接方式C);
4:直流接口枪头(带枪线, 模式4);
5:无线充电座;
6:其他
VoltageUpperLimits number true none 单位: V
VoltageLowerLimits number true none 单位: V
Current number true none 单位: A
Power number true none 单位: kW
ParkNo string false none 停车场车位编号
NationalStandard number true none 1: 2011
2: 2015

ErrorResponseDto

{
  "code": 0,
  "msg": "string"
}

属性

名称 类型 必选 约束 中文名 说明
code number true none Error Code
msg string true none Error message

StationsInfoResponseDto

{
  "PageNo": 0,
  "PageCount": 0,
  "ItemSize": 0,
  "StationInfos": [
    {
      "StationID": "string",
      "OperatorID": "string",
      "EquipmentOwnerID": "string",
      "StationName": "string",
      "CountryCode": "string",
      "AreaCode": "string",
      "Address": "string",
      "StationTel": "string",
      "ServiceTel": "string",
      "StationType": 0,
      "StationStatus": 0,
      "ParkNums": 0,
      "StationLng": 0,
      "StationLat": "string",
      "SiteGuide": "string",
      "Construction": 0,
      "Pictures": ["string"],
      "MatchCars": "string",
      "ParkInfo": "string",
      "BusineHours": "string",
      "ElectricityFee": "string",
      "ServiceFee": "string",
      "ParkFee": "string",
      "Payment": "string",
      "SupportOrder": 0,
      "Remark": "string",
      "EquipmentInfos": [
        {
          "EquipmentID": "string",
          "ManufacturerID": "string",
          "ManufacturerName": "string",
          "EquipmentMode": "string",
          "ProductionDate": "string",
          "EquipmentType": 0,
          "ConnectorInfos": [
            {
              "ConnectorID": "string",
              "ConnectorName": "string",
              "ConnectorType": 0,
              "VoltageUpperLimits": 0,
              "VoltageLowerLimits": 0,
              "Current": 0,
              "Power": 0,
              "ParkNo": "string",
              "NationalStandard": 0
            }
          ],
          "EquipmentLng": "string",
          "EquipmentLat": "string",
          "Power": 0,
          "EquipmentName": "string"
        }
      ]
    }
  ]
}

属性

名称 类型 必选 约束 中文名 说明
PageNo number false none none
PageCount number false none none
ItemSize number false none none
StationInfos StationInfoDto false none none