API Reference
Start typing to search…

Locations

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

See locations and locations/{id} to know more about the parameters that are used with the two versions of the locations endpoint.

Response

The following is a sample response for the locations endpoint:

{
    data: [ 
    
        { location 1 
            [
                { EVSE 1 
                    [{ connnector 1 },{ connector 2 }]},
                { EVSE 2 
                    [{...},{...}]}
            ]
        },
        
        { location 2 [{...}]},
        
    ], 
}

📘

Note

Use the "Try It!" button in locations and locations/{id} to view an actual response from our API.

The following table describes the main objects in the response of the locations endpoint:

Main ObjectDescription
LocationA location is a group of one or more EVSEs that belong together because they are co-located and operated by the same CPO. These EVSEs typically share certain energy infrastructure components (for example, connection to the grid).
EVSEAn EVSE is a spot where a single electric vehicle can charge. While an EVSE may offer multiple connectors, only one connector can be used at a time.
ConnectorA connector is a specific socket or cable to connect the EVSE with the electric vehicle.

🚧

Caution

Eco-Movement always upholds the API contract, but we may send new attributes in our JSON response when:

  • we add an OCPI mandatory attribute to the JSON response to be OCPI compliant
  • we improve your licensing module with new features

Hence, we strongly recommend that you handle or ignore unknown JSON fields.

Response Definitions

The main objects consist of several OCPI and Eco-Movement custom attributes.

Standard OCPI Attributes

The following are the standard attributes of OCPI 2.1.1:

Attribute

Description

data.id

The unique id for a location. It 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.

data.type

Indicates the type of location where the charge point is located. It holds one of the following values:

  • ON_STREET
  • PARKING_GARAGE
  • UNDERGROUND_GARAGE
  • PARKING_LOT
  • OTHER
  • UNKNOWN

data.address

The street and house number where the charge point is located.

data.city

The name of the city where the charge point is located.

data.postal_code

The postal code where the charge point is located. It conforms to the country standard.

data.country

The ISO 3166-1 alpha-3 code for the country of this location.

data.coordinates

The coordinates of the location in decimal degrees.

data.coordinates.latitude

The latitude of the location in decimal degrees.

data.coordinates.longitude

The longitude of the location in decimal degrees.

data.last_updated

Indicates when the location data was last updated. The date is in ISO 8601 standard and the time zone is UTC. The update could be a status update or any other update (for example, coordinates update).

data.name

The name of the location.

data.owner

The details of the location's owner.

  • *Note**: The partner_id and ema_id attributes are created by Eco-Movement. Hence, these attributes are described in Eco-Movement Attributes.

data.owner.name

The name of the location's owner.

data.owner.website

The website of the location's owner.

data.owner.logo

The link to the owner's logo.

data.operator

The name and website of the operator of the charge points in the location.

  • *Note**: The partner_id and ema_id attributes are created by Eco-Movement. Hence, these attributes are described in Eco-Movement Attributes.

data.operator.name

The name of the location's operator.

data.operator.website

The website of the location's operator.

data.operator.logo

The link to the operator's logo.

data.suboperator

The name and website of the suboperator of the charge points in the location.

  • *Note**: The partner_id and ema_id attributes are created by Eco-Movement. Hence, these attributes are described in Eco-Movement Attributes.

data.suboperator.name

The name of the location's suboperator.

data.suboperator.website

The website of the location's suboperator.

data.suboperator.logo

The link to the suboperator's logo.

data.opening_times

Indicates if the location is always open or has certain opening and closing times.

data.charging_when_closed

Indicates if the EVSEs can be used for charging outside the opening hours of the location. For example, when the parking garage closes its barriers overnight, this attribute indicates if you can still charge until the next morning.

data.time_zone

The time zone of the location. It is one of www.iana.org tzdata's TZ-values representing the time zone of the location.

data.energy_mix

Describes the energy mix and environmental impact of the supplied energy at the location.

data.energy_mix.is_green_energy

Indicates true if the supplied energy at the location is 100% from regenerative sources. (CO2 and nuclear waste is zero.)

data.energy_mix.supplier_name

The name of the energy supplier that delivers the energy for the location.

