Introduction

Eco-Movement Data API is an outbound API based on the market standard OCPI protocol, which makes it easy for partners and clients to connect with Eco-Movement. It is also available in the DATEX II format. This API is organized around the RESTful architecture for web services and returns XML-encoded responses.

📘
Note
For more in-depth documentation, please refer to the original DATEX II documentation.

Authorization

Each HTTP request must contain an ‘Authorization’ header. The following is a sample header:

Authorization: Token IpbJOXxkxOAuKR92z0nEcmVF3Qw09VG7I7d/WCg0koM=

The ‘Token’ literal indicates that the token based authentication mechanism was used. The parameter is a string of printable non-whitespace ASCII characters characters generated by Eco-Movement. The token uniquely identifies a user.

Pagination

The Eco-Movement Data API endpoints can return more than 100,000 locations. Hence, pagination is supported. Use the following two parameters to control the size of the response.

Parameter	Description
`limit`	Limits the number of objects that are returned. This parameter is optional and the minimum value is `1`.
`offset`	Indicates the number of items to skip. This parameter is optional and the default value is `0` (that is, the first page of the results is only returned).

For example, the maximum amount of locations that can be returned in the result is 1000. In the result's header, a link to the following 1000 locations is given. The following is an example of a link in the result's header:

<https://api.eco-movement.com/api/datexii/locations?offset=1000&limit=2000>; rel=”next”

Available Endpoint (Location)

