Download OpenAPI specification:
The Sender Interface is typically implemented by market roles like the CPO. This interface allows receivers (eMSPs) to fetch Location data.
The Sender interface is meant to be used when the connection between two parties is established for the first time, to retrieve the current list of Location objects with the current status, and when the Receiver is not 100% sure the Location cache is entirely up-to-date (i.e. to perform a full sync).
The Receiver can also use the GET Object interface to retrieve a specific Location, EVSE or Connector.
| status_code required | integer OCPI status code, 1000 for success. |
| status_message | string An optional status message which may help when debugging. |
| timestamp required | string <date-time> The time this message was generated. |
| data | any Response data object or list of objects. |
{- "status_code": 1000,
- "status_message": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "data": null
}| Enum | Description |
|---|---|
| AD_HOC_USER | One time use Token ID generated by a server (or App.) The eMSP uses this to bind a Session to a customer, probably an app user. |
| APP_USER | Token ID generated by a server (or App.) to identify a user of an App. The same user uses the same Token for every Session. |
| OTHER | Other type of token |
| RFID | RFID Token |
The type of token.
"AD_HOC_USER"| uid | string <= 36 characters Unique ID by which this Token can be identified. | ||||||||||
| type | string <enum> (TokenType)
Type of the token. | ||||||||||
| visual_number | string <= 64 characters Visual readable number/identification as printed on the Token (RFID card). | ||||||||||
| issuer | string <= 64 characters Issuing company, most of the times the name of the company printed on the token (RFID card), not necessarily the eMSP. | ||||||||||
| group_id | string <= 36 characters This ID groups a couple of tokens. This can be used to make two or more tokens work as one. |
{- "uid": "string",
- "type": "AD_HOC_USER",
- "visual_number": "string",
- "issuer": "string",
- "group_id": "string"
}| latitude required | string <= 10 characters ^-?[0-9]{1,2}\.[0-9]{5,7}$ Latitude of the point in decimal degree. Example 50.770774. Decimal separator "." required. |
| longitude required | string <= 11 characters ^-?[0-9]{1,3}\.[0-9]{5,7}$ Longitude of the point in decimal degree. Example -126.104965. Decimal separator "." required. |
{- "latitude": "string",
- "longitude": "string"
}| language required | string = 2 characters Language Code ISO 639-1. |
| text required | string <= 512 characters Text to be displayed to an end user. No markup, html etc. allowed. |
{- "language": "st",
- "text": "string"
}| latitude required | string <= 10 characters ^-?[0-9]{1,2}\.[0-9]{5,7}$ Latitude of the point in decimal degree. Example 50.770774. Decimal separator "." required. |
| longitude required | string <= 11 characters ^-?[0-9]{1,3}\.[0-9]{5,7}$ Longitude of the point in decimal degree. Example -126.104965. Decimal separator "." required. |
object (DisplayText) Name of the point in local language or as written at the location. For example the street name of a parking lot entrance or its number. |
{- "latitude": "string",
- "longitude": "string",
- "name": {
- "language": "st",
- "text": "string"
}
}| Enum | Description |
|---|---|
| ALONG_MOTORWAY | Location on a parking facility/rest area along a motorway, freeway, interstate, highway etc. |
| PARKING_GARAGE | Multistorey car park. |
| PARKING_LOT | A cleared area that is intended for parking vehicles, i.e. at super markets, bars, etc. |
| ON_DRIVEWAY | Location is on the driveway of a house/building. |
| ON_STREET | Parking in public space along a street. |
| UNDERGROUND_GARAGE | Multistorey car park, mainly underground. |
Reflects the general type of the charge point's location. May be used for user information.
"ALONG_MOTORWAY"| Enum | Description |
|---|---|
| AVAILABLE | The EVSE/Connector is able to start a new charging session. |
| BLOCKED | The EVSE/Connector is not accessible because of a physical barrier, i.e. a car. |
| CHARGING | The EVSE/Connector is in use. |
| INOPERATIVE | The EVSE/Connector is not yet active, or temporarily not available for use, but not broken or defect. |
| OUTOFORDER | The EVSE/Connector is currently out of order, some part/components may be broken/defect. |
| PLANNED | The EVSE/Connector is planned, will be operating soon. |
| REMOVED | The EVSE/Connector was discontinued/removed. |
| RESERVED | The EVSE/Connector is reserved for a particular EV driver and is unavailable for other drivers. |
| UNKNOWN | No status information available (also used when offline). |
The status of an EVSE.
"AVAILABLE"| period_begin required | string <date-time> Begin of the scheduled period. | ||||||||||||||||||||
| period_end | string <date-time> End of the scheduled period, if known. | ||||||||||||||||||||
| status required | string <enum> (Status)
Status value during the scheduled period. |
{- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z",
- "status": "AVAILABLE"
}| Enum | Description |
|---|---|
| CHARGING_PROFILE_CAPABLE | The EVSE supports charging profiles. |
| CHARGING_PREFERENCES_CAPABLE | The EVSE supports charging preferences. |
| CHIP_CARD_SUPPORT | EVSE has a payment terminal that supports chip cards. |
| CONTACTLESS_CARD_SUPPORT | EVSE has a payment terminal that supports contactless cards. |
| CREDIT_CARD_PAYABLE | EVSE has a payment terminal that makes it possible to pay for charging using a credit card. |
| DEBIT_CARD_PAYABLE | EVSE has a payment terminal that makes it possible to pay for charging using a debit card. |
| PED_TERMINAL | EVSE has a payment terminal with a pin-code entry device. |
| REMOTE_START_STOP_CAPABLE | The EVSE can remotely be started/stopped. |
| RESERVABLE | The EVSE can be reserved. |
| RFID_READER | Charging at this EVSE can be authorized with an RFID token. |
| START_SESSION_CONNECTOR_REQUIRED | When a StartSession is sent to this EVSE, the MSP is required to add the optional connector_id field in the StartSession object. |
| TOKEN_GROUP_CAPABLE | This EVSE supports token groups, two or more tokens work as one, so that a session can be started with one token and stopped with another (handy when a card and key-fob are given to the EV-driver). |
| UNLOCK_CAPABLE | Connectors have mechanical lock that can be requested by the eMSP to be unlocked. |
The capabilities of an EVSE.
"CHARGING_PROFILE_CAPABLE"| Enum | Description |
|---|---|
| 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/Domestic household, type "A", NEMA 1-15, 2 pins. |
| DOMESTIC_B | Standard/Domestic household, type "B", NEMA 5-15, 3 pins. |
| DOMESTIC_C | Standard/Domestic household, type "C", CEE 7/17, 2 pins. |
| DOMESTIC_D | Standard/Domestic household, type "D", 3 pins. |
| DOMESTIC_E | Standard/Domestic household, type "E", CEE 7/5, 3 pins. |
| DOMESTIC_F | Standard/Domestic household, type "F", CEE 7/4, Schuko, 3 pins. |
| DOMESTIC_G | Standard/Domestic household, type "G", BS 1363, Commonwealth, 3 pins. |
| DOMESTIC_H | Standard/Domestic household, type "H", SI-32, 3 pins. |
| DOMESTIC_I | Standard/Domestic household, type "I", AS 3112, 3 pins. |
| DOMESTIC_J | Standard/Domestic household, type "J", SEV 1011, 3 pins. |
| DOMESTIC_K | Standard/Domestic household, type "K", DS 60884-2-D1, 3 pins. |
| DOMESTIC_L | Standard/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. |
| 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 phases 16 amperes (usually red). |
| IEC_60309_2_three_32 | IEC 60309-2 Industrial Connector three phases 32 amperes (usually red). |
| IEC_60309_2_three_64 | IEC 60309-2 Industrial Connector three phases 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". |
| 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 | Off-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). |
The socket or plug standard of the charging point.
"CHADEMO"| Enum | Description |
|---|---|
| SOCKET | The connector is a socket; the EV user needs to bring a fitting plug. |
| CABLE | The connector is an attached cable; the EV users car needs to have a fitting inlet. |
The format of the connector, whether it is a socket or a plug.
"SOCKET"| Enum | Description |
|---|---|
| AC_1_PHASE | AC single phase. |
| AC_2_PHASE | AC two phases, only two of the three available phases connected. |
| AC_2_PHASE_SPLIT | AC two phases using split phase system. |
| AC_3_PHASE | AC three phases. |
| DC | Direct Current. |
The type of power at the connector.
"AC_1_PHASE"| id required | string <= 36 characters Identifier of the Connector within the EVSE. Two Connectors may have the same id as long as they do not belong to the same EVSE object. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| standard required | string <enum> (ConnectorType)
The standard of the installed connector. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| format required | string <enum> (ConnectorFormat)
The format (socket/cable) of the installed connector. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| power_type required | string <enum> (PowerType)
The type of power at the connector. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| max_voltage required | integer Maximum voltage of the connector (line to neutral for AC_3_PHASE), in volt [V]. For example DC Chargers might vary the voltage during charging when battery almost full. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| max_amperage required | integer Maximum amperage of the connector, in ampere [A]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| max_electric_power | integer Maximum electric power that can be delivered by this connector, in Watts (W). When the maximum electric power is lower than the calculated value from voltage and amperage, this value should be set. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| tariff_ids | Array of strings[ items <= 36 characters ] Identifiers of the currently valid charging tariffs. Multiple tariffs are possible, but only one of each Tariff.type can be active at the same time. Tariffs with the same type are only allowed if they are not active at the same time: start_date_time and end_date_time period not overlapping. For a "free of charge" tariff, this field should be set and point to a defined "free of charge" tariff. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| terms_and_conditions | string <uri> URL to the operator's terms and conditions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| last_updated required | string <date-time> Timestamp when this Connector was last updated (or created). |
{- "id": "string",
- "standard": "CHADEMO",
- "format": "SOCKET",
- "power_type": "AC_1_PHASE",
- "max_voltage": 0,
- "max_amperage": 0,
- "max_electric_power": 0,
- "tariff_ids": [
- "string"
], - "last_updated": "2019-08-24T14:15:22Z"
}| Enum | Description |
|---|---|
| EV_ONLY | Reserved parking spot for electric vehicles. |
| PLUGGED | Parking is only allowed while plugged in (charging). |
| DISABLED | Reserved parking spot for disabled people with valid ID. |
| CUSTOMERS | Parking spot for customers/guests only, for example in case of a hotel or shop. |
| MOTORCYCLES | Parking spot only suitable for (electric) motorcycles or scooters. |
This value, if provided, represents the restriction to the parking spot for different purposes.
"EV_ONLY"| Enum | Description |
|---|---|
| CHARGER | Photo of the physical device that contains one or more EVSEs. |
| ENTRANCE | Location entrance photo. Should show the car entrance to the location from street side. |
| LOCATION | Location overview photo. |
| NETWORK | Logo of an associated roaming network to be displayed with the EVSE for example in lists, maps and detailed information views. |
| OPERATOR | Logo of the charge point operator, for example a municipality, to be displayed in the EVSEs detailed information view or in lists and maps, if no network logo is present. |
| OTHER | Other |
| OWNER | Logo of the charge point owner, for example a local store, to be displayed in the EVSEs detailed information view. |
The category of an image to obtain the correct usage in a user presentation. The category has to be set accordingly to the image content in order to guarantee the right usage.
"CHARGER"| url required | string <uri> URL from where the image data can be fetched through a web browser. | ||||||||||||||||
| thumbnail | string <uri> URL from where a thumbnail of the image can be fetched through a web browser. | ||||||||||||||||
| category required | string <enum> (ImageCategory)
Describes what the image is used for. | ||||||||||||||||
| type required | string <= 4 characters Image type like: gif, jpeg, png, svg. | ||||||||||||||||
| width | integer Width of the full scale image. | ||||||||||||||||
| height | integer Height of the full scale image. |
{- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}| uid required | string <= 36 characters Uniquely identifies the EVSE within the CPOs platform (and suboperator platforms). This field can never be changed, modified or renamed. This is the 'technical' identification of the EVSE, not to be used as 'human readable' identification, use the field evse_id for that. | ||||||||||||||||||||||||||||
| evse_id | string <= 48 characters Compliant with the following specification for EVSE ID: "E-mobility ID-codes: the purpose of IDs, ID usage and ID format" (https://evroaming.org/contract-evse-ids/). Optional because: if an evse_id is to be re-used in the real world, the evse_id can be removed from an EVSE object if the status is set to REMOVED. | ||||||||||||||||||||||||||||
| status required | string <enum> (Status)
Indicates the current status of the EVSE. | ||||||||||||||||||||||||||||
Array of objects (StatusSchedule) Indicates a planned status update of the EVSE. | |||||||||||||||||||||||||||||
| capabilities | Array of strings <enum> (Capability) [ items <enum > ]
List of functionalities that the EVSE is capable of. | ||||||||||||||||||||||||||||
required | Array of objects (Connector) non-empty List of available connectors on the EVSE. | ||||||||||||||||||||||||||||
| floor_level | string <= 4 characters Level on which the Charge Point is located (in garage buildings) in the locally displayed numbering scheme. | ||||||||||||||||||||||||||||
object (GeoLocation) Coordinates of the EVSE. | |||||||||||||||||||||||||||||
| physical_reference | string <= 16 characters A number/string printed on the outside of the EVSE for visual identification. | ||||||||||||||||||||||||||||
Array of objects (DisplayText) Multi-language human-readable directions when more detailed information on how to reach the EVSE from the Location is required. | |||||||||||||||||||||||||||||
| parking_restrictions | Array of strings <enum> (ParkingRestriction) [ items <enum > ]
The restrictions that apply to the parking spot. | ||||||||||||||||||||||||||||
Array of objects (Image) Links to images related to the EVSE such as photos or logos. | |||||||||||||||||||||||||||||
| last_updated required | string <date-time> Timestamp when this EVSE or one of its Connectors was last updated (or created). |
{- "uid": "string",
- "evse_id": "string",
- "status": "AVAILABLE",
- "status_schedule": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z",
- "status": "AVAILABLE"
}
], - "capabilities": [
- "CHARGING_PROFILE_CAPABLE"
], - "connectors": [
- {
- "id": "string",
- "standard": "CHADEMO",
- "format": "SOCKET",
- "power_type": "AC_1_PHASE",
- "max_voltage": 0,
- "max_amperage": 0,
- "max_electric_power": 0,
- "tariff_ids": [
- "string"
], - "last_updated": "2019-08-24T14:15:22Z"
}
], - "floor_level": "stri",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "physical_reference": "string",
- "directions": [
- {
- "language": "st",
- "text": "string"
}
], - "parking_restrictions": [
- "EV_ONLY"
], - "images": [
- {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
], - "last_updated": "2019-08-24T14:15:22Z"
}| name required | string <= 100 characters Name of the operator. |
| website | string <uri> Link to the operator's website. |
object (Image) Image link to the operator's logo. |
{- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}| Enum | Description |
|---|---|
| HOTEL | A hotel. |
| RESTAURANT | A restaurant. |
| CAFE | A cafe. |
| MALL | A mall or shopping center. |
| SUPERMARKET | A supermarket. |
| SPORT | Sport facilities: gym, field etc. |
| RECREATION_AREA | A recreation area. |
| NATURE | Located in, or close to, a park, nature reserve etc. |
| MUSEUM | A museum. |
| BIKE_SHARING | A bike/e-bike/e-scooter sharing location. |
| BUS_STOP | A bus stop. |
| TAXI_STAND | A taxi stand. |
| TRAM_STOP | A tram stop/station. |
| METRO_STATION | A metro station. |
| TRAIN_STATION | A train station. |
| AIRPORT | An airport. |
| PARKING_LOT | A parking lot. |
| CARPOOL_PARKING | A carpool parking. |
| FUEL_STATION | A Fuel station. |
| WIFI | Wifi or other type of internet available. |
Facilities available at or near the charging location.
"HOTEL"| weekday required | integer [ 1 .. 7 ] Number of day in the week, from Monday (1) till Sunday (7). |
| period_begin required | string^([0-1][0-9]|2[0-3]):[0-5][0-9]$ Begin of the regular period, in local time, given in hours and minutes. Must be in 24h format with leading zeros. Example "18:15". |
| period_end required | string^([0-1][0-9]|2[0-3]):[0-5][0-9]$ End of the regular period, in local time, syntax as for period_begin. Must be later than period_begin. |
{- "weekday": 1,
- "period_begin": "string",
- "period_end": "string"
}| period_begin required | string <date-time> Begin of the exception. In UTC, time_zone field of the Location can be used to convert to local time. |
| period_end required | string <date-time> End of the exception. In UTC, time_zone field of the Location can be used to convert to local time. |
{- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z"
}| twentyfourseven required | boolean True to represent 24 hours a day and 7 days a week, except the given exceptions. |
Array of objects (RegularHours) Regular hours, weekday-based. Only to be used if twentyfourseven=false, then this field needs to contain at least one RegularHours object. | |
Array of objects (ExceptionalPeriod) Exceptions for specified calendar dates, time-range based. Periods the station is operating/accessible. Additional to regular_hours. May overlap regular rules. | |
Array of objects (ExceptionalPeriod) Exceptions for specified calendar dates, time-range based. Periods the station is not operating/accessible. Overwriting regular_hours and exceptional_openings. |
{- "twentyfourseven": true,
- "regular_hours": [
- {
- "weekday": 1,
- "period_begin": "string",
- "period_end": "string"
}
], - "exceptional_openings": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z"
}
], - "exceptional_closings": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z"
}
]
}| Enum | Description |
|---|---|
| NUCLEAR | Nuclear power sources. |
| GENERAL_FOSSIL | All kinds of fossil power sources. |
| COAL | Fossil power from 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. |
Categories of energy sources.
"NUCLEAR"| source required | string <enum> (EnergySourceCategory)
The type of energy source. | ||||||||||||||||||
| percentage required | number Percentage of this source (0-100) in the mix. |
{- "source": "NUCLEAR",
- "percentage": 0
}| Enum | Description |
|---|---|
| NUCLEAR_WASTE | Produced nuclear waste in grams per kilowatthour. |
| CARBON_DIOXIDE | Exhausted carbon dioxide in grams per kilowatthour. |
Categories of environmental impact values.
"NUCLEAR_WASTE"| category required | string <enum> (EnvironmentalImpactCategory)
The environmental impact category of this value. | ||||||
| amount required | number Amount of this portion in g/kWh. |
{- "category": "NUCLEAR_WASTE",
- "amount": 0
}| is_green_energy required | boolean True if 100% from regenerative sources. (CO2 and nuclear waste is zero) |
Array of objects (EnergySource) Key-value pairs (enum + percentage) of energy sources of this location's tariff. | |
Array of objects (EnvironmentalImpact) Key-value pairs (enum + percentage) of nuclear waste and CO2 exhaust of this location's tariff. | |
| supplier_name | string <= 64 characters Name of the energy supplier, delivering the energy for this location or tariff. |
| energy_product_name | string <= 64 characters Name of the energy supplier's product/tariff plan used at this location. |
{- "is_green_energy": true,
- "energy_sources": [
- {
- "source": "NUCLEAR",
- "percentage": 0
}
], - "environ_impact": [
- {
- "category": "NUCLEAR_WASTE",
- "amount": 0
}
], - "supplier_name": "string",
- "energy_product_name": "string"
}| country_code required | string = 2 characters ISO-3166 alpha-2 country code of the CPO that 'owns' this Location. | ||||||||||||||||||||||||||||||||||||||||||
| party_id required | string = 3 characters ID of the CPO that 'owns' this Location (following the ISO-15118 standard). | ||||||||||||||||||||||||||||||||||||||||||
| id required | string <= 36 characters Uniquely identifies the location within the CPOs platform (and suboperator platforms). This field can never be changed, modified or renamed. | ||||||||||||||||||||||||||||||||||||||||||
| publish required | boolean Defines if a Location may be published on a website or app etc. When this is set to false, only tokens identified in the field publish_allowed_to are allowed to be shown this Location. When the same location has EVSEs that may be published and may not be published, two 'Locations' should be created. | ||||||||||||||||||||||||||||||||||||||||||
Array of objects (PublishTokenType) This field may only be used when the publish field is set to false. Only owners of Tokens that match all the set fields of one PublishToken in the list are allowed to be shown this location. | |||||||||||||||||||||||||||||||||||||||||||
| name | string <= 255 characters Display name of the location. | ||||||||||||||||||||||||||||||||||||||||||
| address required | string <= 45 characters Street/block name and house number if available. | ||||||||||||||||||||||||||||||||||||||||||
| city required | string <= 45 characters City or town. | ||||||||||||||||||||||||||||||||||||||||||
| postal_code | string <= 10 characters Postal code of the location, may only be omitted when the location has no postal code. | ||||||||||||||||||||||||||||||||||||||||||
| state | string <= 20 characters State or province of the location, only to be used when relevant. | ||||||||||||||||||||||||||||||||||||||||||
| country required | string = 3 characters ISO 3166-1 alpha-3 code for the country of this location. | ||||||||||||||||||||||||||||||||||||||||||
required | object (GeoLocation) Coordinates of the location. | ||||||||||||||||||||||||||||||||||||||||||
Array of objects (AdditionalGeoLocation) Geographical location of related points relevant to the user. | |||||||||||||||||||||||||||||||||||||||||||
| parking_type | string <enum> (ParkingType)
The general type of parking at the charge point location. | ||||||||||||||||||||||||||||||||||||||||||
Array of objects (EVSE) List of EVSEs that belong to this Location. | |||||||||||||||||||||||||||||||||||||||||||
Array of objects (DisplayText) Human-readable directions on how to reach the location. | |||||||||||||||||||||||||||||||||||||||||||
object (BusinessDetails) Information of the operator. When not specified, the information retrieved from the Credentials module should be used instead. | |||||||||||||||||||||||||||||||||||||||||||
object (BusinessDetails) Information of the suboperator if available. | |||||||||||||||||||||||||||||||||||||||||||
object (BusinessDetails) Information of the owner if available. | |||||||||||||||||||||||||||||||||||||||||||
| facilities | Array of strings <enum> (Facility) [ items <enum > ]
Optional list of facilities this charging location directly belongs to. | ||||||||||||||||||||||||||||||||||||||||||
| time_zone required | string <= 255 characters One of IANA tzdata's TZ-values representing the time zone of the location. Examples "Europe/Oslo", "Europe/Zurich". | ||||||||||||||||||||||||||||||||||||||||||
object (Hours) The times when the EVSEs at the location can be accessed for charging. | |||||||||||||||||||||||||||||||||||||||||||
| charging_when_closed | boolean Indicates if the EVSEs are still charging outside the opening hours of the location. Default is true. | ||||||||||||||||||||||||||||||||||||||||||
Array of objects (Image) Links to images related to the location such as photos or logos. | |||||||||||||||||||||||||||||||||||||||||||
object (EnergyMix) Details on the energy supplied at this location. | |||||||||||||||||||||||||||||||||||||||||||
| last_updated required | string <date-time> Timestamp when this Location or one of its EVSEs or Connectors were last updated (or created). |
{- "country_code": "st",
- "party_id": "str",
- "id": "string",
- "publish": true,
- "publish_allowed_to": [
- {
- "uid": "string",
- "type": "AD_HOC_USER",
- "visual_number": "string",
- "issuer": "string",
- "group_id": "string"
}
], - "name": "string",
- "address": "string",
- "city": "string",
- "postal_code": "string",
- "state": "string",
- "country": "str",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "related_locations": [
- {
- "latitude": "string",
- "longitude": "string",
- "name": {
- "language": "st",
- "text": "string"
}
}
], - "parking_type": "ALONG_MOTORWAY",
- "evses": [
- {
- "uid": "string",
- "evse_id": "string",
- "status": "AVAILABLE",
- "status_schedule": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z",
- "status": "AVAILABLE"
}
], - "capabilities": [
- "CHARGING_PROFILE_CAPABLE"
], - "connectors": [
- {
- "id": "string",
- "standard": "CHADEMO",
- "format": "SOCKET",
- "power_type": "AC_1_PHASE",
- "max_voltage": 0,
- "max_amperage": 0,
- "max_electric_power": 0,
- "tariff_ids": [
- "string"
], - "last_updated": "2019-08-24T14:15:22Z"
}
], - "floor_level": "stri",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "physical_reference": "string",
- "directions": [
- {
- "language": "st",
- "text": "string"
}
], - "parking_restrictions": [
- "EV_ONLY"
], - "images": [
- {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
], - "last_updated": "2019-08-24T14:15:22Z"
}
], - "directions": [
- {
- "language": "st",
- "text": "string"
}
], - "operator": {
- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}, - "suboperator": {
- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}, - "owner": {
- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}, - "facilities": [
- "HOTEL"
], - "time_zone": "string",
- "opening_times": {
- "twentyfourseven": true,
- "regular_hours": [
- {
- "weekday": 1,
- "period_begin": "string",
- "period_end": "string"
}
], - "exceptional_openings": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z"
}
], - "exceptional_closings": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z"
}
]
}, - "charging_when_closed": true,
- "images": [
- {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
], - "energy_mix": {
- "is_green_energy": true,
- "energy_sources": [
- {
- "source": "NUCLEAR",
- "percentage": 0
}
], - "environ_impact": [
- {
- "category": "NUCLEAR_WASTE",
- "amount": 0
}
], - "supplier_name": "string",
- "energy_product_name": "string"
}, - "last_updated": "2019-08-24T14:15:22Z"
}Fetch a list of Locations (paginated) and optionally filter on last_updated using date_from/date_to.
If the optional parameters date_from and/or date_to are provided, only Locations with last_updated between the given date_from (including) and date_to (excluding) will be returned.
In order for this to work properly, the following logic MUST be implemented accordingly: If an EVSE is updated, also the 'parent' Location's last_updated field needs to be updated. Similarly, if a Connector is updated, the EVSE's last_updated and the Location's last_updated fields need to be updated.
| date_from | string <date-time> Only return objects that have last_updated after or equal to this Date/Time (inclusive). |
| date_to | string <date-time> Only return objects that have last_updated up to this Date/Time, but not including (exclusive). |
| limit | integer >= 1 Maximum number of objects to GET. |
| offset | integer >= 0 Default: 0 The offset of the first object returned. Default is 0. |
| X-Request-ID required | string Every request SHALL contain a unique request ID, the response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. |
| X-Correlation-ID required | string Every request/response SHALL contain a unique correlation ID, every response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. When a Hub forwards a request to a party, the request SHALL contain the same X-Correlation-ID HTTP header (with the same value). |
| OCPI-from-country-code | string = 2 characters 'country code' of the connected party this message is sent from. |
| OCPI-from-party-id | string = 3 characters 'party id' of the connected party this message is sent from. |
| OCPI-to-country-code | string = 2 characters 'country code' of the connected party this message is to be sent to. |
| OCPI-to-party-id | string = 3 characters 'party id' of the connected party this message is to be sent to. |
{- "status_code": 1000,
- "status_message": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "data": [
- {
- "country_code": "st",
- "party_id": "str",
- "id": "string",
- "publish": true,
- "publish_allowed_to": [
- {
- "uid": "string",
- "type": "AD_HOC_USER",
- "visual_number": "string",
- "issuer": "string",
- "group_id": "string"
}
], - "name": "string",
- "address": "string",
- "city": "string",
- "postal_code": "string",
- "state": "string",
- "country": "str",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "related_locations": [
- {
- "latitude": "string",
- "longitude": "string",
- "name": {
- "language": "st",
- "text": "string"
}
}
], - "parking_type": "ALONG_MOTORWAY",
- "evses": [
- {
- "uid": "string",
- "evse_id": "string",
- "status": "AVAILABLE",
- "status_schedule": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z",
- "status": "AVAILABLE"
}
], - "capabilities": [
- "CHARGING_PROFILE_CAPABLE"
], - "connectors": [
- {
- "id": "string",
- "standard": "CHADEMO",
- "format": "SOCKET",
- "power_type": "AC_1_PHASE",
- "max_voltage": 0,
- "max_amperage": 0,
- "max_electric_power": 0,
- "tariff_ids": [
- "string"
], - "last_updated": "2019-08-24T14:15:22Z"
}
], - "floor_level": "stri",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "physical_reference": "string",
- "directions": [
- {
- "language": "st",
- "text": "string"
}
], - "parking_restrictions": [
- "EV_ONLY"
], - "images": [
- {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
], - "last_updated": "2019-08-24T14:15:22Z"
}
], - "directions": [
- {
- "language": "st",
- "text": "string"
}
], - "operator": {
- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}, - "suboperator": {
- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}, - "owner": {
- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}, - "facilities": [
- "HOTEL"
], - "time_zone": "string",
- "opening_times": {
- "twentyfourseven": true,
- "regular_hours": [
- {
- "weekday": 1,
- "period_begin": "string",
- "period_end": "string"
}
], - "exceptional_openings": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z"
}
], - "exceptional_closings": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z"
}
]
}, - "charging_when_closed": true,
- "images": [
- {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
], - "energy_mix": {
- "is_green_energy": true,
- "energy_sources": [
- {
- "source": "NUCLEAR",
- "percentage": 0
}
], - "environ_impact": [
- {
- "category": "NUCLEAR_WASTE",
- "amount": 0
}
], - "supplier_name": "string",
- "energy_product_name": "string"
}, - "last_updated": "2019-08-24T14:15:22Z"
}
]
}Retrieve a specific Location object by its location_id.
| location_id required | string <= 36 characters Location.id of the Location object to retrieve or update. |
| X-Request-ID required | string Every request SHALL contain a unique request ID, the response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. |
| X-Correlation-ID required | string Every request/response SHALL contain a unique correlation ID, every response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. When a Hub forwards a request to a party, the request SHALL contain the same X-Correlation-ID HTTP header (with the same value). |
| OCPI-from-country-code | string = 2 characters 'country code' of the connected party this message is sent from. |
| OCPI-from-party-id | string = 3 characters 'party id' of the connected party this message is sent from. |
| OCPI-to-country-code | string = 2 characters 'country code' of the connected party this message is to be sent to. |
| OCPI-to-party-id | string = 3 characters 'party id' of the connected party this message is to be sent to. |
{- "status_code": 1000,
- "status_message": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "data": {
- "country_code": "st",
- "party_id": "str",
- "id": "string",
- "publish": true,
- "publish_allowed_to": [
- {
- "uid": "string",
- "type": "AD_HOC_USER",
- "visual_number": "string",
- "issuer": "string",
- "group_id": "string"
}
], - "name": "string",
- "address": "string",
- "city": "string",
- "postal_code": "string",
- "state": "string",
- "country": "str",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "related_locations": [
- {
- "latitude": "string",
- "longitude": "string",
- "name": {
- "language": "st",
- "text": "string"
}
}
], - "parking_type": "ALONG_MOTORWAY",
- "evses": [
- {
- "uid": "string",
- "evse_id": "string",
- "status": "AVAILABLE",
- "status_schedule": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z",
- "status": "AVAILABLE"
}
], - "capabilities": [
- "CHARGING_PROFILE_CAPABLE"
], - "connectors": [
- {
- "id": "string",
- "standard": "CHADEMO",
- "format": "SOCKET",
- "power_type": "AC_1_PHASE",
- "max_voltage": 0,
- "max_amperage": 0,
- "max_electric_power": 0,
- "tariff_ids": [
- "string"
], - "last_updated": "2019-08-24T14:15:22Z"
}
], - "floor_level": "stri",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "physical_reference": "string",
- "directions": [
- {
- "language": "st",
- "text": "string"
}
], - "parking_restrictions": [
- "EV_ONLY"
], - "images": [
- {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
], - "last_updated": "2019-08-24T14:15:22Z"
}
], - "directions": [
- {
- "language": "st",
- "text": "string"
}
], - "operator": {
- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}, - "suboperator": {
- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}, - "owner": {
- "name": "string",
- "logo": {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
}, - "facilities": [
- "HOTEL"
], - "time_zone": "string",
- "opening_times": {
- "twentyfourseven": true,
- "regular_hours": [
- {
- "weekday": 1,
- "period_begin": "string",
- "period_end": "string"
}
], - "exceptional_openings": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z"
}
], - "exceptional_closings": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z"
}
]
}, - "charging_when_closed": true,
- "images": [
- {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
], - "energy_mix": {
- "is_green_energy": true,
- "energy_sources": [
- {
- "source": "NUCLEAR",
- "percentage": 0
}
], - "environ_impact": [
- {
- "category": "NUCLEAR_WASTE",
- "amount": 0
}
], - "supplier_name": "string",
- "energy_product_name": "string"
}, - "last_updated": "2019-08-24T14:15:22Z"
}
}Retrieve a specific EVSE object by its location_id and evse_uid.
| location_id required | string <= 36 characters Location.id of the Location object to retrieve or update. |
| evse_uid required | string <= 36 characters EVSE.uid of the EVSE object to retrieve or update. |
| X-Request-ID required | string Every request SHALL contain a unique request ID, the response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. |
| X-Correlation-ID required | string Every request/response SHALL contain a unique correlation ID, every response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. When a Hub forwards a request to a party, the request SHALL contain the same X-Correlation-ID HTTP header (with the same value). |
| OCPI-from-country-code | string = 2 characters 'country code' of the connected party this message is sent from. |
| OCPI-from-party-id | string = 3 characters 'party id' of the connected party this message is sent from. |
| OCPI-to-country-code | string = 2 characters 'country code' of the connected party this message is to be sent to. |
| OCPI-to-party-id | string = 3 characters 'party id' of the connected party this message is to be sent to. |
{- "status_code": 1000,
- "status_message": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "data": {
- "uid": "string",
- "evse_id": "string",
- "status": "AVAILABLE",
- "status_schedule": [
- {
- "period_begin": "2019-08-24T14:15:22Z",
- "period_end": "2019-08-24T14:15:22Z",
- "status": "AVAILABLE"
}
], - "capabilities": [
- "CHARGING_PROFILE_CAPABLE"
], - "connectors": [
- {
- "id": "string",
- "standard": "CHADEMO",
- "format": "SOCKET",
- "power_type": "AC_1_PHASE",
- "max_voltage": 0,
- "max_amperage": 0,
- "max_electric_power": 0,
- "tariff_ids": [
- "string"
], - "last_updated": "2019-08-24T14:15:22Z"
}
], - "floor_level": "stri",
- "coordinates": {
- "latitude": "string",
- "longitude": "string"
}, - "physical_reference": "string",
- "directions": [
- {
- "language": "st",
- "text": "string"
}
], - "parking_restrictions": [
- "EV_ONLY"
], - "images": [
- {
- "category": "CHARGER",
- "type": "stri",
- "width": 0,
- "height": 0
}
], - "last_updated": "2019-08-24T14:15:22Z"
}
}Retrieve a specific Connector object by its location_id, evse_uid and connector_id.
| location_id required | string <= 36 characters Location.id of the Location object to retrieve or update. |
| evse_uid required | string <= 36 characters EVSE.uid of the EVSE object to retrieve or update. |
| connector_id required | string <= 36 characters Connector.id of the Connector object to retrieve or update. |
| X-Request-ID required | string Every request SHALL contain a unique request ID, the response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. |
| X-Correlation-ID required | string Every request/response SHALL contain a unique correlation ID, every response to this request SHALL contain the same ID. It is advised to use GUID/UUID as values. When a Hub forwards a request to a party, the request SHALL contain the same X-Correlation-ID HTTP header (with the same value). |
| OCPI-from-country-code | string = 2 characters 'country code' of the connected party this message is sent from. |
| OCPI-from-party-id | string = 3 characters 'party id' of the connected party this message is sent from. |
| OCPI-to-country-code | string = 2 characters 'country code' of the connected party this message is to be sent to. |
| OCPI-to-party-id | string = 3 characters 'party id' of the connected party this message is to be sent to. |
{- "status_code": 1000,
- "status_message": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "data": {
- "id": "string",
- "standard": "CHADEMO",
- "format": "SOCKET",
- "power_type": "AC_1_PHASE",
- "max_voltage": 0,
- "max_amperage": 0,
- "max_electric_power": 0,
- "tariff_ids": [
- "string"
], - "last_updated": "2019-08-24T14:15:22Z"
}
}