data.energy_mix.energy_product_name

The name of the energy supplier's product that is used at the location.

data.energy_mix.energy_sources

The type of energy source and the percentage.

data.energy_mix.energy_sources.source

The type of energy source. The different types of energy sources are:

  • NUCLEAR: Nuclear power source

  • GENERAL_FOSSIL: All kinds of fossil power sources

  • COAL: Fossil power form coal

  • GAS: Fossil power from gas

  • GENERAL_GREEN: All kinds of regenerative power sources

  • SOLAR: Regenerative power from PV

  • WIND: Regenerative power from wind turbines

  • WATER: Regenerative power from water turbines

data.energy_mix.energy_sources.percentage

The percentage of the source (0%-100%) in the mix.

data.energy_mix.environ_impact

The environmental impact of nuclear waste and CO2 exhaust of the location.

data.energy_mix.environ_impact.source

The type of pollutant. The different types of pollutants are:

  • NUCLEAR_WASTE: Produced nuclear waste in grams per kilowatt-hour.

  • CARBON_DIOXIDE: Exhausted carbon dioxide in grams per kilowatt-hour.

data.energy_mix.environ_impact.amount

The amount of nuclear waste produced or carbon dioxide exhausted in grams per kilowatt-hour.

data.evses.uid

The unique ID of an EVSE in the system of the CPO. It is created by the CPO and is not unique within Eco-Movement's database.

  • *Note**: Use this attribute for PATCH requests as an evse's id.

data.evses.status

Indicates if an EVSE is available for charging or not. It is the real-time status of an EVSE, which is monitored and noise-filtered by Eco-Movement. It can be one of the following:

  • AVAILABLE
  • BLOCKED
  • CHARGING
  • INOPERATIVE
  • OUTOFORDER
  • PLANNED
  • REMOVED
  • RESERVED
  • UNKNOWN

data.evses.capabilities

The capabilities of an EVSE. This attribute conforms to OCPI 2.1.1 and is only filled if it is supplied by the CPO. The different types of EVSE capabilities are:

  • CHARGING_PROFILE_CAPABLE
  • REMOTE_START_STOP_CAPABLE
  • CREDIT_CARD_PAYABLE
  • RESERVABLE
  • RFID_READER
  • UNLOCK_CAPABLE

data.evses.last_updated

Indicates when the EVSE data was last updated. The date is in ISO 8601 standard and the time zone is UTC. The update could be a status update or any other update (for example, capabilities update).

data.evses.physical_reference

A number or string printed on the outside of the EVSE for visual identification.

  • *Note**: This attribute is limited to 16 characters.

data.evses.evse_id

The unique ID of an EVSE for the outside world. It is unique across all databases, but it is not always available. It is compliant with "eMI3standard version V1.0".

Eco-Movement provides a special endpoint for requesting with this id. See evse endpoint in the API reference guide for more information about using the evse endpoint.

data.evses.floor_level

The level on which the charging station is located. For example, the floor level in a parking garage.

data.evses.parking_restrictions

Indicates if there are any restrictions to the parking lot. This attribute is only filled if it is supplied by the CPO. The different types of parking restrictions are:

  • EV_ONLY
  • PLUGGED
  • DISABLED
  • CUSTOMERS
  • MOTORCYCLES

data.evses.connectors.id

The identifier of the connector within the EVSE created by the CPO. Two connectors may have the same id as long as they do not belong to the same EVSE object.

data.evses.connectors.standard

