Documentation

MSP · Tariffs

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

ROADRoad deviations in this section

Road enables these for your connection on request.

  • Additional fields
    Adds fields OCPI 2.1.1 does not define: the owning party (country_code and party_id) on every object, and extra location data such as a publish flag, charging accessibility, parking places and the details needed for national access point reporting. Sessions and CDRs also carry VAT-inclusive totals.
    When not enabled: Objects carry only the fields the OCPI specification defines.
  • Remapped party identity
    country_code, party_id and EVSE ids on locations, tariffs and CDRs can differ from those of the party that created them. Road rewrites them according to rules set up for the connection.
    When not enabled: Objects keep the identity of the party that created them.
GET/emsp/2.1.1/tariffs/{country_code}/{party_id}/{tariff_id}

Get a tariff

Returns a single tariff the CPO pushed to the MSP.

ROADAdditional fieldsROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
tariff_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
typestring
pricenumber <double>
step_sizeinteger <int32>
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

party_idstringROAD

OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/emsp/2.1.1/tariffs/{country_code}/{party_id}/{tariff_id}

Put a tariff

Creates or replaces a tariff in the MSP's system.

ROADAdditional fieldsROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
tariff_idstringREQUIRED
Request bodyREQUIREDapplication/json
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
typestring
pricenumber <double>
step_sizeinteger <int32>
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

party_idstringROAD

OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

Responses
200OCPI response envelope application/json
dataobject
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
typestring
pricenumber <double>
step_sizeinteger <int32>
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

party_idstringROAD

OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/emsp/2.1.1/tariffs/{country_code}/{party_id}/{tariff_id}

Patch a tariff

Partially updates a tariff in the MSP's system.

ROADAdditional fieldsROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
tariff_idstringREQUIRED
Request bodyREQUIREDapplication/json
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
typestring
pricenumber <double>
step_sizeinteger <int32>
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

party_idstringROAD

OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

Responses
200OCPI response envelope application/json
dataobject
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
typestring
pricenumber <double>
step_sizeinteger <int32>
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

party_idstringROAD

OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
DELETE/emsp/2.1.1/tariffs/{country_code}/{party_id}/{tariff_id}

Delete a tariff

Removes a tariff from the MSP's system.

ROADAdditional fieldsROADRemapped party identity
Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
tariff_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
idstring
currencystring
tariff_alt_textobject[]
languagestring
textstring
tariff_alt_urlstring
elementsobject[]
price_componentsobject[]
typestring
pricenumber <double>
step_sizeinteger <int32>
restrictionsobject
start_timestring
end_timestring
start_datestring
end_datestring
min_kwhnumber <double>
max_kwhnumber <double>
min_powernumber <double>
max_powernumber <double>
min_durationinteger <int32>
max_durationinteger <int32>
day_of_weekstring[]
min_vehicle_socinteger <int32>
min_congestion_thresholdinteger <int32>
min_congestioninteger <int32>
max_congestioninteger <int32>
energy_mixobject
is_green_energyboolean
energy_sourcesobject[]
sourcestring
percentagenumber <double>
environ_impactobject[]
sourcestring
percentagenumber <double>
supplier_namestring
energy_product_namestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

party_idstringROAD

OCPI party id of the party that owns the object. Road can rewrite it according to the rules set up for the connection.

status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.