Use the locations endpoint to retrieve a list of all locations or a specific location (using the location's id).

📘
Note
The location information is retrieved in bulk. Eco-Movement recommends that you retrieve the entire dataset once a day.

Request

The following is an example request to retrieve all locations:

https://api.eco-movement.com/api/datexii/locations

Response

The XML-based response consists of several XML namespaces, elements, and attributes.

`com:publicationCreator`

Description: Contains the ISO 3166-1 alpha-2 code for the country where Eco-Movement is established and the national identifier for Eco-Movement.

Child Elements:

Element	Data Type	Description
`country`	`xs:string`	The ISO 3166-1 alpha-2 code for the country where Eco-Movement is established
`nationalIdentifier`	`xs:string`	The national identifier for Eco-Movement.

Snippet:

<com:publicationCreator>
      <com:country>NL</com:country>
      <com:nationalIdentifier>Eco-Movement</com:nationalIdentifier>
</com:publicationCreator>

`egi:energyInfrastructureTable`

Description: Contains the energyInfrastructureSite child element, which has the details of the charging station location.

Child Elements:

Element	Data Type	Description
`egi:energyInfrastructureSite`	N/A	Contains the details of the charging station location. The `id` attribute contains the unique id for a location. The unique id is created by Eco-Movement, and it is stable. This attribute may change when two or more locations are merged, which results in one location only. For this element's child elements, see `egi:energyInfrastructureSite`.

Snippet

<egi:energyInfrastructureTable id="1" version="1">
      <egi:energyInfrastructureSite id="99c78ffc-6fc2-11ed-91ba-0242ac120004" version="1">
         ...
      </egi:energyInfrastructureSite>
</egi:energyInfrastructureTable>

`egi:energyInfrastructureSite`

Description: Contains the details of the charging station location. The id attribute contains the unique id for a location. The unique id is created by Eco-Movement, and it is stable. This attribute may change when two or more locations are merged, which results in one location only.

Parent Element: egi:energyInfrastructureTable

Child Elements:

Element	Data Type	Description
`fac:name`	N/A	Contains the name of the charging station location. For this element's child elements, see `fac:name`.
`fac:operatingHours`	N/A	Contains the operating hours details for the charging station. For this element's child elements, see `fac:operatingHours`.
`fac:locationReference`	N/A	Contains coordinates, address details, and time zone of the charging station location. For this element's child elements, see `fac:locationReference`.
`fac:operator`	N/A	Contains the operator details for the location. For this element's child elements, see `fac:operator`.
`egi:energyInfrastructureStation`	N/A	Contains the available payment methods, EVSE identifiers, and connector details for the location. For this element's child elements, see `egi:energyInfrastructureStation`.

Snippet:

<egi:energyInfrastructureSite id="'99c78ffc-6fc2-11ed-91ba-0242ac120004'" version="1">
  <fac:name>
      ...
  </fac:name>
  <fac:operatingHours xsi:type="fac:OperatingHoursSpecification" id="1" version="1">
      ...
  </fac:operatingHours>
  <fac:locationReference xsi:type="loc:PointLocation">
      ...
  </fac:locationReference>
  <fac:operator xsi:type="fac:OrganisationSpecification" id="1" version="1">
      ...
  </fac:operator>
  <egi:energyInfrastructureStation id="1" version="1">
      ...
  </egi:energyInfrastructureStation>
</egi:energyInfrastructureSite>

`fac:name`

Description: If egi:energyInfrastructureTable is the parent element, then it contains the name of the charging station location. If fac:operator is the parent element, then it contains the name of the charging station location's operator.

Parent Element: egi:energyInfrastructureTable and fac:operator

Child Elements:

Element	Data Type	Description
`com:values`	`xs:string`	The name of the charging station location or its operator name inside a `com:value` child element.

Snippet:

<fac:name>
     <com:values>
         <com:value lang="en">Powerstop - Italia</com:value>
     </com:values>
</fac:name>

`fac:operatingHours`

Description: Contains the operating hours details for the charging station.

📘
Note
The fac:operatingHours element contains an xsi:type attribute that has one of the following options:

fac:OperatingHoursSpecification - The charging station location has certain opening and closing times.

fac:UnknownOperatingHours - The operation hours for this charging station location is unknown currently.

fac:OpenAllHours - The charging station location is open 24/7.

Parent Element: egi:energyInfrastructureSite

Child Elements:

Element	Data Type	Description
`fac:overallPeriod`	N/A	Contains the details of days and times on which the charging station operates in a particular week. For this element's child elements, see `fac:overallPeriod`. Note: This child element is available only if the `xsi:type` is `fac:OperatingHoursSpecification`.

Snippet:

<fac:operatingHours xsi:type="fac:OperatingHoursSpecification" id="1" version="1">
     <fac:overallPeriod>
     ...
     </fac:overallPeriod>
</fac:operatingHours>

`fac:overallPeriod`

Description: Contains the details of days and times on which the charging station operates in a particular week.

📘
Note
fac:overallPeriod is available only if the xsi:type is fac:OperatingHoursSpecification.

Parent Element: fac:operatingHours

Child Elements:

Element	Data Type	Description
`com:overallStartTime`	`xs:dateTime`	A particular day and time on which the data was recorded for the charging station.
`com:validPeriod`	N/A	Contains a combination of starting and ending time periods and the days on which the charging station is open. For this element's child elements, see `fac:validPeriod`.

Snippet:

<fac:overallPeriod>
     <com:overallStartTime>2022-12-01T07:55:26+00:00</com:overallStartTime>
     <com:validPeriod>
     ...
     </com:validPeriod>
</fac:overallPeriod>

`com:validPeriod`

Description: Contains a combination of starting and ending time periods and the days on which the charging station is open.

Parent Element: fac:overallPeriod

Child Elements:

Element	Data Type	Description
`com:recurringTimePeriodOfDay`	N/A	Contains a combination of starting and ending time periods during which the charging station is open. For this element's child elements, see `com:recurringTimePeriodOfDay`.
`com:recurringDayWeekMonthPeriod`	N/A	Contains the day for which the time period is applicable. For this element's child elements, see `com:recurringDayWeekMonthPeriod`.

Snippet:

<com:validPeriod>
     <com:recurringTimePeriodOfDay>
     ...
     </com:recurringTimePeriodOfDay>
     <com:recurringDayWeekMonthPeriod>
     ...
     </com:recurringDayWeekMonthPeriod>
</com:validPeriod>

`com:recurringTimePeriodOfDay`

Description: Contains a combination of starting and ending time periods during which the charging station is open.

Parent Element: fac:validPeriod

Child Elements:

Element	Data Type	Description
`com:startTimeOfPeriod`	`xs:time`	The starting time of a particular time period.
`com:endTimeOfPeriod`	`xs:time`	The ending time of a particular time period.

Snippet:

<com:recurringTimePeriodOfDay>
      <com:startTimeOfPeriod>07:30:00</com:startTimeOfPeriod>
      <com:endTimeOfPeriod>11:30:00</com:endTimeOfPeriod>
</com:recurringTimePeriodOfDay>

`com:recurringDayWeekMonthPeriod`

Description: Contains the day for which the time period is applicable.

Parent Element: fac:validPeriod

Child Elements:

Element	Data Type	Description
`com:applicableDay`	`xs:string`	The day for which the time period is applicable.

Snippet:

<com:recurringDayWeekMonthPeriod>
     <com:applicableDay>monday</com:applicableDay>
</com:recurringDayWeekMonthPeriod>

`fac:locationReference`

Description: Contains the coordinates, address details, and time zone of the charging station location.

Parent Element: egi:energyInfrastructureTable

Child Elements:

Element	Data Type	Description
`loc:pointByCoordinates`	N/A	Contains the coordinates of the charging station location. For this element's child element, see `loc:pointByCoordinates`.
`loc:_pointLocationExtension`	N/A	Contains the address details and time zone of the charging station location. For this element's child element, see `loc:_pointLocationExtension`.

Snippet:

<loc:pointByCoordinates>
     <loc:pointCoordinates>
     ...
     </loc:pointCoordinates>
</loc:pointByCoordinates>

`loc:pointByCoordinates`

Description: Contains the coordinates of the charging station location.

Parent Element: fac:locationReference

Child Elements:

Element	Data Type	Description
`loc:pointCoordinates`	N/A	Contains the coordinates of the charging station location. For this element's child element, see `loc:pointCoordinates`.

Snippet:

<loc:pointByCoordinates>
    <loc:pointCoordinates>
    ...
    </loc:pointCoordinates>
</loc:pointByCoordinates>

`loc:pointCoordinates`

Description: Contains the coordinates of the charging station location.

Parent Element: loc:pointByCoordinates.

Child Elements:

Element	Data Type	Description
`loc:latitude`	`xs:string`	The latitude of the charging station location.
`loc:longitude`	`xs:string`	The longitude of the charging station location.

Snippet:

<loc:pointCoordinates>
     <loc:latitude>44.42592000</loc:latitude>
     <loc:longitude>7.55668000</loc:longitude>
</loc:pointCoordinates>

`loc:_pointLocationExtension`

Description: Contains the address details and time zone of the charging station location.

Parent Element: fac:locationReference

Child Elements:

Element	Data Type	Description
`locx:facilityLocation`	N/A	Contains the address details and time zone of the charging station location. For this element's child element, see `locx:facilityLocation`.

Snippet:

<loc:_pointLocationExtension>
     <locx:facilityLocation>
     ...
     </locx:facilityLocation>
</loc:_pointLocationExtension>

`locx:facilityLocation`

Description: Contains the address details and time zone of the charging station location.

Parent Element: fac:locationReference

Child Elements:

Element	Data Type	Description
`locx:address`	N/A	Contains the address details of the charging station location. For this element's child element, see `locx:address`.
`locx:timeZone`	`xs:string`	The time zone of the location. It is one of www.iana.org tzdata's TZ-values representing the time zone of the location.

Snippet:

<locx:facilityLocation>
      <locx:address>
      ...
      </locx:address>
      <locx:timeZone>Europe/Amsterdam</locx:timeZone>
</locx:facilityLocation>

`locx:address`

Description: Contains the address details of the charging station location.

Parent Element: locx:facilityLocation

Child Elements:

Element	Data Type	Description
`locx:postcode`	`xs:string`	The postal code where the charge point is located. It conforms to the country standard.
`locx:city`	`xs:string`	The name of the city where the charge point is located.
`locx:countryCode`	`xs:string`	The ISO 3166-1 alpha-2 code for the country of this location.
`locx:addressLine`	`xs:string`	The type of location and the address where the charge point is located.

Snippet:

<locx:address>
      <locx:postcode>12100</locx:postcode>
      <locx:city>Cuneo</locx:city>
      <locx:countryCode>IT</locx:countryCode>
      <locx:addressLine order="0">
            <locx:type>street</locx:type>
            <locx:text>Via Torino 234</locx:text>
      </locx:addressLine>
</locx:address>

`fac:operator`

Description: Contains the coordinates, address details, and time zone of the charging station location.

Parent Element: egi:energyInfrastructureTable

Child Elements:

Element	Data Type	Description
`fac:name`	N/A	Contains the name of the operator. For this element's child elements, see `fac:name`.
`fac:organisationUnit`	N/A	Contains the contact information for the operator. For this element's child elements, see `fac:organisationUnit`.

Snippet:

<fac:operator xsi:type="fac:OrganisationSpecification" id="1" version="1">
    <fac:name>
    ...
    </fac:name>
    <fac:organisationUnit>
    ...
    </fac:organisationUnit>
</fac:operator>

`fac:organisationUnit`

Description: Contains the contact information for the operator.

Parent Element: fac:operator

Child Elements:

Element	Data Type	Description
`fac:contactInformation`	N/A	Contains the contact information for the operator. For this element's child elements, see `fac:contactInformation`.

Snippet:

<fac:organisationUnit>
     <fac:contactInformation>
     ...
     </fac:contactInformation>
</fac:organisationUnit>

`fac:contactInformation`

Description: Contains the contact information for the operator.

Parent Element: fac:organisationUnit

Child Elements:

Element	Data Type	Description
`fac:telephoneNumber`	`xs:string`	Contains the telephone number for the operator.

Snippet:

<fac:contactInformation>
     <fac:telephoneNumber>+(49)-(221)-82829657</fac:telephoneNumber>
</fac:contactInformation>

`egi:energyInfrastructureStation`

Description: Contains the available payment methods, EVSE identifiers, and connector details for the location.

Parent Element: egi:energyInfrastructureTable

Child Elements:

Element	Data Type	Description
`egi:authenticationAndIdentificationMethods`	`xs:string`	The available payment methods for the location.
`egi:refillPoint`	N/A	Contains the EVSE identifiers and connector details for the location. For this element's child elements, see `egi:refillPoint`.

Snippet:

<egi:energyInfrastructureStation id="1" version="1">
    <egi:authenticationAndIdentificationMethods>apps</egi:authenticationAndIdentificationMethods>
    <egi:refillPoint xsi:type="egi:ElectricChargingPoint" id="IT-GFX-EVCIT-0000330-1" version="1">
    ...
    </egi:refillPoint>
</egi:energyInfrastructureStation>

`egi:refillPoint`

Description: Contains the EVSE identifiers and connector details for the location.

Parent Element: egi:energyInfrastructureStation

Child Elements:

Element	Data Type	Description
`fac:externalIdentifier`	`xs:string`	The unique id for the outside world. It is compliant with "eMI3standard version V1.0".
`egi:connector`	N/A	Contains the connector details for the location. For this element's child elements, see `egi:connector`.

Snippet:

<egi:refillPoint xsi:type="egi:ElectricChargingPoint" id="IT-GFX-EVCIT-0000330-1" version="1">
     <fac:externalIdentifier>IT*GFX*EVCIT*0000330*1</fac:externalIdentifier>
     <egi:connector>
     ...
     </egi:connector>
 </egi:refillPoint>

`egi:connector`

Description: Contains the connector details for the location.

Parent Element: egi:refillPoint

Child Elements:

Element	Data Type	Description
`egi:connectorType`	`xs:string`	The socket or plug standard of the charging point.
`egi:chargingMode`	`xs:string`	The power type of the connector.
`egi:maxPowerAtSocket`	`xs:string`	The maximum power is calculated by Eco-Movement based on the voltage and amperage.

Snippet:

<egi:connector>
     <egi:connectorType>iec62196T2</egi:connectorType>
     <egi:chargingMode>mode3AC3p</egi:chargingMode>
     <egi:maxPowerAtSocket>22080</egi:maxPowerAtSocket>
 </egi:connector>

Eco-Movement Data API User Guide and Reference (DATEX)

Introduction

📘
Note

Authorization

Pagination

Available Endpoint (Location)

📘
Note

Request

Response

`com:publicationCreator`

`egi:energyInfrastructureTable`

`egi:energyInfrastructureSite`

`fac:name`

`fac:operatingHours`

📘
Note

`fac:overallPeriod`

📘
Note

`com:validPeriod`

`com:recurringTimePeriodOfDay`

`com:recurringDayWeekMonthPeriod`

`fac:locationReference`

`loc:pointByCoordinates`

`loc:pointCoordinates`

`loc:_pointLocationExtension`

`locx:facilityLocation`

`locx:address`

`fac:operator`

`fac:organisationUnit`

`fac:contactInformation`

`egi:energyInfrastructureStation`

`egi:refillPoint`

`egi:connector`

Introduction

📘Note

Authorization

Pagination

Available Endpoint (Location)

📘Note

Request

Response

com:publicationCreator

egi:energyInfrastructureTable

egi:energyInfrastructureSite

fac:name

fac:operatingHours

📘Note

fac:overallPeriod

📘Note

com:validPeriod

com:recurringTimePeriodOfDay

com:recurringDayWeekMonthPeriod

fac:locationReference

loc:pointByCoordinates

loc:pointCoordinates

loc:_pointLocationExtension

locx:facilityLocation

locx:address

fac:operator

fac:organisationUnit

fac:contactInformation

egi:energyInfrastructureStation

egi:refillPoint

egi:connector

📘
Note

📘
Note

`com:publicationCreator`

`egi:energyInfrastructureTable`

`egi:energyInfrastructureSite`

`fac:name`

`fac:operatingHours`

📘
Note

`fac:overallPeriod`

📘
Note

`com:validPeriod`

`com:recurringTimePeriodOfDay`

`com:recurringDayWeekMonthPeriod`

`fac:locationReference`

`loc:pointByCoordinates`

`loc:pointCoordinates`

`loc:_pointLocationExtension`

`locx:facilityLocation`

`locx:address`

`fac:operator`

`fac:organisationUnit`

`fac:contactInformation`

`egi:energyInfrastructureStation`

`egi:refillPoint`

`egi:connector`