The socket or plug standard of the charging point. The standards are:

  • CHADEMO: The connector type is CHAdeMO, DC

  • CHAOJI: The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO
    and GB/T. DC.

  • DOMESTIC_A: Standard or Domestic household, type "A", NEMA 1-15, 2 pins

  • DOMESTIC_B: Standard or Domestic household, type "B", NEMA 5-15, 3 pins

  • DOMESTIC_C: Standard or Domestic household, type "C", CEE 7/17, 2 pins

  • DOMESTIC_D: Standard or Domestic household, type "D", 3 pin

  • DOMESTIC_E: Standard or Domestic household, type "E", CEE 7/5 3 pins

  • DOMESTIC_F: Standard or Domestic household, type "F", CEE 7/4, Schuko, 3 pins

  • DOMESTIC_G: Standard or Domestic household, type "G", BS 1363, Commonwealth, 3 pins

  • DOMESTIC_H: Standard or Domestic household, type "H" SI-32, 3 pins

  • DOMESTIC_I: Standard or Domestic household, type "I", AS 3112, 3 pins

  • DOMESTIC_J: Standard or Domestic household, type "J", SEV 1011, 3 pins

  • DOMESTIC_K: Standard or Domestic household, type "K", DS 60884-2-D1, 3 pins

  • DOMESTIC_L: Standard or Domestic household, type "L", CEI 23-16-VII, 3 pins

  • DOMESTIC_M: Standard/Domestic household, type "M", BS 546, 3 pins

  • DOMESTIC_N: Standard/Domestic household, type "N", NBR 14136, 3 pins

  • DOMESTIC_O: Standard/Domestic household, type "O", TIS 166-2549, 3 pins

  • DOMESTIC_O: Standard/Domestic household, type "O", TIS 166-2549, 3 pins

  • GBT_AC: Guobiao GB/T 20234.2 AC socket/connector

  • GBT_DC: Guobiao GB/T 20234.3 DC connector

  • IEC_60309_2_single_16: IEC 60309-2 Industrial Connector single phase 16 Amperes (usually blue)

  • IEC_60309_2_three_16: IEC 60309-2 Industrial Connector three phase 16 Amperes (usually red)

  • IEC_60309_2_three_32: IEC 60309-2 Industrial Connector three phase 32 Amperes (usually red)

  • IEC_60309_2_three_64: IEC 60309-2 Industrial Connector three phase 64 Amperes (usually red)

  • IEC_62196_T1: IEC 62196 Type 1 "SAE J1772"

  • IEC_62196_T1_COMBO: Combo Type 1 based, DC

  • IEC_62196_T2: IEC 62196 Type 2 “Mennekes”

  • IEC_62196_T2_COMBO: Combo Type 2 based, DC

  • IEC_62196_T3A: IEC 62196 Type 3A

  • IEC_62196_T3C: IEC 62196 Type 3C "Scame"

  • MCS: Megawatt Charging System

  • NEMA_5_20: NEMA 5-20, 3 pins

  • NEMA_6_30: NEMA 6-30, 3 pins

  • NEMA_6_50: NEMA 6-50, 3 pins

  • NEMA_10_30: NEMA 10-30, 3 pins

  • NEMA_10_50: NEMA 10-50, 3 pins

  • NEMA_14_30: NEMA 14-30, 3 pins, rating of 30 A

  • NEMA_14_50: NEMA 14-50, 3 pins, rating of 50 A

  • PANTOGRAPH_BOTTOM_UP: On-board Bottom-up-Pantograph typically for bus charging

  • PANTOGRAPH_TOP_DOWN: On-board Top-down-Pantograph typically for bus charging

  • TESLA_R: Tesla Connector "Roadster" - Type (round, 4 pin)

  • TESLA_S: Tesla Connector "Model-S" - Type (oval, 5 pin)

data.evses.connectors.format

The format of the connector. It can be one of the following formats:

  • SOCKET
  • CABLE

data.evses.connectors.power_type

The power type of the connector. The different power types are:

  • AC_3_PHASE
  • AC_1_PHASE
  • DC

data.evses.connectors.voltage

The standard operating voltage delivered by the connector during a charging session under normal conditions. This attribute is validated and corrected by Eco-Movement.

data.evses.connectors.amperage

The standard amperage delivered by the connector during a charging session under normal conditions. This attribute is validated and corrected by Eco-Movement.

data.evses.connectors.tariff_id

Corresponds to the tariffs module. This attribute shows the CPO ad hoc prices. See tariffs endpoint for more information.

data.evses.connectors.last_updated

Indicates when the connector data was last updated. The date is in ISO 8601 standard and the time zone is UTC. The update could be a status update or any other update (for example, voltage update).

Eco-Movement Attributes

The following attributes were additionally created by Eco-Movement. They are not standard in the OCPI protocol. These attributes can be included in the request.

