All docschevron-rightAPI Docschevron-rightarrow-leftNavigationchevron-rightEV Platform API

EV Platform API

book
EV Platform API version

This documentation is for v1 of the EV Platform API.

The Mapbox EV Platform API provides a set of services for EV use cases, including:

  • EV Search API - Search for EV charge points near a proximity.
  • EV Commands API - Implements the OCPI Commands module to reserve an EVSE and to start a charging session.
  • EV CDRs API - Implements the OCPI CDRs module and is used to retrieve billing information for a completed charging session.
  • EV Locations API - Implements the OCPI Locations module, supports real-time retrieval updates for OCPI Locations, EVSEs, and Connectors by ID, including availability.
  • EV Sessions API - Implements the OCPI Sessions module and is used to retrieve updates related to an active charging session.
  • EV Tariffs API - Implements the OCPI Tariffs module to retrieve EV charge point prices.

EV Platform Profiles

The EV Platform API supports profile-based configuration. With a custom profile, consumers of this API may adjust the behavior of the EV Platform, including:

  • Search ranking, relevance, and conflation
  • Define data source(s) to be included in search results
  • Define webhooks used to take part in publish/subscribe transactions.

EV Search API

EV Search APIs support forward geocoding searches in multiple static ( for example: Mapbox-hosted) and dynamic ( for example: 3rd party forward geocoding APIs) data sources.

Search for EV Charge Points

get
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/locations?latitude={latitude}&longitude={longitude}&distance={distance}"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.
X-MBX-EV-PLATFORM-SEARCH-LATfloatThe latitude of the proximity in which to conduct a forward geocoding search for charge point POIs. A header variable to convey proximity latitude is offered for those customers that do not want this value to be visible in log files.
X-MBX-EV-PLATFORM-SEARCH-LNGfloatThe longitude of the proximity in which to conduct a forward geocoding search for charge point POIs. A header variable to convey proximity longitude is offered for those customers that do not want this value to be visible in log files..

Required Parameters

ParametersTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
latitudefloatThe latitude of the proximity in which to conduct a forward geocoding search for charge point POIs. If this value is not present then X-MBX-SEARCH-LAT must be present in the header.
longitudefloatThe longitude of the proximity in which to conduct a forward geocoding search for charge point POIs. If this value is not present then X-MBX-SEARCH-LNG must be present in the header.
distancefloatThe maximum distance in kilometers from the proximity of the OCPI Location objects to be included in the search result.

Optional Parameters

ParametersTypeDescription
limitintegerAn optional limit on the number of charge points to be provided in the response. The default value is 100.
connectorTypesstringAn optional comma-delimited list of the OCPI ConnectorTypes to be included in the response. By default all connector types will be included in the response unless the EV Platform Profile also specifies a connector type filter.
operatorsstringAn optional comma-delimited list of the charge point operators that are preferred. When present, only CPOs specified in this list will be included in the response.

Example Request

# Retrieve EV charge points within 1 kilometer of the SJC airport.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/locations?latitude=37.364714&longitude=-121.924238&distance=1?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

The response to an EV Search API request is a GeoJSON FeatureCollection object that contains the following properties:

PropertyTypeDescription
typestringThe GeoJSON object type, this value is always 'FeatureCollection'.
featuresarrayThe GeoJSON Feature objects describe a relevant EV charge point.
features[].typearrayThe GeoJSON object type, this value is always 'Feature'.
features[].geometryobjectA GeoJSON Geometry object that describes where the EV charge point object is located.
features[].propertiesobjectAn object that contains details about an OCPI Location.
features[].properties.locationobjectAn OCPI Location object.
features[].properties.tariffsobjectA collection of OCPI Tariff objects that describe the cost associated with session charges.
features[].properties.proximityobjectA Proximity object that describes the distance from the search proximity to the EV charge point.

Example Response

