Snippets

OICP 2.1 Push EVSE Data | XML

Created by Gregor Schermuly last modified Julius Poessnecker
(0) OICP
Raw 
1
2
3
4
5
6
7
The service description can be found in the OICP 2.1 (CPO).

Section:
3.3.1 eRoamingPushEVSEData

To download the latest OICP Version, please visit our website:
https://www.hubject.com/downloads/
(1) Description
Raw 
1
2
3
4
5
6
7
8
Using the eRoamingPushEvseData message a charge point operator (CPO) can manage its list of EVSEs at Hubject. Possible management operations are:
•	fullLoad Replace all stored data with the new data transmitted. An empty list is allowed and will have the same result as a 'delete all' operation.
•	Update Update any existing data with the transmitted data. Inserting new data is not allowed and will lead to an data transaction error.
•	Insert Insert new data. Existing data will not be changed and will lead to an data transaction error.
•	Delete Remove the transmitted data from the server list.

The desired management operation is encoded within the XML-tag 'ActionType'. Every operation will result in a new version of the previous data set. Therefore it is possible (for Hubject) to reconstruct the data sets for any given point in the past. This automatic data versioning does not allow to send concurrent messages. Any of this operations MUST always be used sequentially.
The field 'OperatorID' within the 'OperatorEvseData' XML-tag must be a valid EVSE OperatorID for your account. This means it is either your OperatorID or the OperatorID of any Sub-CPO, if your are acting as a aggregation hub. In the same way any EVSE Id used in the 'EvseDataRecord' XML-tags must comply with a valid OperatorID. Using invalid OperatorIDs will lead to data transaction errors.
(2) Push EVSE Data | XML.xml
Raw 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<soapenv:Envelope xmlns:soapenv     = "http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:EVSEData    = "http://www.hubject.com/b2b/services/evsedata/v2.1"
                  xmlns:CommonTypes = "http://www.hubject.com/b2b/services/commontypes/v2.0">

   <soapenv:Header/>

   <soapenv:Body>
      <EVSEData:eRoamingPushEvseData>

         <EVSEData:ActionType>fullLoad|update|insert|delete</EVSEData:ActionType>

         <EVSEData:OperatorEvseData>

            <EVSEData:OperatorID>DE*GEF</EVSEData:OperatorID>
            <!--Optional:-->
            <EVSEData:OperatorName>Test-CPO</EVSEData:OperatorName>

            <!--One or more repetitions:-->
            <EVSEData:EvseDataRecord>

               <EVSEData:EvseId>DE*GEF*E123456789*1</EVSEData:EvseId>
               <!--Optional:-->
               <EVSEData:ChargingStationId>DE*GEF*S123456789</EVSEData:ChargingStationId>
               <!--Optional:-->
               <EVSEData:ChargingStationName>Testbox1</EVSEData:ChargingStationName>
               <!--Optional:-->
               <EVSEData:EnChargingStationName>Testbox One</EVSEData:EnChargingStationName>

               <EVSEData:Address>
                  <CommonTypes:Country>DE</CommonTypes:Country>
                  <CommonTypes:City>Jena</CommonTypes:City>
                  <CommonTypes:Street>Biberweg</CommonTypes:Street>
                  <!--Optional:-->
                  <CommonTypes:PostalCode>07749</CommonTypes:PostalCode>
                  <!--Optional:-->
                  <CommonTypes:HouseNum>18</CommonTypes:HouseNum>
                  <!--Optional:-->
                  <CommonTypes:Floor>2</CommonTypes:Floor>
                  <!--Optional:-->
                  <CommonTypes:Region>?</CommonTypes:Region>
                  <!--Optional:-->
                  <CommonTypes:TimeZone>?</CommonTypes:TimeZone>
               </EVSEData:Address>

               <EVSEData:GeoCoordinates>
                  <!--You have a CHOICE of the next 3 items at this level. All are WGS84.-->

                  <CommonTypes:Google>
                     <!-- latitude longitude: -?1?\d{1,2}\.\d{1,6}\s*\,?\s*-?1?\d{1,2}\.\d{1,6} -->
                     <CommonTypes:Coordinates>50.931844 11.625214</CommonTypes:Coordinates>
                  </CommonTypes:Google>

                  <CommonTypes:DecimalDegree>
                     <!-- -?1?\d{1,2}\.\d{1,6} -->
                     <CommonTypes:Longitude>11.625214</CommonTypes:Longitude>
                     <CommonTypes:Latitude >50.931844</CommonTypes:Latitude>
                  </CommonTypes:DecimalDegree>

                  <CommonTypes:DegreeMinuteSeconds>
                     <!-- -?1?\d{1,2}°[ ]?\d{1,2}'[ ]?\d{1,2}\.\d+'' -->
                     <CommonTypes:Longitude>11° 37' 30.7704''</CommonTypes:Longitude>
                     <CommonTypes:Latitude >50° 55' 54.6384''</CommonTypes:Latitude>
                  </CommonTypes:DegreeMinuteSeconds>

               </EVSEData:GeoCoordinates>

               <EVSEData:Plugs>
                  <!--1 or more repetitions:-->
                  <EVSEData:Plug>Unspecified</EVSEData:Plug>
                  <EVSEData:Plug>Small Paddle Inductive</EVSEData:Plug>
                  <EVSEData:Plug>Large Paddle Inductive</EVSEData:Plug>
                  <EVSEData:Plug>AVCONConnector</EVSEData:Plug>
                  <EVSEData:Plug>TeslaConnector</EVSEData:Plug>
                  <EVSEData:Plug>NEMA 5-20</EVSEData:Plug>
                  <EVSEData:Plug>Type E French Standard</EVSEData:Plug>
                  <EVSEData:Plug>Type F Schuko</EVSEData:Plug>
                  <EVSEData:Plug>Type G British Standard</EVSEData:Plug>
                  <EVSEData:Plug>Type J Swiss Standard</EVSEData:Plug>
                  <EVSEData:Plug>Type 1 Connector (Cable Attached)</EVSEData:Plug>
                  <EVSEData:Plug>Type 2 Outlet</EVSEData:Plug>
                  <EVSEData:Plug>Type 2 Connector (Cable Attached)</EVSEData:Plug>
                  <EVSEData:Plug>Type 3 Outlet</EVSEData:Plug>
                  <EVSEData:Plug>IEC 60309 Single Phase</EVSEData:Plug>
                  <EVSEData:Plug>IEC 60309 Three Phase</EVSEData:Plug>
                  <EVSEData:Plug>CCS Combo 2 Plug (Cable Attached)</EVSEData:Plug>
                  <EVSEData:Plug>CCS Combo 1 Plug (Cable Attached)</EVSEData:Plug>
                  <EVSEData:Plug>CHAdeMO DC CHAdeMO Connector</EVSEData:Plug>
               </EVSEData:Plugs>

               <!--Optional:-->
               <EVSEData:ChargingFacilities>
                  <!--1 or more repetitions:-->
                  <EVSEData:ChargingFacility>Unspecified</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>100 - 120V, 1-Phase ≤ 10A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>100 - 120V, 1-Phase ≤ 16A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>100 - 120V, 1-Phase ≤ 32A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>200 - 240V, 1-Phase ≤ 10A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>200 - 240V, 1-Phase ≤ 16A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>200 - 240V, 1-Phase ≤ 32A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>200 - 240V, 1-Phase > 32A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>380 - 480V, 3-Phase ≤ 16A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>380 - 480V, 3-Phase ≤ 32A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>380 - 480V, 3-Phase ≤ 63A</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>Battery exchange</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>DC Charging ≤ 20kW</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>DC Charging ≤ 50kW</EVSEData:ChargingFacility>
                  <EVSEData:ChargingFacility>DC Charging > 50kW</EVSEData:ChargingFacility>
               </EVSEData:ChargingFacilities>

               <!--Optional:-->
               <EVSEData:ChargingModes>
                  <!--1 or more repetitions:-->
                  <EVSEData:ChargingMode>Mode_1</EVSEData:ChargingMode>
                  <EVSEData:ChargingMode>Mode_2</EVSEData:ChargingMode>
                  <EVSEData:ChargingMode>Mode_3</EVSEData:ChargingMode>
                  <EVSEData:ChargingMode>Mode_4</EVSEData:ChargingMode>
                  <EVSEData:ChargingMode>CHAdeMO</EVSEData:ChargingMode>
               </EVSEData:ChargingModes>

               <EVSEData:AuthenticationModes>
                  <!--1 or more repetitions:-->
                  <EVSEData:AuthenticationMode>NFC_RFID_Classic</EVSEData:AuthenticationMode>
                  <EVSEData:AuthenticationMode>NFC_RFID_DESFire</EVSEData:AuthenticationMode>
                  <EVSEData:AuthenticationMode>PnC</EVSEData:AuthenticationMode>
                  <EVSEData:AuthenticationMode>REMOTE</EVSEData:AuthenticationMode>
                  <EVSEData:AuthenticationMode>DirectPayment</EVSEData:AuthenticationMode>
               </EVSEData:AuthenticationModes>

               <!--Optional, kWh Integer-->
               <EVSEData:MaxCapacity>11</EVSEData:MaxCapacity>

               <!--Optional:-->
               <EVSEData:PaymentOptions>
                  <!--1 or more repetitions:-->
                  <EVSEData:PaymentOption>NoPayment</EVSEData:PaymentOption>
                  <EVSEData:PaymentOption>Direct</EVSEData:PaymentOption>
                  <EVSEData:PaymentOption>SMS</EVSEData:PaymentOption>
                  <EVSEData:PaymentOption>Cash</EVSEData:PaymentOption>
                  <EVSEData:PaymentOption>CreditCard</EVSEData:PaymentOption>
                  <EVSEData:PaymentOption>Contract</EVSEData:PaymentOption>
               </EVSEData:PaymentOptions>

               <EVSEData:EVSEData:ValueAddedServices>
                  <!--1 or more repetitions:-->
                  <EVSEData:ValueAddedService>Reservation</EVSEData:ValueAddedService>
                  <EVSEData:ValueAddedService>DynamicPricing</EVSEData:ValueAddedService>
                  <EVSEData:ValueAddedService>ParkSensors</EVSEData:ValueAddedService>
                  <EVSEData:ValueAddedService>MaximumPowerCharging</EVSEData:ValueAddedService>
                  <EVSEData:ValueAddedService>PredictiveChargePointUsage</EVSEData:ValueAddedService>
                  <EVSEData:ValueAddedService>ChargingPlans</EVSEData:ValueAddedService>
                  <EVSEData:ValueAddedService>None</EVSEData:ValueAddedService>
              </EVSEData:ValueAddedServices>

               <EVSEData:Accessibility>Free publicly accessible|
                                       Restricted access|
                                       Paying publicly accessible</EVSEData:Accessibility>

               <!-- \+[0-9]{5,15} -->
               <EVSEData:HotlinePhoneNum>+493078893200</EVSEData:HotlinePhoneNum>

               <!--Optional:-->
               <EVSEData:AdditionalInfo>Nur zum Laden von Spielzeugautos geeignet.</EVSEData:AdditionalInfo>
               <!--Optional:-->
               <EVSEData:EnAdditionalInfo>For charging electric toy cars only.</EVSEData:EnAdditionalInfo>

               <!--Optional:-->
               <EVSEData:GeoChargingPointEntrance>
                  <!--You have a CHOICE of the next 3 items at this level. All are WGS84.-->

                  <CommonTypes:Google>
                     <!-- latitude longitude: -?1?\d{1,2}\.\d{1,6}\s*\,?\s*-?1?\d{1,2}\.\d{1,6} -->
                     <CommonTypes:Coordinates>50.931844 11.625214</CommonTypes:Coordinates>
                  </CommonTypes:Google>

                  <CommonTypes:DecimalDegree>
                     <!-- -?1?\d{1,2}\.\d{1,6} -->
                     <CommonTypes:Longitude>11.625214</CommonTypes:Longitude>
                     <CommonTypes:Latitude >50.931844</CommonTypes:Latitude>
                  </CommonTypes:DecimalDegree>

                  <CommonTypes:DegreeMinuteSeconds>
                     <!-- -?1?\d{1,2}°[ ]?\d{1,2}'[ ]?\d{1,2}\.\d+'' -->
                     <CommonTypes:Longitude>11° 37' 30.7704''</CommonTypes:Longitude>
                     <CommonTypes:Latitude >50° 55' 54.6384''</CommonTypes:Latitude>
                  </CommonTypes:DegreeMinuteSeconds>

               </EVSEData:GeoChargingPointEntrance>

               <EVSEData:IsOpen24Hours>true|false</EVSEData:IsOpen24Hours>
               <!--Optional:-->
               <EVSEData:OpeningTime>?</EVSEData:OpeningTime>

               <!--Optional:-->
               <EVSEData:HubOperatorID>?</EVSEData:HubOperatorID>
               <!--Optional:-->
               <EVSEData:ClearinghouseID>?</EVSEData:ClearinghouseID>

               <EVSEData:IsHubjectCompatible>true|false</EVSEData:IsHubjectCompatible>
               <EVSEData:DynamicInfoAvailable>true|false|auto</EVSEData:DynamicInfoAvailable>

            </EVSEData:EvseDataRecord>
         </EVSEData:OperatorEvseData>
      </EVSEData:eRoamingPushEvseData>
   </soapenv:Body>

</soapenv:Envelope>
(3) Expected Response.xml
Raw 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
<soapenv:Envelope xmlns:soapenv     = "http://schemas.xmlsoap.org/soap/envelope/"
                  xmlns:CommonTypes = "http://www.hubject.com/b2b/services/commontypes/v2.0">

    <soapenv:Body>

        <CommonTypes:eRoamingAcknowledgement>

            <CommonTypes:Result>true|false</CommonTypes:Result>

            <CommonTypes:StatusCode>
                <CommonTypes:Code>000</CommonTypes:Code>
                <CommonTypes:Description>Success</CommonTypes:Description>
                <CommonTypes:AdditionalInfo />
            </CommonTypes:StatusCode>

        </CommonTypes:eRoamingAcknowledgement>
    </soapenv:Body>

</soapenv:Envelope>

Comments (0)

HTTPS SSH

You can clone a snippet to your computer for local editing. Learn more.