Attribute

Description

data.access_type

Eco-Movement classifies all locations as "Public", "Restricted", or "Private". The last category is filtered out by default. "Restricted" locations can be at a hotel, shop, office, etc., and the specific restrictions are shown under separate attributes.

data.location_type

This attribute is enriched using Eco-Movement's research methods to improve the value in the data.type attribute.

data.location_type.code

Indicates the type of location where a charge point is located. The different types of locations are:

  • ALONG_MOTORWAY
  • PARKING_GARAGE
  • PARKING_LOT
  • ON_STREET

data.location_type.description

The description of the location type.

  • *Note**: Currently, this attribute's value is a copy of data.location_type.code's value, but it will be updated in the future.

data.facilities

A list of nearby custom facilities derived by Eco-Movement. By default, Eco-Movement is OCPI compliant for this attribute. However, we can deliver more facilities than are available in the OCPI enum. If you are interested in receiving these values please contact us.

The facilities that we provide are:

  • AIRPORT: An airport
  • BAKERY: A bakery
  • BUSINESS: An industrial building, office, commercial building, or business service
  • BUS_STOP: A bus stop
  • CAFE: A cafe
  • CARPOOL_PARKING: A carpool parking
  • EDUCATION: An educational institution
  • FAST_FOOD: A fast food outlet
  • FINANCE: A financial service
  • FUEL_STATION: A fuel station
  • HEALTH: A healthcare facility
  • HOTEL: A hotel
  • MALL: A mall or shopping center
  • MUSEUM: A museum
  • NATURE: Located in or close to a park, nature reserve/park, etc.
  • OTHER: Other facilities, such as a civic building, place of worship, waste management, etc.
  • PLAYGROUND: A playground
  • RECREATION_AREA: A recreation area
  • RESTAURANT: A restaurant
  • SERVICE: Services, such as tourist information, post office, etc.
  • SPORT: Sport facilities, such as gym, field, etc.
  • STORE: A retail store
  • SUPERMARKET: A supermarket
  • TAXI_STAND: A taxi stand
  • TOILETS: A public toilet
  • TRAIN_STATION: A train station
  • WIFI: Wifi or other type of internet facilities

data.owner.partner_id

The unique id for an owner. It is created by Eco-Movement, and it is stable.

data.owner.ema_id

The E-Mobility Account Identifier (eMA ID) for the owner. It is created by Eco-Movement by combining the country code where the charging station is located, and the party id of the owner. For example, NL-ECO.

  • *Note**: An owner can have multiple eMA IDs. For example, if a company named 'Example Company A' acquired 'Example Company B' and owns the charging stations of Example Company B, then this attribute maps Example Company B's eMA IDs to Example Company A's eMA IDs. For example, ["NL-EXA", "NL-EXB"].

data.operator.partner_id

The unique id for an operator. It is created by Eco-Movement, and it is stable.

data.operator.ema_id

The E-Mobility Account Identifier (eMA ID) for the operator. It is created by Eco-Movement by combining the country code where the charging station is located, and the party id of the operator. For example, NL-ECO.

  • *Note**: An operator can have multiple eMA IDs. For example, if a company named 'Example Company A' acquired 'Example Company B' and operates the charging stations of Example Company B, then this attribute maps Example Company B's eMA IDs to Example Company A's eMA IDs. For example, ["NL-EXA", "NL-EXB"].

data.suboperator.partner_id

The unique id for a suboperator. It is created by Eco-Movement, and it is stable.

data.suboperator.ema_id

The E-Mobility Account Identifier (eMA ID) for the suboperator. It is created by Eco-Movement by combining the country code where the charging station is located, and the party id of the suboperator. For example, NL-ECO.

  • *Note**: An operator can have multiple eMA IDs. For example, if a company named 'Example Company A' acquired 'Example Company B' and operates the charging stations of Example Company B, then this attribute maps Example Company B's eMA IDs to Example Company A's eMA IDs. For example, ["NL-EXA", "NL-EXB"].

data.brand_name