{
    "type": "FeatureCollection",
    "features": [
        {
            "type": "Feature",
            "geometry": {
                "type": "Point",
                "coordinates": [
                    -121.920559,
                    37.367285
                ]
            },
            "properties": {
                "location": {
                    "country_code": "US",
                    "party_id": "MBX",
                    "id": "dXJuOm1ieHBvaToxMjM0NQ==",
                    "publish": false,
                    "name": "Hudson Concourse",
                    "address": "1741 Technology Drive",
                    "city": "San Jose",
                    "postal_code": "95110",
                    "state": "CA",
                    "country": "USA",
                    "coordinates": {
                        "latitude": "37.3672850",
                        "longitude": "-121.9205590"
                    },
                    "evses": [
                        {
                            "uid": "82686",
                            "evse_id": "82686",
                            "status": "AVAILABLE",
                            "connectors": [
                                {
                                    "id": "5",
                                    "standard": "IEC_62196_T1",
                                    "format": "CABLE",
                                    "power_type": "AC_1_PHASE",
                                    "max_voltage": 240,
                                    "max_amperage": 27,
                                    "max_electric_power": 6.5,
                                    "tariff_ids": [
                                        "dXJuOm1ieHBvaToxMjM0NQ=="
                                    ],
                                    "last_updated": "2022-08-11T14:03:44"
                                }
                            ],
                            "coordinates": {
                                "latitude": "37.3672850",
                                "longitude": "-121.9205590"
                            },
                            "mbx_ext": { "pnc_capable": true },
                            "last_updated": "2022-08-11T14:03:44"
                        },
                        {
                            "uid": "82687",
                            "evse_id": "82687",
                            "status": "AVAILABLE",
                            "connectors": [
                                {
                                    "id": "5",
                                    "standard": "IEC_62196_T1",
                                    "format": "CABLE",
                                    "power_type": "AC_1_PHASE",
                                    "max_voltage": 240,
                                    "max_amperage": 27,
                                    "max_electric_power": 6.5,
                                    "tariff_ids": [
                                        "dXJuOm1ieHBvaToxMjM0NQ=="
                                    ],
                                    "last_updated": "2022-08-11T14:03:44"
                                }
                            ],
                            "coordinates": {
                                "latitude": "37.3672850",
                                "longitude": "-121.9205590"
                            },
                            "mbx_ext": { "pnc_capable": true },
                            "last_updated": "2022-08-11T14:03:44"
                        }
                    ],
                    "operator": {
                        "name": "ChargePoint"
                    },
                    "owner": {
                        "name": "ChargePoint"
                    },
                    "time_zone": "America/Los_Angeles",
                    "opening_times": {
                        "twentyfourseven": true
                    },
                    "mbx_ext": { "pnc_capable": true },
                    "last_updated": "2022-08-11T14:03:44"
                },
                "tariffs": {
                    "id": "dXJuOm1ieHBvaToxMjM0NQ==",
                    "tariff": {
                        "country_code": "US",
                        "party_id": "MBX",
                        "id": "dXJuOm1ieHBvaToxMjM0NQ==",
                        "currency": "USD",
                        "type": "REGULAR",
                        "tariff_alt_text": [
                            {
                                "language": "en",
                                "text": "$1/hr"
                            }
                        ],
                        "elements": [
                            {
                                "price_components": [
                                    {
                                        "type": "TIME",
                                        "price": 1.00,
                                        "step_size": 1
                                    },
                                    {
                                        "type": "ENERGY",
                                        "price": 1.00,
                                        "step_size": 1
                                    }
                                ]
                            }
                        ],
                        "last_updated": "2022-08-11T14:03:44"
                    }
                },
                "proximity": {
                    "latitude": 37.364714,
                    "longitude": -121.924238,
                    "distance": 0.43294229650723554
                }
            }
        }
    ]
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or an expected parameter, either latitude, longitude, or distance, was not provided.
401Not AuthorizedThe API is not authorized for use for the provided access token.

EV Locations API

EV Locations API implements APIs defined by the OCPI Locations module.

Retrieve Location by ID

get
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/locations/{locationID}"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

ParametersTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
locationIDstringThe MapboxId associated with the OCPI Location to be retrieved.

Optional Parameters

N/A

Example Request

# Retrieve an OCPI Location object by its ID.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/locations/dXJuOm1ieHBvaToxMjM0NQ==?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI Location.

Example Response

{
    "country_code": "US",
    "party_id": "MBX",
    "id": "dXJuOm1ieHBvaToxMjM0NQ==",
    "publish": false,
    "name": "Hudson Concourse",
    "address": "1741 Technology Drive",
    "city": "San Jose",
    "postal_code": "95110",
    "state": "CA",
    "country": "USA",
    "coordinates": {
        "latitude": "37.3672850",
        "longitude": "-121.9205590"
    },
    "evses": [
        {
            "uid": "82686",
            "evse_id": "82686",
            "status": "AVAILABLE",
            "connectors": [
                {
                    "id": "5",
                    "standard": "IEC_62196_T1",
                    "format": "CABLE",
                    "power_type": "AC_1_PHASE",
                    "max_voltage": 240,
                    "max_amperage": 27,
                    "max_electric_power": 6.5,
                    "tariff_ids": [
                        "dXJuOm1ieHBvaToxMjM0NQ=="
                    ],
                    "mbx_ext": { "pnc_capable": true },
                    "last_updated": "2022-08-11T14:03:44"
                }
            ],
            "coordinates": {
                "latitude": "37.3672850",
                "longitude": "-121.9205590"
            },
            "last_updated": "2022-08-11T14:03:44"
        },
        {
            "uid": "82687",
            "evse_id": "82687",
            "status": "AVAILABLE",
            "connectors": [
                {
                    "id": "5",
                    "standard": "IEC_62196_T1",
                    "format": "CABLE",
                    "power_type": "AC_1_PHASE",
                    "max_voltage": 240,
                    "max_amperage": 27,
                    "max_electric_power": 6.5,
                    "tariff_ids": [
                        "dXJuOm1ieHBvaToxMjM0NQ=="
                    ],
                    "mbx_ext": { "pnc_capable": true },
                    "last_updated": "2022-08-11T14:03:44"
                }
            ],
            "coordinates": {
                "latitude": "37.3672850",
                "longitude": "-121.9205590"
            },
            "last_updated": "2022-08-11T14:03:44"
        }
    ],
    "operator": {
        "name": "ChargePoint"
    },
    "owner": {
        "name": "ChargePoint"
    },
    "time_zone": "America/Los_Angeles",
    "opening_times": {
        "twentyfourseven": true
    },
    "mbx_ext": { "pnc_capable": true },
    "last_updated": "2022-08-11T14:03:44"
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or the MapboxId associated with the OCPI Location is not valid.
401Not AuthorizedThe API is not authorized for use for the provided access token.
404Not FoundThe OCPI Location object does not exist.

Retrieve EVSE by ID

get
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/locations/{locationID}/{evseUID}"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

ParametersTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
locationIDstringThe MapboxId associated with the OCPI Location to be retrieved.
evseUIDstringThe id of the OCPI EVSE object to be retrieved.

Optional Parameters

N/A

Example Request

# Retrieve an OCPI EVSE object by its ID.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/locations/dXJuOm1ieHBvaToxMjM0NQ==/82686?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI EVSE.

Example Response

{
    "uid": "82686",
    "evse_id": "82686",
    "status": "AVAILABLE",
    "connectors": [
        {
            "id": "5",
            "standard": "IEC_62196_T1",
            "format": "CABLE",
            "power_type": "AC_1_PHASE",
            "max_voltage": 240,
            "max_amperage": 27,
            "max_electric_power": 6.5,
            "tariff_ids": [
                "dXJuOm1ieHBvaToxMjM0NQ=="
            ],
            "last_updated": "2022-08-11T14:03:44"
        }
    ],
    "coordinates": {
        "latitude": "37.3672850",
        "longitude": "-121.9205590"
    },
    "mbx_ext": { "pnc_capable": true },
    "last_updated": "2022-08-11T14:03:44"
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or the MapboxId associated with the OCPI Location is not valid.
401Not AuthorizedThe API is not authorized for use for the provided access token.
404Not FoundThe OCPI EVSE object does not exist.

Retrieve Connector by ID

get
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/locations/{locationID}/{evseUID}/{connectorID}"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

Required ParametersTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
locationIDstringThe MapboxId associated with the OCPI Location to be retrieved.
evseUIDstringThe ID of the OCPI EVSE object to be retrieved.
connectorIDstringThe ID of the OCPI Connector object to be retrieved.

Optional Parameters

N/A

Example Request

# Retrieve an OCPI Connector object by its ID.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/locations/dXJuOm1ieHBvaToxMjM0NQ==/82686/5?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI Connector.

Example Response

{
    "id": "5",
    "standard": "IEC_62196_T1",
    "format": "CABLE",
    "power_type": "AC_1_PHASE",
    "max_voltage": 240,
    "max_amperage": 27,
    "max_electric_power": 6.5,
    "tariff_ids": [
        "dXJuOm1ieHBvaToxMjM0NQ=="
    ],
    "last_updated": "2022-08-11T14:03:44"
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or the MapboxId associated with the OCPI Location is not valid.
401Not AuthorizedThe API is not authorized for use for the provided access token.
404Not FoundThe OCPI Connector object does not exist.

EV Commands Module API

EV Commands API implements APIs defined by the OCPI Commands module.

Cancel Reservation

post
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/commands/CANCEL_RESERVATION"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

NameTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
N/ACancelReservationThe OCPI CancelReservation object that contains the information needed to cancel an existing reservation.

Optional Parameters

N/A

Example Request

# Cancel a reservation.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/Commands/CANCEL_RESERVATION?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI CommandResponse.

Example Response

{
    "result": "ACCEPTED",
    "timeout": 0
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or the OCPI CancelReservation contained in the request payload is not valid ( for example: invalid reservation ID, missing response_url).
401Not AuthorizedThe API is not authorized for use for the provided access token.
404Not FoundThe IDs corresponding to the OCPI Location/EVSE/Connector object does not exist.

Reserve EVSE

post
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/commands/RESERVE_NOW"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

NameTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
N/AReserveNowThe OCPI ReserveNow object that contains the information needed to reserve a (specific) connector of a Charge Point for a given Token.

Optional Parameters

N/A

Example Request

# Reserve an EVSE.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/Commands/RESERVE_NOW?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI CommandResponse.

Example Response

{
    "result": "ACCEPTED",
    "timeout": 0
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or the OCPI ReserveNow contained in the request payload is not valid ( for example: invalid Location ID, missing response_url).
401Not AuthorizedThe API is not authorized for use for the provided access token.
404Not FoundThe IDs corresponding to the OCPI Location/EVSE/Connector object does not exist.

Start Charging Session

post
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/commands/START_SESSION"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

NameTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
N/AStartSessionThe OCPI StartSession object that contains the information needed to start a session.

Optional Parameters

N/A

Example Request

# Start a charging session.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/Commands/START_SESSION?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI CommandResponse.

Example Response

{
    "result": "ACCEPTED",
    "timeout": 0
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or the OCPI StartSession contained in the request payload is not valid ( for example: invalid Location ID, missing response_url).
401Not AuthorizedThe API is not authorized for use for the provided access token.
404Not FoundThe IDs corresponding to the OCPI Location/EVSE/Connector object does not exist.

Stop Charging Session

post
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/commands/STOP_SESSION"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

NameTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
N/AStopSessionThe OCPI StopSession object that contains the information needed to stop a session.

Optional Parameters

N/A

Example Request

# End an in-progress charging session.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/Commands/STOP_SESSION?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI CommandResponse.

Example Response

{
    "result": "ACCEPTED",
    "timeout": 0
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or the OCPI StopSession contained in the request payload is not valid ( for example: invalid Session ID, missing response_url).
401Not AuthorizedThe API is not authorized for use for the provided access token.
404Not FoundThe OCPI Session object does not exist.

EV CDRs Module API

Retrieve CDR by ID

get
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/cdrs/{cdrID}"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

Required ParametersTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
cdrIDstringThe identifier of the OCPI CDR to be retrieved.

Optional Parameters

ParametersTypeDescription
sessionIDstringThe identifier of the OCPI Session associated with the OCPI CDR to be retrieved. This ID may be used in place of the CDR ID if the CDR ID is not known.
correlationIDstringThe correlation ID specified by the REST API client or by the EV Platform that is associated with the OCPI CDR. This ID may be used in place of the CDR ID if the CDR ID is not known.

Example Request

# Retrieve an OCPI Session object by its ID.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/cdrs/dXJuOm1ieHBvaToxMjM0NQ==?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI CDR.

Example Response

{
    "country_code": "US",
    "party_id": "MBX",
    "id": "12345",
    "start_date_time": "2015-06-29T21:39:09Z",
    "end_date_time": "2015-06-29T23:37:32Z",
    "cdr_token": {
        "uid": "012345678",
        "type": "RFID",
        "contract_id": "US12345"
    },
    "auth_method": "WHITELIST",
    "cdr_location": {
        "id": "LOC1",
        "address": "1741 Technology Drive",
        "city": "San Jose",
        "postal_code": "95110",
        "country": "USA",
        "coordinates": {
            "latitude": "37.3672850",
            "longitude": "-121.9205590"
        },
        "evse_uid": "3256",
        "evse_id": "3256",
        "connector_id": "1",
        "connector_standard": "IEC_62196_T2",
        "connector_format": "SOCKET",
        "connector_power_type": "AC_1_PHASE"
    },
    "currency": "USD",
    "tariffs": [
        {
            "country_code": "US",
            "party_id": "MBX",
            "id": "12",
            "currency": "USD",
            "elements": [
                {
                    "price_components": [
                        {
                            "type": "TIME",
                            "price": 2.00,
                            "vat": 10.0,
                            "step_size": 300
                        }
                    ]
                }
            ],
            "last_updated": "2015-02-02T14:15:01Z"
        }
    ],
    "charging_periods": [
        {
            "start_date_time": "2015-06-29T21:39:09Z",
            "dimensions": [
                {
                    "type": "TIME",
                    "volume": 1.973
                }
            ],
            "tariff_id": "12"
        }
    ],
    "total_cost": {
        "excl_vat": 4.00,
        "incl_vat": 4.40
    },
    "total_energy": 15.342,
    "total_time": 1.973,
    "total_time_cost": {
        "excl_vat": 4.00,
        "incl_vat": 4.40
    },
    "last_updated": "2015-06-29T22:01:13Z"
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or an expected parameter, either latitude, longitude, or distance, was not provided.
401Not AuthorizedThe API is not authorized for use for the provided access token.

EV Sessions Module API

Retrieve Session

get
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/sessions/{sessionID}"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

Required ParametersTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
sessionIDstringThe identifier of the OCPI Session to be retrieved.

Optional Parameters

N/A

Example Request

# Retrieve an OCPI Session object by its ID.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/sessions/dXJuOm1ieHBvaToxMjM0NQ==?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI Session.

Example Response

{
    "country_code": "US",
    "party_id": "MBX",
    "id": "101",
    "start_date_time": "2015-06-29T22:39:09Z",
    "end_date_time": "2015-06-29T23:50:16Z",
    "kwh": 41.00,
    "cdr_token": {
        "uid": "123abc",
        "type": "RFID",
        "contract_id": "NL-TST-C12345678-S"
    },
    "auth_method": "WHITELIST",
    "location_id": "LOC1",
    "evse_uid": "3256",
    "connector_id": "1",
    "currency": "USD",
    "charging_periods": [
        {
            "start_date_time": "2015-06-29T22:39:09Z",
            "dimensions": [
                {
                    "type": "ENERGY",
                    "volume": 120
                },
                {
                    "type": "MAX_CURRENT",
                    "volume": 30
                }
            ]
        },
        {
            "start_date_time": "2015-06-29T22:40:54Z",
            "dimensions": [
                {
                    "type": "ENERGY",
                    "volume": 41000
                },
                {
                    "type": "MIN_CURRENT",
                    "volume": 34
                }
            ]
        },
        {
            "start_date_time": "2015-06-29T23:07:09Z",
            "dimensions": [
                {
                    "type": "PARKING_TIME",
                    "volume": 0.718
                }
            ],
            "tariff_id": "12"
        }
    ],
    "total_cost": {
        "excl_vat": 8.50,
        "incl_vat": 9.35
    },
    "status": "COMPLETED",
    "last_updated": "2015-06-29T23:50:17Z"
}

EV Tariffs Module API

Retrieve Tariff by ID

get
https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/tariffs/{country_code}/{party_id}/{tariff_id}"

Header Variables

ParametersTypeDescription
X-MBX-ACCESS-TOKENstringAn optional value that contains the Mapbox access token used to allow access to Mapbox APIs. If this value is not present then access_token must be present in the query string. A header variable to convey Mapbox access token is offered for those customers that do not want this value to be visible in log files.

Required Parameters

Required ParametersTypeDescription
access_tokenstringThe Mapbox access token used to allow access to Mapbox APIs. If this value is not present then X-MBX-ACCESS-TOKEN must be present in the header.
country_codestringThe country code associated with the OCPI Tariff to be retrieved.
partyIDstringThe ID of the party - or provider - that defined the tariff.
tariffIDstringThe ID of the OCPI Tariff object to retrieve.

Optional Parameters

N/A

Example Request

# Retrieve an OCPI Tariff object by its ID.

$ curl "https://ev-platform-api-staging.tilestream.net/ev/v1/ocpi-2.2/tariffs/US/MBX/dXJuOm1ieHBvaToxMjM0NQ==?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

Response

See OCPI Tariff.

Example Response

{
    "country_code": "US",
    "party_id": "MBX",
    "id": "dXJuOm1ieHBvaToxMjM0NQ==",
    "currency": "USD",
    "type": "REGULAR",
    "tariff_alt_text": [
        {
            "language": "en",
            "text": "$1/hr"
        }
    ],
    "elements": [
        {
            "price_components": [
                {
                    "type": "TIME",
                    "price": 1.00,
                    "step_size": 1
                },
                {
                    "type": "ENERGY",
                    "price": 1.00,
                    "step_size": 1
                }
            ]
        }
    ],
    "last_updated": "2022-08-11T14:03:44"
}

Errors

HTTP Status CodeResponse PayloadDescription
400Bad RequestThe feature is not enabled for the provided Mapbox access token, or the IDs associated with the OCPI Tariff are not valid.
401Not AuthorizedThe Mapbox access_token is not valid.
404Not FoundThe OCPI Tariff object does not exist.

EV Search API and Locations API Types

Types used by the EV Search and Locations APIs are defined below.

OCPI Location

PropertyTypeCardinalityDescription
country_codestring1ISO-3166 alpha-2 country code of the CPO that 'owns' this Location.
party_idstring1ID of the CPO that 'owns' this Location (following the ISO-15118 standard).
idstring1Uniquely identifies the location within the CPOs platform (and suboperator platforms). This field can never be changed, modified or renamed.
publishboolean1Defines if a Location may be published on an website or app etc. When this is set to false, this location is only visible by tokens identified in the field: publish_allowed_to. When the same location has EVSEs that may be published and may not be published, two 'Locations' should be created.
publish_allowed_toobject (PublishTokenType)*This field may only be used when the publish field is false. The location is shared only with owners of Tokens that match all the set fields of one PublishToken in the list.
namestring?Display name of the location.
addressstring1Street/block name and house number if available.
citystring1City or town.
postal_codestring?Postal code of the location, may only be omitted when the location has no postal code: in some countries charging locations at highways don’t have postal codes.
statestring?State or province of the location, only to be used when relevant.
countrystring1ISO 3166-1 alpha-3 code for the country of this location.
coordinatesobject (GeoLocation)1Coordinates of the location.
related_locationsarray (AdditionalGeoLocation)*Geographical location of related points relevant to the user.
parking_typeobject (ParkingType)?The general type of parking at the charge point location.
evsesarray (EVSE)*List of EVSEs that belong to this Location.
directionsobject (DisplayText)*Human-readable directions on how to reach the location.
operatorobject (BusinessDetails)?Information of the operator. When not specified, the information retrieved from the Credentials module, selected by the country_code and party_id of this Location, should be used instead.
suboperatorobject (BusinessDetails)?Information of the suboperator if available.
ownerobject (BusinessDetails)?Information of the owner if available.
facilitiesobject (Facility)*Optional list of facilities this charging location directly belongs to.
time_zonestring1One of IANA time zone data’s TZ-values representing the time zone of the location. Examples: "Europe/Oslo", "Europe/Zurich". See
opening_timesobject (Hours)?The times when the EVSEs at the location can be accessed for charging.
charging_when_closedboolean?Indicates if the EVSEs are still charging outside the opening hours of the location. for example when the parking garage closes its barriers over night, is it allowed to charge till the next morning? Default: true
imagesobject (Image)*Links to images related to the location such as photos or logos.
energy_mixobject (EnergyMix)?Details on the energy supplied at this location.
mbx_extobject (Mapbox Location Extension)?Optional Mapbox specific location extension object.
last_updatedobject (DateTime)1Timestamp when this Location or one of its EVSEs or Connectors were last updated (or created).

OCPI EVSE

PropertyTypeCardinalityDescription
uidstring1Uniquely identifies the EVSE within the CPOs platform (and suboperator platforms). For example a database ID or the actual "EVSE ID". 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. This field is named uid instead of id, because id could be confused with evse_id which is an eMI3 defined field.
evse_idstring?Compliant with the following specification for EVSE ID from "eMI3 standard version V1.0" (http://emi3group.com/documents-links/) "Part 2: business objects." 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.
statusobject (Status)1Indicates the current status of the EVSE.
status_scheduleobject (StatusSchedule)*Indicates a planned status update of the EVSE.
capabilitiesobject (Capability)*List of functionalities that the EVSE is capable of.
connectorsobject (Connector)+List of available connectors on the EVSE.
floor_levelstring?Level on which the Charge Point is located (in garage buildings) in the locally displayed numbering scheme.
coordinatesobject (GeoLocation)?Coordinates of the EVSE.
physical_referencestring?A number/string printed on the outside of the EVSE for visual identification.
directionsobject (DisplayText)*Multi-language human-readable directions when more detailed information on how to reach the EVSE from the Location is required.
parking_restrictionsobject (ParkingRestriction)*The restrictions that apply to the parking spot.
imagesobject (Image)*Links to images related to the EVSE such as photos or logos.
mbx_extobject (Mapbox EVSE Extension)?Optional Mapbox specific EVSE extension object.
last_updatedobject (DateTime)1Timestamp when this EVSE or one of its Connectors was last updated (or created).

OCPI Connector

PropertyTypeCardinalityDescription
idstring1Identifier 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.
standardobject (ConnectorType)1The standard of the installed connector.
formatobject (ConnectorFormat)1The format (socket/cable) of the installed connector.
power_typeobject (PowerType)1
max_voltageinteger1Maximum 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_amperageinteger1Maximum amperage of the connector, in ampere [A].
max_electric_powerinteger?Maximum electric power that can be delivered by this connector, in Watts (W). Used when the maximum electric power is lower than the calculated value from voltage and amperage. For example: A DC Charge Point which can delivers up to 920V and up to 400A can be limited to a maximum of 150kW (max_electric_power = 150000). Depending on the car, it may supply max voltage or current, but not both at the same time. For AC Charge Points, the amount of phases used can also have influence on the maximum power.
tariff_idsstring*Identifiers of the 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. When preference-based smart charging is supported, one tariff for every possible ProfileType should be provided. These tell the user about the options they have at this Connector, and what the tariff is for every option. For a "free of charge" tariff, this field must point to a defined "free of charge" tariff.
terms_and_conditionsstring?URL to the operator’s terms and conditions.
last_updatedobject (DateTime)1Timestamp when this Connector was last updated (or created).

EV Search API and Locations API Supplemental Types

Supplemental types used by the EV Search and Locations APIs are defined below.

Proximity

PropertyTypeCardinalityDescription
latitudefloat1Latitude of the proximity in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}.[0-9]{5,7}
longitudefloat1Longitude of the proximity in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}.[0-9]{5,7}
distancefloat1The distance, in kilometers, of the POI from the proximity.

OCPI AdditionalGeoLocation

PropertyTypeCardinalityDescription
latitudestring1Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}.[0-9]{5,7}
longitudestring1Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}.[0-9]{5,7}
nameobject (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 it’s number.

OCPI BusinessDetails

PropertyTypeCardinalityDescription
name string1Name of the operator.
websitestring?Link to the operator’s website.
logoobject (Image)?Image link to the operator’s logo.

OCPI Capability

ValueDescription
CHARGING_PROFILE_CAPABLEThe EVSE supports charging profiles.
CHARGING_PREFERENCES_CAPABLEThe EVSE supports charging preferences.
CHIP_CARD_SUPPORTEVSE has a payment terminal that supports chip cards.
CONTACTLESS_CARD_SUPPORTEVSE has a payment terminal that supports contactless cards.
CREDIT_CARD_PAYABLEEVSE has a payment terminal that makes it possible to pay for charging using a credit card.
DEBIT_CARD_PAYABLEEVSE has a payment terminal that makes it possible to pay for charging using a debit card.
PED_TERMINALEVSE has a payment terminal with a pin-code entry device.
REMOTE_START_STOP_CAPABLEThe EVSE can remotely be started/stopped.
RESERVABLEThe EVSE can be reserved.
RFID_READERCharging at this EVSE can be authorized with an RFID token.
START_SESSION_CONNECTOR_REQUIREDWhen a StartSession is received by this EVSE, the eMSP is required to add the optional connector_id field in the StartSession object.
TOKEN_GROUP_CAPABLEThis 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 an EV driver has both a card and key-fob).
UNLOCK_CAPABLEConnectors have mechanical lock that can be requested by the eMSP to be unlocked.

OCPI ConnectorFormat

ValueDescription
SOCKETThe connector is a socket; the EV user needs to bring a fitting plug.
CABLEThe connector is an attached cable; the EV users car needs to have a fitting inlet.

OCPI ConnectorType

ValueDescription
CHADEMOThe connector type is CHAdeMO, DC
CHAOJIThe ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
DOMESTIC_AStandard/Domestic household, type "A", NEMA 1-15, 2 pins
DOMESTIC_BStandard/Domestic household, type "B", NEMA 5-15, 3 pins
DOMESTIC_CStandard/Domestic household, type "C", CEE 7/17, 2 pins
DOMESTIC_DStandard/Domestic household, type "D", 3 pin
DOMESTIC_EStandard/Domestic household, type "E", CEE 7/5 3 pins
DOMESTIC_FStandard/Domestic household, type "F", CEE 7/4, Schuko, 3 pins
DOMESTIC_GStandard/Domestic household, type "G", BS 1363, Commonwealth, 3 pins
DOMESTIC_HStandard/Domestic household, type "H", SI-32, 3 pins
DOMESTIC_IStandard/Domestic household, type "I", AS 3112, 3 pins
DOMESTIC_JStandard/Domestic household, type "J", SEV 1011, 3 pins
DOMESTIC_KStandard/Domestic household, type "K", DS 60884-2-D1, 3 pins
DOMESTIC_LStandard/Domestic household, type "L", CEI 23-16-VII, 3 pins
DOMESTIC_MStandard/Domestic household, type "M", BS 546, 3 pins
DOMESTIC_NStandard/Domestic household, type "N", NBR 14136, 3 pins
DOMESTIC_OStandard/Domestic household, type "O", TIS 166-2549, 3 pins
GBT_ACGuobiao GB/T 20234.2 AC socket/connector
GBT_DCGuobiao GB/T 20234.3 DC connector
IEC_60309_2_single_16IEC 60309-2 Industrial Connector single phase 16 amperes (usually blue)
IEC_60309_2_three_16IEC 60309-2 Industrial Connector three phases 16 amperes (usually red)
IEC_60309_2_three_32IEC 60309-2 Industrial Connector three phases 32 amperes (usually red)
IEC_60309_2_three_64IEC 60309-2 Industrial Connector three phases 64 amperes (usually red)
IEC_62196_T1IEC 62196 Type 1 "SAE J1772"
IEC_62196_T1_COMBOCombo Type 1 based, DC
IEC_62196_T2IEC 62196 Type 2 "Mennekes"
IEC_62196_T2_COMBOCombo Type 2 based, DC
IEC_62196_T3AIEC 62196 Type 3A
IEC_62196_T3CIEC 62196 Type 3C "Scame"
NEMA_5_20NEMA 5-20, 3 pins
NEMA_6_30NEMA 6-30, 3 pins
NEMA_6_50NEMA 6-50, 3 pins
NEMA_10_30NEMA 10-30, 3 pins
NEMA_10_50NEMA 10-50, 3 pins
NEMA_14_30NEMA 14-30, 3 pins, rating of 30 A
NEMA_14_50NEMA 14-50, 3 pins, rating of 50 A
PANTOGRAPH_BOTTOM_UPOn-board Bottom up Pantograph typically for bus charging
PANTOGRAPH_TOP_DOWNOff-board Top down Pantograph typically for bus charging
TESLA_RTesla Connector "Roadster"-type (round, 4 pin)
TESLA_STesla Connector "Model-S"-type (oval, 5 pin)

OCPI EnergyMix

PropertyTypeCardinalityDescription
is_green_energyboolean1True if 100% from regenerative sources. (CO2 and nuclear waste is zero)
energy_sourcesobject (EnergySource)*Key-value pairs (enum + percentage) of energy sources of this location’s tariff.
environ_impactobject (EnvironmentalImpact)*Key-value pairs (enum + percentage) of nuclear waste and CO2 exhaust of this location’s tariff.
supplier_namestring?Name of the energy supplier, delivering the energy for this location or tariff.
energy_product_namestring?Name of the energy suppliers product/tariff plan used at this location.

OCPI EnergySource

PropertyTypeCardinalityDescription
sourceobject (EnergySourceCategory)1The type of energy source.
percentageinteger1Percentage of this source (0-100) in the mix.

OCPI EnergySourceCategory

ValueDescription
NUCLEARNuclear power sources.
GENERAL_FOSSILAll kinds of fossil power sources.
COALFossil power from coal.
GASFossil power from gas.
GENERAL_GREENAll kinds of regenerative power sources.
SOLARRegenerative power from photo voltaic.
WINDRegenerative power from wind turbines.
WATERRegenerative power from water turbines.

OCPI EnvironmentalImpact

PropertyTypeCardinalityDescription
categorystring (EnvironmentalImpactCategory)1 The environmental impact category of this value.
amountfloat1Amount of this part in g/kWh.

OCPI EnvironmentalImpactCategory

ValueDescription
NUCLEAR_WASTEProduced nuclear waste in grams per kilowatt hour.
CARBON_DIOXIDEExhausted carbon dioxide in grams per kilowatt hour.

OCPI ExceptionalPeriod

PropertyTypeCardinalityDescription
period_beginobject (DateTime)1Begin of the exception. In UTC, time_zone field can be used to convert to local time.
period_endobject (DateTime)1End of the exception. In UTC, time_zone field can be used to convert to local time.

OCPI Facility

ValueDescription
HOTELA hotel.
RESTAURANTA restaurant.
CAFEA cafe.
MALLA mall or shopping center.
SUPERMARKETA supermarket.
SPORTSport facilities: gym, field etc.
RECREATION_AREAA recreation area.
NATURELocated in, or close to, a park, nature reserve etc.
MUSEUMA museum.
BIKE_SHARINGA bike/e-bike/e-scooter sharing location.
BUS_STOPA bus stop.
TAXI_STANDA taxi stand.
TRAM_STOPA tram stop/station.
METRO_STATIONA metro station.
TRAIN_STATIONA train station.
AIRPORTAn airport.
PARKING_LOTA parking lot.
CARPOOL_PARKINGA carpool parking.
FUEL_STATIONA Fuel station.
WIFIWifi or other type of internet available.

OCPI GeoLocation

PropertyTypeCardinalityDescription
latitudestring1Latitude of the point in decimal degree. Example: 50.770774. Decimal separator: "." Regex: -?[0-9]{1,2}.[0-9]{5,7}
longitudestring1Longitude of the point in decimal degree. Example: -126.104965. Decimal separator: "." Regex: -?[0-9]{1,3}.[0-9]{5,7}

OCPI Hours

PropertyTypeCardinalityDescription
twentyfoursevenboolean1True to represent 24 hours a day and 7 days a week, except the given exceptions.
regular_hoursRegularHours*Regular hours, weekday-based. Only to be used if twentyfourseven=false, then this field needs to contain at least one RegularHours object.
exceptional_openingsExceptionalPeriod*Exceptions for specified calendar dates, time-range based. Times the station is operating/accessible. Additional to regular_hours. May overlap regular rules.
exceptional_closingsExceptionalPeriod*Exceptions for specified calendar dates, time-range based. Times the station is not operating/accessible. Overwriting regular_hours and exceptional_openings. Should not overlap exceptional_openings.

OCPI Image

PropertyTypeCardinalityDescription
urlstring1URL from where the image data can be fetched through a web browser.
thumbnailstring?URL from where a thumbnail of the image can be fetched through a web browser.
categoryImageCategory1Describes what the image is used for.
typestring1Image type like: gif, jpeg, png, svg.
widthinteger?Width of the full scale image.
heightinteger?Height of the full scale image.

OCPI ImageCategory

ValueDescription
CHARGERPhoto of the physical device that contains one or more EVSEs.
ENTRANCELocation entrance photo. Should show the car entrance to the location from street side.
LOCATIONLocation overview photo.
NETWORKLogo of an associated roaming network to be displayed with the EVSE for example in lists, maps and detailed information views.
OPERATORLogo 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.
OTHEROther
OWNERLogo of the charge point owner, for example a local store, to be displayed in the EVSEs detailed information view.

OCPI ParkingRestriction

ValueDescription
EV_ONLYReserved parking spot for electric vehicles.
PLUGGEDParking is only allowed while plugged in (charging).
DISABLEDReserved parking spot for disabled people with valid ID.
CUSTOMERSParking spot for customers/guests only, for example in case of a hotel or shop.
MOTORCYCLESParking spot only suitable for (electric) motorcycles or scooters.

OCPI ParkingType

ValueDescription
ALONG_MOTORWAYLocation on a parking facility/rest area along a motorway, freeway, interstate, highway etc.
PARKING_GARAGEMultistorey car park.
PARKING_LOTA cleared area that is intended for parking vehicles, as in at super markets, bars, etc.
ON_DRIVEWAYLocation is on the driveway of a house/building.
ON_STREETParking in public space along a street.
UNDERGROUND_GARAGEMultistorey car park, mainly underground.

OCPI PowerType

ValueDescription
AC_1_PHASEAC single phase.
AC_2_PHASEAC two phases, only two of the three available phases connected.
AC_2_PHASE_SPLITAC two phases using split phase system.
AC_3_PHASEAC three phases.
DCDirect Current.

OCPI PublishTokenType

PropertyTypeCardinalityDescription
uidstring?Unique ID by which this Token can be identified.
typeTokenType?Type of the token.
visual_numberstring?Visual readable number/identification as printed on the Token (RFID card).
issuerstring?Issuing company, most of the times the name of the company printed on the token (RFID card), not necessarily the eMSP.

group_id | string | ? | This ID groups a couple of tokens. This can be used to make two or more tokens

OCPI RegularHours

PropertyTypeCardinalityDescription
weekdayinteger1Number of day in the week, from Monday (1) till Sunday (7)
period_beginstring1Begin of the regular period, in local time, given in hours and minutes. Must be in 24h format with leading zeros. Example: "18:15". Hour/Minute separator: ":" Regex: ([0-1][0-9]
period_endstring1End of the regular period, in local time, syntax as for period_begin. Must be later than period_begin.

OCPI Status

ValueDescription
AVAILABLEThe EVSE/Connector is able to start a new charging session.
BLOCKEDThe EVSE/Connector is not accessible because of a physical barrier, as in a car.
CHARGINGThe EVSE/Connector is in use.
INOPERATIVEThe EVSE/Connector is not yet active, or temporarily not available for use, but not broken or defect.

OUTOFORDER| The EVSE/Connector is out of order, some part/components may be broken/defective.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).

OCPI StatusSchedule

PropertyTypeCardinalityDescription
period_beginDateTime1Begin of the scheduled period.
period_endDateTime?End of the scheduled period, if known.
statusStatus1Status value during the scheduled period.

EV Commands API Types

Types used by the EV Commands APIs are defined below.

OCPI CancelReservation

PropertyTypeCardinalityDescription
response_urlstring1URL that the CommandResult POST should be send to. This URL might contain a unique ID to be able to distinguish between CancelReservation requests.
reservation_idstring1Reservation id, unique for this reservation. If the Charge Point already has a reservation that matches this reservation_id the Charge Point will replace the reservation.

OCPI CommandResponse

PropertyTypeCardinalityDescription
resultCommandResponseType1Response from the CPO on the command request.
timeoutint1Timeout for this command in seconds. When the Result is not received within this timeout, the eMSP can assume that the message might never be send.
messageDisplayText*Human-readable description of the result (if one can be provided), multiple languages can be provided.

OCPI CommandResult

PropertyTypeCardinalityDescription
resultCommandResultType1Result of the command request as sent by the Charge Point to the CPO.
messageDisplayText*Human-readable description of the reason (if one can be provided), multiple languages can be provided.

OCPI ReserveNow

PropertyTypeCardinalityDescription
response_urlstring1URL that the CommandResult POST should be send to. This URL might contain a unique ID to be able to distinguish between ReserveNow requests.
tokenToken1Token object for how to reserve this Charge Point (and specific EVSE).
expiry_dateDateTime1The Date/Time when this reservation ends, in UTC.
reservation_idstring1Reservation id, unique for this reservation. If the Receiver (typically CPO) Point already has a reservation that matches this reservation_id for that Location it will replace the reservation.
location_idstring1Location.id of the Location (belonging to the CPO this request is send to) for which to reserve an EVSE.
evse_uidstring?Optional EVSE.uid of the EVSE of this Location if a specific EVSE has to be reserved.
authorization_referencestring?Reference to the authorization given by the eMSP, when given, this reference will be provided in the relevant Session and/or CDR.

OCPI StartSession

PropertyTypeCardinalityDescription
response_urlstring1POST CommandResult responses to this URL. This URL might contain a unique ID to be able to distinguish between StartSession requests.
tokenToken1Token object the Charge Point has to use to start a new session. The Token provided in this request is authorized by the eMSP.
location_idstring1Location.id of the Location (belonging to the CPO this request is send to) on which a session is to be started.
evse_uidstring?Optional EVSE.uid of the EVSE of this Location on which a session is to be started. Required when connector_id is set.
connector_idstring?Optional Connector.id of the Connector of the EVSE on which a session is to be started. This field is required when the capability: START_SESSION_CONNECTOR_REQUIRED is set on the EVSE.
authorization_referencestring?Reference to the authorization given by the eMSP, when given, this reference will be provided in the relevant Session and/or CDR.

OCPI StopSession

PropertyTypeCardinalityDescription
response_urlstring1POST CommandResult responses to this URL. This URL might contain a unique ID to be able to distinguish between StopSession requests.
session_idstring1Session.id of the Session that is requested to be stopped.

EV Commands API Supplemental Types

Supplemental types used by the EV Commands APIs are defined below.

OCPI CommandResponseType

ValueDescription
NOT_SUPPORTEDThe requested command is not supported by this CPO, Charge Point, EVSE etc.
REJECTEDCommand request rejected by the CPO. (Session might not be from a customer of the eMSP that send this request)
ACCEPTEDCommand request accepted by the CPO.
UNKNOWN_SESSIONThe Session in the requested command is not known by this CPO.

OCPI CommandResultType

ValueDescription
ACCEPTEDCommand request accepted by the Charge Point.
CANCELED_RESERVATIONThe Reservation has been canceled by the CPO.
EVSE_OCCUPIEDEVSE is occupied, another session is ongoing. Cannot start a new session
EVSE_INOPERATIVEEVSE is inoperative or faulted.

FAILED | Execution of the command failed at the Charge Point.NOT_SUPPORTED | The requested command is not supported by this Charge Point, EVSE etc.REJECTED | Command request rejected by the Charge Point.TIMEOUT | Command request timeout, no response received from the Charge Point in a reasonable time.UNKNOWN_RESERVATION | The Reservation in the requested command is not known by this Charge Point.

OCPI CommandType

ValueDescription
CANCEL_RESERVATIONRequest the Charge Point to cancel a specific reservation.
RESERVE_NOWRequest the Charge Point to reserve a (specific) EVSE for a Token for a certain time, starting now.
START_SESSIONRequest the Charge Point to start a transaction on the given EVSE/Connector.
STOP_SESSIONRequest the Charge Point to stop an ongoing session.

EV CDRs API Types

Types used by the EV CDRs APIs are defined below.

OCPI CDR

PropertyTypeCardinalityDescription
country_codestring1ISO-3166 alpha-2 country code of the CPO that 'owns' this CDR.
party_idstring1ID of the CPO that 'owns' this CDR (following the ISO-15118 standard).
idstring1Uniquely identifies the CDR, the ID MUST be unique per country_code/party_id combination. This field is longer than the usual 36 characters to allow for credit CDRs to have something appended to the original ID. Normal (non-credit) CDRs MUST only have an ID with a maximum length of 36.
start_date_timeDateTime1Start timestamp of the charging session, or in-case of a reservation (before the start of a session) the start of the reservation.
end_date_timeDateTime1The timestamp when the session was completed/finished, charging might have finished before the session ends, for example: EV is full, but parking cost also has to be paid.
session_idstring?Unique ID of the Session for this CDR. Is only allowed to be omitted when the CPO has not implemented the Sessions module or this CDR is the result of a reservation that never became a charging session, thus no OCPI Session.
cdr_tokenCdrToken1Token used to start this charging session, including all the relevant information to identify the unique token.
auth_methodAuthMethod1Method used for authentication. Multiple are possible during a charging sessions, for example when the session was started with a reservation: ReserveNow: COMMAND. When the driver arrives and starts charging using a Token that is whitelisted: WHITELIST. The last method MUST be used in the CDR.
authorization_referencestring?Reference to the authorization provided by the eMSP. When the eMSP provided an authorization reference in either: real-time authorization, StartSession or ReserveNow, this field MUST contain the same value. When different authorization reference values have been provided by the eMSP that are relevant to this Session, the last provided value MUST be used here.
cdr_locationCdrLocation1Location where the charging session took place, including only the relevant EVSE and Connector.
meter_idstring?Identification of the Meter inside the Charge Point.
currencystring1Currency of the CDR in ISO 4217 Code.
tariffsTariff*List of relevant Tariff Elements, see: Tariff. When relevant, a Free of Charge tariff should also be in this list, and point to a defined Free of Charge Tariff.

charging_periods | ChargingPeriod | + | List of Charging Periods that make up this charging session. A session consists of 1 or more periods, where each period has a different relevant Tariff.signed_data | SignedData | ? | Signed data that belongs to this charging Session.total_cost | Price | 1 | Total sum of all the costs of this transaction in the specified currency.total_fixed_cost | Price | ? | Total sum of all the fixed costs in the specified currency, except fixed price components of parking and reservation. The cost not depending on amount of time/energy used etc. Can contain costs like a start tariff.total_energy | number | 1 | Total energy charged, in kWh.total_energy_cost | Price | ? | Total sum of all the cost of all the energy used, in the specified currency.total_time | number | 1 | Total duration of the charging session (including the duration of charging and not charging), in hours.total_time_cost | Price | ? | Total sum of all the cost related to duration of charging during this transaction, in the specified currency.total_parking_time | number | ? | Total duration of the charging session where the EV was not charging (no energy was transferred between EVSE and EV), in hours.total_parking_cost | Price | ? | Total sum of all the cost related to parking of this transaction, including fixed price components, in the specified currency.total_reservation_cost | Price | ? | Total sum of all the cost related to a reservation of a Charge Point, including fixed price components, in the specified currency.remark | string | ? | Optional remark, can be used to provide additional human readable information to the CDR, for example: reason why a transaction was stopped.invoice_reference_id | string | ? | This field can be used to reference an invoice, that will later be send for this CDR. Making it easier to link a CDR to a given invoice. Maybe even group CDRs that will be on the same invoice.credit | boolean | ? | When TRUE, this is a Credit CDR, and the field credit_reference_id is required as well.credit_reference_id | string | ? | This field is required for a Credit CDR. This MUST contain the id of the CDR for which this is a Credit CDR.home_charging_compensation | boolean | ? | When set to true, this CDR is for a charging session using the home charger of the EV Driver for which the energy cost needs to be financial compensated to the EV Driver.last_updated |DateTime | 1 | Timestamp when this CDR was last updated (or created).

OCPI AuthMethod

ValueDescription

AUTH_REQUEST | Authentication request has been sent to the eMSP.COMMAND | Command like StartSession or ReserveNow used to start the Session, the Token provided in the Command was used as authorization.WHITELIST | Whitelist used for authentication, no request to the eMSP has been performed.

OCPI CdrDimension

PropertyTypeCardinalityDescription
typeCdrDimensionType1Type of CDR dimension.
volumenumber1Volume of the dimension consumed, measured according to the dimension type.

OCPI CdrDimensionType

ValueDescription
CURRENTAverage charging current during this ChargingPeriod: defined in A (Ampere). When negative, the current is flowing from the EV to the grid.
ENERGYTotal amount of energy (dis-)charged during this ChargingPeriod: defined in kWh. When negative, more energy was feed into the grid then charged into the EV. Default step_size is 1.
ENERGY_EXPORTTotal amount of energy feed back into the grid: defined in kWh.
ENERGY_IMPORTTotal amount of energy charged, defined in kWh.
MAX_CURRENTSum of the maximum current over all phases, reached during this ChargingPeriod: defined in A (Ampere).
MIN_CURRENTSum of the minimum current over all phases, reached during this ChargingPeriod, when negative, current has flowed from the EV to the grid. Defined in A (Ampere).
MAX_POWERMaximum power reached during this ChargingPeriod: defined in kW (Kilowatt).
MIN_POWERMinimum power reached during this ChargingPeriod: defined in kW (Kilowatt), when negative, the power has flowed from the EV to the grid.
PARKING_TIMETime during this ChargingPeriod not charging: defined in hours, default step_size multiplier is 1 second.
POWERAverage power during this ChargingPeriod: defined in kW (Kilowatt). When negative, the power is flowing from the EV to the grid.
RESERVATION_TIMETime during this ChargingPeriod Charge Point has been reserved and not yet been in use for this customer: defined in hours, default step_size multiplier is 1 second.
STATE_OF_CHARGECurrent state of charge of the EV, in percentage, values allowed: 0 to 100. See note below.
TIMETime charging during this ChargingPeriod: defined in hours, default step_size multiplier is 1 second.

OCPI CdrLocation

PropertyTypeCardinalityDescription
idstring1Uniquely identifies the location within the CPO’s platform (and suboperator platforms). This field can never be changed, modified or renamed.
namestring?Display name of the location.
addressstring1Street/block name and house number if available.
citystring1City or town.
postal_codestring?Postal code of the location, may only be omitted when the location has no postal code: in some countries charging locations at highways don’t have postal codes.
statestring?State only to be used when relevant.
countrystring1ISO 3166-1 alpha-3 code for the country of this location.
coordinatesGeoLocation1Coordinates of the location.
evse_uidstring1Uniquely identifies the EVSE within the CPO’s platform (and suboperator platforms). For example a database unique ID or the actual EVSE ID. 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. Allowed to be set to: #NA when this CDR is created for a reservation that never resulted in a charging session.
evse_idstring1Compliant with the following specification for EVSE ID from "eMI3 standard version V1.0" (http://emi3group.com/documents-links/) "Part 2: business objects.". Allowed to be set to: #NA when this CDR is created for a reservation that never resulted in a charging session.
connector_idstring1Identifier of the connector within the EVSE. Allowed to be set to: #NA when this CDR is created for a reservation that never resulted in a charging session.
connector_standardConnectorType1The standard of the installed connector. When this CDR is created for a reservation that never resulted in a charging session, this field can be any value and should be ignored by the Receiver.
connector_formatConnectorFormat1The format (socket/cable) of the installed connector. When this CDR is created for a reservation that never resulted in a charging session, this field can be any value and should be ignored by the Receiver.
connector_power_typePowerType1When this CDR is created for a reservation that never resulted in a charging session, this field can be any value and should be ignored by the Receiver.

OCPI CdrToken

PropertyTypeCardinalityDescription
country_codestring1ISO-3166 alpha-2 country code of the eMSP that 'owns' this Token.
party_idstring1ID of the eMSP that 'owns' this Token (following the ISO-15118 standard).
uidstring1Unique ID by which this Token can be identified. This is the field used by the CPO’s system (RFID reader on the Charge Point) to identify this token. In most cases: type=RFID, this is the RFID hidden ID as read by the RFID reader, but that is not a requirement. If this is a type=APP_USER Token, it will be a unique, by the eMSP, generated ID.
typeTokenType1Type of the token
contract_idstring1Uniquely identifies the EV driver contract token within the eMSP’s platform (and suboperator platforms). Recommended to follow the specification for eMA ID from "eMI3 standard version V1.0" (http://emi3group.com/documents-links/) "Part 2: business objects."

OCPI ChargingPeriod

PropertyTypeCardinalityDescription
start_date_timeDateTime1Start timestamp of the charging period. A period ends when the next period starts. The last period ends when the session ends.
dimensionsCdrDimension+List of relevant values for this charging period.
tariff_idstring?Unique identifier of the Tariff that is relevant for this Charging Period. If not provided, no Tariff is relevant during this period.

OCPI SignedData

PropertyTypeCardinalityDescription
encoding_methodstring1The name of the encoding used in the SignedData field. This is the name given to the encoding by a company or group of companies. See note below.
encoding_method_versionint?Version of the EncodingMethod (when applicable)
public_keystring?Public key used to sign the data, base64 encoded.
signed_valuesSignedValue+One or more signed values.
urlstring?URL to show to an EV driver. This URL gives the EV driver the possibility to check the signed data from a charging session.

OCPI SignedValue

PropertyTypeCardinalityDescription
naturestring1Nature of the value, in other words, the event this value belongs to. Possible values at moment of writing: Start (value at the start of the Session), End (signed value at the end of the Session), Intermediate (signed values take during the Session, after Start, before End). Others might be added later.
plain_datastring1The un-encoded string of data. The format of the content depends on the EncodingMethod field.
signed_datastring1Blob of signed data, base64 encoded. The format of the content depends on the EncodingMethod field.

EV Sessions API Types

Types used by the EV Sessions APIs are defined below.

OCPI Session

PropertyTypeCardinalityDescription
country_codestring1ISO-3166 alpha-2 country code of the CPO that 'owns' this Session.
party_idstring1ID of the CPO that 'owns' this Session (following the ISO-15118 standard).
idstring1The unique id that identifies the charging session in the CPO platform.
start_date_timeDateTime1The timestamp when the session became ACTIVE in the Charge Point. When the session is still PENDING, this field MUST be the time the Session was created at the Charge Point. When a Session goes from PENDING to ACTIVE, this field MUST be updated to the moment the Session went to ACTIVE in the Charge Point.
end_date_timeDateTime?The timestamp when the session was completed/finished, charging might have finished before the session ends, for example: EV is full, but parking cost also has to be paid.
kwhnumber1How many kWh were charged.
cdr_tokenCdrToken1Token used to start this charging session, including all the relevant information to identify the unique token.
auth_methodAuthMethod1Method used for authentication. This might change during a session, for example when the session was started with a reservation: ReserveNow: COMMAND. When the driver arrives and starts charging using a Token that is whitelisted: WHITELIST.
authorization_referencestring?Reference to the authorization given by the eMSP. When the eMSP provided an authorization_reference in either: real-time authorization, StartSession or ReserveNow this field MUST contain the same value. When different authorization_reference values have been provided by the eMSP that are relevant to this Session, the last value provided MUST be used here.
location_idstring1Location.id of the Location object of this CPO, on which the charging session is/was happening.
evse_uidstring1EVSE.uid of the EVSE of this Location on which the charging session is/was happening. Allowed to be set to: #NA when this session is created for a reservation, but no EVSE yet assigned to the driver.
connector_idstring1Connector.id of the Connector of this Location where the charging session is/was happening. Allowed to be set to: #NA when this session is created for a reservation, but no connector yet assigned to the driver.
meter_idstring?Optional identification of the kWh meter.
currencystring1ISO 4217 code of the currency used for this session.

charging_periods | ChargingPeriod | * | An optional list of Charging Periods that can be used to calculate and verify the total cost.total_cost | Price | ? | The total cost of the session in the specified currency. This is the price that the eMSP will have to pay to the CPO. A total_cost of 0.00 means free of charge. When omitted,as in when no price information is passed in the session object, it does not imply the session is/was free of charge.status | SessionStatus | 1 | The status of the session.last_updated | DateTime | 1 | Timestamp when this Session was last updated (or created).

EV Tariffs API Types

Types used by the EV Tariffs APIs are defined below.

OCPI Tariff

PropertyTypeCardinalityDescription
country_codestring1ISO-3166 alpha-2 country code of the CPO that owns this Tariff.
party_idstring1ID of the CPO that 'owns' this Tariff (following the ISO-15118 standard).
idstring1Uniquely identifies the tariff within the CPO’s platform (and suboperator platforms).
currencystring1ISO-4217 code of the currency of this tariff.
typeTariffType?Defines the type of the tariff. This allows for distinction in case of given Charging Preferences. When omitted, this tariff is valid for all sessions.
tariff_alt_textDisplayText*List of multi-language alternative tariff information texts.
tariff_alt_urlURL?URL to a webpage that contains an explanation of the tariff information in human readable form.
min_pricePrice?Use this property to declare a Charging Session tariff will base cost of this amount. This is different from a FLAT fee (Start Tariff, Transaction Fee), a FLAT fee is a fixed amount for any Charging Session. A minimum price indicates that when the cost of a Charging Session is lower than this amount, the cost of the Session will be equal to this amount. (Also see note below)
max_pricePrice?Set this field and a Charging Session with this tariff will NOT cost more than this amount. (See note below)
elementsTariffElement+List of Tariff Elements.
start_date_timeDateTime?The time when this tariff becomes active, in UTC, time_zone field of the Location can be used to convert to local time. Typically used for a new tariff that is already given with the location, before it becomes active. (See note below)
end_date_timeDateTime?The time after which this tariff is no longer valid, in UTC, time_zone field if the Location can be used to convert to local time. Typically used when this tariff is going to be replaced with a different tariff soon. (See note below)
energy_mixEnergyMix?Details on the energy supplied with this tariff.
last_updatedDateTime1Timestamp when this Tariff was last updated (or created).

EV Tariffs API Supplemental Types

Supplemental types used by the EV Tariffs APIs are defined below.

OCPI DayOfWeek

ValueDescription
MONDAYMonday
TUESDAYTuesday
WEDNESDAYWednesday
THURSDAYThursday
FRIDAYFriday
SATURDAYSaturday
SUNDAYSunday

OCPI PriceComponent

PropertyTypeCardinalityDescription
typeTariffDimensionType1Type of tariff dimension.
pricefloat1Price per unit (excl. VAT) for this tariff dimension.
vatinteger?Applicable VAT percentage for this tariff dimension. If omitted, no VAT is applicable. Not providing a VAT is different from 0% VAT, which would be a value of 0.0 here.
step_sizeinteger1Minimum amount to be billed. This unit will be billed in this step_size blocks. Amounts that are less then this step_size are rounded up to the given step_size. For example: if type is TIME and step_size has a value of 300, then time will be billed in blocks of 5 minutes. If 6 minutes were used, 10 minutes (2 blocks of step_size) will be billed.

OCPI ReservationRestrictionType

ValueDescription
RESERVATIONUsed in TariffElements to describe costs for a reservation.
RESERVATION_EXPIRESUsed in TariffElements to describe costs for a reservation that expires (as in when driver does not start a charging session before expiry_date of the reservation).

OCPI TariffElement

PropertyTypeCardinalityDescription
price_componentsPriceComponent+List of price components that describe the pricing of a tariff.
restrictionsTariffRestrictions?Restrictions that describe the applicability of a tariff.

OCPI TariffDimensionType

ValueDescription
ENERGYDefined in kWh, step_size multiplier: 1 Wh
FLATFlat fee without unit for step_size
PARKING_TIMETime not charging: defined in hours, step_size multiplier: 1 second
TIMETime charging: defined in hours, step_size multiplier: 1 second

Can also be used in combination with a RESERVATION restriction to describe the price of the reservation time.

OCPI TariffRestrictions

PropertyTypeCardinalityDescription
start_timestring?Start time of day in local time, the time zone is defined in the time_zone field of the Location, for example 13:30, valid from this time of the day. Must be in 24h format with leading zeros. Hour/Minute separator: ":" Regex: ([0-1][0-9]
end_timestring?End time of day in local time, the time zone is defined in the time_zone field of the Location, for example 19:45, valid until this time of the day. Same syntax as start_time. If end_time < start_time then the period wraps around to the next day. To stop at end of the day use: 00:00.
start_datestring?Start date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-24, valid from this day (inclusive). Regex: ([12][0-9]{3})-(0[1-9]
end_datestring?End date in local time, the time zone is defined in the time_zone field of the Location, for example: 2015-12-27, valid until this day (exclusive). Same syntax as start_date.
min_kwhfloat?Minimum consumed energy in kWh, for example 20, valid from this amount of energy (inclusive) being used.
max_kwhfloat?Maximum consumed energy in kWh, for example 50, valid until this amount of energy (exclusive) being used.
min_currentfloat?Sum of the minimum current (in Amperes) over all phases, for example 5. When the EV is charging with more than, or equal to, the defined amount of current, this TariffElement is/becomes active. If the charging current is or becomes lower, this TariffElement is not or no longer valid and becomes inactive. This describes NOT the minimum current over the entire Charging Session. This restriction can make a TariffElement become active when the charging current is above the defined value, but the TariffElement MUST no longer be active when the charging current drops below the defined value.
max_currentfloat?Sum of the maximum current (in Amperes) over all phases, for example 20. When the EV is charging with less than the defined amount of current, this TariffElement becomes/is active. If the charging current is or becomes higher, this TariffElement is not or no longer valid and becomes inactive. This describes NOT the maximum current over the entire Charging Session. This restriction can make a TariffElement become active when the charging current is below this value, but the TariffElement MUST no longer be active when the charging current raises above the defined value.
min_powerfloat?Minimum power in kW, for example 5. When the EV is charging with more than, or equal to, the defined amount of power, this TariffElement is/becomes active. If the charging power is or becomes lower, this TariffElement is not or no longer valid and becomes inactive. This describes NOT the minimum power over the entire Charging Session. This restriction can make a TariffElement become active when the charging power is above this value, but the TariffElement MUST no longer be active when the charging power drops below the defined value.
max_powerfloat?Maximum power in kW, for example 20. When the EV is charging with less than the defined amount of power, this TariffElement becomes/is active. If the charging power is or becomes higher, this TariffElement is not or no longer valid and becomes inactive. This describes NOT the maximum power over the entire Charging Session. This restriction can make a TariffElement become active when the charging power is below this value, but the TariffElement MUST no longer be active when the charging power raises above the defined value.
min_durationinteger?Minimum duration in seconds the Charging Session MUST last (inclusive). When the duration of a Charging Session is longer than the defined value, this TariffElement is or becomes active. Before that moment, this TariffElement is not yet active.
max_durationinteger?Maximum duration in seconds the Charging Session MUST last (exclusive). When the duration of a Charging Session is shorter than the defined value, this TariffElement is or becomes active. After that moment, this TariffElement is no longer active.
day_of_weekDayOfWeek*Which day(s) of the week this TariffElement is active.

reservation | ReservationRestrictionType | ? | When this field is present, the TariffElement describes reservation costs. A reservation starts when the reservation is made, and ends when the driver starts charging on the reserved EVSE/Location, or when the reservation expires. A reservation can only have: FLAT and TIME TariffDimensions, where TIME is for the duration of the reservation.

OCPI TariffType

ValueDescription
AD_HOC_PAYMENTUsed to describe that a Tariff is valid when ad-hoc payment is used at the Charge Point (for example: Debit or Credit card payment terminal).
PROFILE_CHEAPUsed to describe that a Tariff is valid when Charging Preference: CHEAP is set for the session.
PROFILE_FASTUsed to describe that a Tariff is valid when Charging Preference: FAST is set for the session.
PROFILE_GREENUsed to describe that a Tariff is valid when Charging Preference: GREEN is set for the session.
REGULARUsed to describe that a Tariff is valid when using an RFID, without any Charging Preference, or when Charging Preference: REGULAR is set for the session.

EV Platform Supplemental Types

Supplemental types used by the EV Platform APIs are defined below.

OCPI DateTime

All timestamps are formatted as string following RFC 3339, with some additional limitations.

OCPI DisplayText

PropertyTypeCardinalityDescription
languagestring1Language Code ISO 639-1.
textstring1Text to be displayed to an end user. No markup, HTML etc. allowed.

OCPI Price

PropertyTypeCardinalityDescription
excl_vatfloat1Price/Cost excluding VAT.
incl_vatfloat?Price/Cost including VAT.