Documentation

eMSP · Sessions

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

No Road deviations in this section. Turn off the deviations filter in the sidebar to see all of its endpoints.

GET/msp/sessions/{country_code}/{party_id}/{session_id}

Get a session

Returns a single session the CPO pushed to the eMSP.

Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
session_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
country_codestring
party_idstring
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
kwhnumber <double>
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
location_idstring
evse_uidstring
connector_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
total_costobject
before_taxesnumber <double>
taxesobject[]
namestring
account_numberstring
percentagenumber <double>
amountnumber <double>
statusstring
last_updatedstring <date-time>
evse_statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PUT/msp/sessions/{country_code}/{party_id}/{session_id}

Put a session

Creates or replaces a session in the eMSP's system.

Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
session_idstringREQUIRED
Request bodyREQUIREDapplication/json
country_codestring
party_idstring
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
kwhnumber <double>
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
location_idstring
evse_uidstring
connector_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
total_costobject
before_taxesnumber <double>
taxesobject[]
namestring
account_numberstring
percentagenumber <double>
amountnumber <double>
statusstring
last_updatedstring <date-time>
evse_statusstring
Responses
200OCPI response envelope application/json
dataobject
country_codestring
party_idstring
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
kwhnumber <double>
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
location_idstring
evse_uidstring
connector_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
total_costobject
before_taxesnumber <double>
taxesobject[]
namestring
account_numberstring
percentagenumber <double>
amountnumber <double>
statusstring
last_updatedstring <date-time>
evse_statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/msp/sessions/{country_code}/{party_id}/{session_id}

Patch a session

Partially updates a session in the eMSP's system.

Request
Path parameters3
country_codestringREQUIRED
party_idstringREQUIRED
session_idstringREQUIRED
Request bodyREQUIREDapplication/json
country_codestring
party_idstring
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
kwhnumber <double>
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
location_idstring
evse_uidstring
connector_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
total_costobject
before_taxesnumber <double>
taxesobject[]
namestring
account_numberstring
percentagenumber <double>
amountnumber <double>
statusstring
last_updatedstring <date-time>
evse_statusstring
Responses
200OCPI response envelope application/json
dataobject
country_codestring
party_idstring
idstring
start_date_timestring <date-time>
end_date_timestring <date-time>
kwhnumber <double>
cdr_tokenobject
country_codestring
party_idstring
uidstring
typestring
contract_idstring
auth_methodstring
authorization_referencestring
location_idstring
evse_uidstring
connector_idstring
meter_idstring
currencystring
charging_periodsobject[]
start_date_timestring <date-time>
dimensionsobject[]
typestring
volumenumber <double>
tariff_idstring
total_costobject
before_taxesnumber <double>
taxesobject[]
namestring
account_numberstring
percentagenumber <double>
amountnumber <double>
statusstring
last_updatedstring <date-time>
evse_statusstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.