The name and website of the main brand that is operating the charging station.

  • *Note**: If suboperator is available, then the brand name is the suboperator's name. If suboperator is not available, then the brand name is the operator's name.

data.related_locations

Describes up to five facilities that are closest to the charge point's location.

data.related_locations.latitude

The latitude of a facility that is closest to the location of the charge point.

data.related_locations.longitude

The longitude of a facility that is closest to the location of the charge point.

data.related_locations.name

The name of a facility that is closest to the location of the charge point.

data.support_phone_number

The phone number that EV drivers should call when they need assistance at the charge location.

data.roaming

A list of all the major MSP cards that are accepted at this location and their details.

data.roaming.emsp

The provider of the MSP card.

data.roaming.partner_id

The unique id for a provider. It is created by Eco-Movement, and it is stable.

data.roaming.ema_id

The unique E-Mobility Account Identifier (eMA ID) for a provider. It is created by Eco-Movement by combining the country code where the charging station is located, and the party id of the provider. For example, NL-ECO.

  • *Note**: A provider can have multiple eMA IDs. For example, if a company named 'Example Company A' acquired 'Example Company B' and owns the charging stations of Example Company B, then this attribute maps Example Company B's eMA IDs to Example Company A's eMA IDs. For example, ["NL-EXA", "NL-EXB"].

data.roaming.card

The name of the MSP card.

data.roaming.android_app_link

The link to the MSP's Android app.

data.roaming.ios_app_link

The link to the MSP's iOS app.

data.derived_opening_times

An Eco-Movement algorithm looks at the charging history and discovers patterns using the history. The opening times are created based on these patterns.

data.derived_opening_times.regular_hours

The opening and closing hours of the location on a particular day of the week.

data.derived_opening_times.regular_hours.weekday

The number of the day in the week. It starts from Monday (1) and ends in Sunday (7).

data.derived_opening_times.regular_hours.period_begin

The beginning of the regular period in hours and minutes.

data.derived_opening_times.regular_hours.period_end

The ending of the regular period in hours and minutes.

data.derived_opening_times.twentyfourseven

Indicates if the location is always open or has certain opening and closing times.

data.heavy_vehicles

Describes the dimensions and restrictions for heavy vehicles.

data.heavy_vehicles.heavy_vehicles_height

The maximum height of the heavy vehicle in metres that is allowed to be parked at the charging station.

data.heavy_vehicles.heavy_vehicles_width

The maximum width of the heavy vehicle in metres that is allowed to be parked at the charging station.

data.heavy_vehicles.heavy_vehicles_length

The maximum length of the heavy vehicle in metres that is allowed to be parked at the charging station.

data.heavy_vehicles.heavy_vehicles_mass

The maximum mass of the heavy vehicle in kilograms that is allowed to be parked at the charging station.

data.heavy_vehicles.heavy_vehicles_restrictions

The applicable restrictions for the heavy vehicle. The values are:

  • N1 - Only N1 type of heavy vehicles can be parked at the charging station. N1 vehicles have a maximum mass not exceeding 3.5 tonnes (7,700 lbs).

  • N2 - Only N2 type of heavy vehicles can be parked at the charging station. N2 vehicles have a maximum mass exceeding 3.5 tonnes but not exceeding 12 tonnes (26,000 lbs).

  • N3 - Only N3 type of heavy vehicles can be parked at the charging station. N3 vehicles have a maximum mass exceeding 12 tonnes (26,000 lbs).

  • N1, N2 - N1 and N2 type of heavy vehicles can be parked at the charging station.

  • N1, N2, N3 - N1, N2, and N3 type of heavy vehicles can be parked at the charging station.

  • N3+O4 - N3 type of heavy vehicles having O4 type of trailers can be parked at the charging station. N3 vehicles have a maximum mass exceeding 12 tonnes (26,000 lbs) and O4 trailers have a maximum mass exceeding 10 tonnes (22000 lbs).

  • UNKNOWN - The restrictions are currently unknown.

data.heavy_vehicles.heavy_vehicles_dedicated

Indicates whether the location was constructed mainly for the purpose of heavy vehicles like trucks or not.

data.heavy_vehicles.heavy_vehicles_trailer_accessibility

Indicates whether the location is suitable for trucks with trailers or not.

data.heavy_vehicles.heavy_vehicles_drive_through

Indicates whether the location is drive-though or not.

data.heavy_vehicles.heavy_vehicles_dangerous_goods

Indicates whether the location allows charging of heavy vehicles transporting dangerous goods classified in ADR.

data.heavy_vehicles.heavy_vehicles_rigid_vehicles

Indicates whether the location is suitable for rigid heavy vehicles or not.

data.heavy_vehicles.heavy_vehicles_overnight_parking

Indicates whether the location allows overnight charging of heavy vehicles or not.

data.heavy_vehicles.heavy_vehicles_amenities

A list of amenities at the location. Amenities can be:

  • TRUCK_PARKING
  • TRUCK_WASH
  • TRUCK_REPAIR
  • TRUCK_DEALERSHIP
  • SECURE_TRUCK_PARKING
  • FOOD_DELIVERY
  • TOILET
  • WASHING_MACHINE
  • SHOWER
  • RESTAURANT
  • VENDING_MACHINE
  • DRIVER_LOUNGE
  • OUTDOOR_GYM
  • POWER_SUPPLY
  • ATM
  • ACCESS_CONTROLLED_AREA
  • LICENSE_PLATE_RECOGNITION
  • PERIMETER_FENCE
  • PEDESTRIAN_TURNSTILES
  • CAMERA_SURVEILLANCE
  • GUARD
  • FLOOD_LIGHTING
  • ENTRY_GATE
  • EXIT_GATE
  • UNKNOWN

data.heavy_vehicles.heavy_vehicles_nose_parking

Indicates whether the location allows nose parking or not.

data.administrative_areas

The administrative area for the location.

data.administrative_areas.state_province

The state or province where the charging station is located.

data.administrative_areas.municipality

The municipality where the charging station is located.

data.directions

The directions to reach the location.

data.predicted_occupancy

Eco-Movement uses this feature to predict the occupancy of the location. The values are updated daily, predicting hour by hour the likelihood of occupancy for the upcoming 7 days. They are based on historical trend lines of seasons, years, months, weeks, and days. Hence, this attribute is accurate and relevant for the EV driver.

data.predicted_occupancy.weekday

The number of the day in the week. It starts from Monday (1) and ends in Sunday (7).

data.predicted_occupancy.period_begin

The beginning of the time period. The Z after the time indicates that it is in UTC.

data.predicted_occupancy.period_end

The ending of the time period. The Z after the time indicates that it is in UTC.

data.predicted_occupancy.occupancy

Indicates the occupancy on a scale from 1 to 10, where 1 means the location is available for charging and 10 means the location is fully occupied.

data.adhoc_authorisation_payment_method

Indicates the authentication and payment methods. The methods are:

  • AUTH_BY_CAR_PLUG&CHARGE
  • ONLINE_APPLE_PAY
  • TERMINAL_IN_APP
  • ONLINE_PAYPAL
  • SERVICE_PROVIDER_RFID_CARD
  • TERMINAL_QR_CODE
  • TERMINAL_CREDIT_CARD
  • TERMINAL_DEBIT_CARD
  • TERMINAL_SMS
  • ONLINE_CREDIT_CARD
  • OTHER_OTHER
  • TERMINAL_CONTACTLESS
  • ONLINE_GOOGLE_PAY
  • ONLINE_BANK_PAYMENT
  • AUTH_BY_CAR_AUTOCHARGE

data.adhoc_authorisation_method

The custom field for the available ad hoc payment methods. The different types of ad hoc payment methods are:

  • CREDIT_CARD

  • DEBIT_CARD

  • MEMBERSHIP_APP

  • MEMBERSHIP_CARD

  • OTHER

  • OTHER_Apple_Pay

  • OTHER_Authentication_by_car

  • OTHER_Google_Pay

  • QR_CODE

  • SMS

    • *Note**: In OCPI protocol, there is a standard field named "Capabilities", which is similar, but limited.

data.reliability_score_2

Indicates the reliability score of the location. This attribute indicates when the charging points at a location are operating normally, but it does not have details regarding expected occupancy. The algorithm considers the frequency of recent usage (more recent is more relevant) and recent downtime. For example, a score of 1 is the least reliable, and a score of 5 is the most reliable.

  • *Note**: A score of 0 indicates that the reliability score is not available for the location yet.

data.charging_behaviour

This attribute relies on AI and it is verified by scientific research. Based on real-time information, the charging behaviour of users is divided into groups.

  • *Note**: This attribute is deprecated.

data.charging_behaviour.code

Indicates the code for the type of charging behaviour. The codes are:

  • 1: Urban charging

  • 2: Fast charging

  • 3: Mixed charging

  • 4: Noise charging

  • 5: Overnight charging

  • 6: Office charging

data.charging_behaviour.description

The description of the charging behaviour.

data.location_category

The type of location where a charge point is located. For example, shop.

data.entrance_for_navigation

The coordinates for the location's entrances in decimal degrees. If available, there can be more than one entrances to the location.

  • *Note**: This attribute is available only for locations that contain data.location_type.code as ALONG_MOTORWAY.

data.entrance_for_navigation.name

The name of the entrance. For example, motorway exit.

data.entrance_for_navigation.latitude

The latitude of a location's entrance in decimal degrees.

data.entrance_for_navigation.longitude

The longitude of a location's entrance in decimal degrees.

data.number_physical_units

The total number of DC physical units at the location.

data.restrictions

The applicable restrictions at the location. The different types of restrictions are:

  • ONLY_CUSTOMERS - Only customers of the charging station's location are allowed to charge. For example, in a supermarket.
  • ONLY_TRUCKS - Only trucks are allowed to charge.
  • ONLY_2_WHEELERS - Only two-wheelers are allowed to charge.
  • ONLY_BUS - Only buses are allowed to charge.
  • ONLY_BRAND - Only EVs of the operator brands are allowed to charge. For example, Tesla.
  • ONLY_CARSHARING - Only shared cars are allowed to charge. This restriction is shown if at least 1 EVSE is for shared cars.
  • ONLY_TAXIS - Only taxis are allowed to charge.
  • ONLY_RESIDENTIAL - Only residents of the charging station's location are allowed to charge. For example, in an apartment building.
  • ONLY_EMPLOYEES- Only employees of the charging station's location are allowed to charge. For example, in an office.
  • TIME_RESTRICTED - The charging station is not open 24/7.

data.rating

Indicates the average score and the total number of EV drivers that contributed to that score.

data.rating.count

Indicates the total number of EV drivers that contributed to the score.

data.rating.score

Indicates the average score of the charging station location. It ranges from 1 to 5.

data.evses.cpo_external_id

The unique ID of the location in the system of the CPO.

This attribute is registered at location level in the system of the CPO, but Eco-Movement stores it at EVSE level. This is because we sometimes merge or split locations to improve the user experience.

data.evses.directions

The directions to reach the EVSE from the location.

data.evses.last_successful_charge

Indicates when the EVSE last had a successful charge. The time zone is UTC.

data.evses.connectors.pricing_id

Corresponds with id from Prices (Deprecated).

  • *Note**: It is created by Eco-Movement and is refreshed whenever a price or product associated with that particular id is updated.

data.evses.connectors.max_power

The maximum power is calculated by Eco-Movement based on the voltage and amperage.

  • *Note**: This attribute is created by Eco-Movement. It does not exist in OCPI 2.1.1 and you can request the attribute as an extra feature.

data.evses.connectors.peak_voltage

The maximum allowed voltage that the connector can safely handle under peak or specific conditions. This attribute is validated and corrected by Eco-Movement.

data.evses.connectors.peak_amperage

The maximum allowed amperage that the connector can safely handle under peak or specific conditions. This attribute is validated and corrected by Eco-Movement.

📘

Note

For the predicted_occupancy, roaming, and derived_opening_times attributes, you must use a location's id parameter behind the locations endpoint in a GET request. Use the "Try It!" button in locations/{id} to use the locations endpoint with a location's id and view an actual response from our API.

If you are interested in receiving these attributes with the bulk request, please contact us. Please note that only 500 results are returned instead of 1000 results with this feature.