Documentation

eMSP · Data sharing

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

ROADData sharing module
Non-standard endpoints through which a CPO (on the eMSP interface) or an eMSP (on the CPO interface) lists the counterparties it may share sessions with and creates, scopes and revokes data sharing permissions towards them. The owner is the caller's party in the interface's role.
Not part of the OCPI specification. Available on every connection.
GET/msp/datasharing/counterparties

List data sharing counterparties

Road extension. Returns the parties the calling CPO holds a live agreement with and may share sessions with: loyalty schemes, smart charging providers, navigation providers. The OCPI-from headers select the owner party when the connection carries several.

Responses
200OCPI response envelope application/json
dataobject[]
country_codestring
party_idstring
rolestring
namestring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/msp/datasharing/permissions

List data sharing permissions

Road extension. Returns the calling CPO's active permissions; include_revoked=true adds revoked ones.

Responses
200OCPI response envelope application/json
dataobject[]
idstring
kindstring
ownerobject
country_codestring
party_idstring
rolestring
counterpartyobject
country_codestring
party_idstring
rolestring
identity_policystring
cost_sharedboolean
include_cdrsboolean
scopeobject
allboolean
entriesobject[]
location_idstring
evse_uidstring
sourceobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
created_atstring <date-time>
revoked_atstring <date-time>
revoked_byobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
POST/msp/datasharing/permissions

Create a data sharing permission

Road extension. Grants a counterparty the calling CPO's sessions in scope. kind is OBSERVE_SESSIONS or SMART_CHARGING; identity_policy is FULL, PSEUDONYMISED (default) or PARTY_ONLY; scope is all or a list of location and EVSE entries. A smart charging scope already delegated to another counterparty is refused with HTTP 409.

Request
Request bodyREQUIREDapplication/json
kindstring
counterpartyobject
country_codestring
party_idstring
rolestring
identity_policystring
cost_sharedboolean
include_cdrsboolean
scopeobject
allboolean
entriesobject[]
location_idstring
evse_uidstring
Responses
200OCPI response envelope application/json
dataobject
idstring
kindstring
ownerobject
country_codestring
party_idstring
rolestring
counterpartyobject
country_codestring
party_idstring
rolestring
identity_policystring
cost_sharedboolean
include_cdrsboolean
scopeobject
allboolean
entriesobject[]
location_idstring
evse_uidstring
sourceobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
created_atstring <date-time>
revoked_atstring <date-time>
revoked_byobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/msp/datasharing/permissions/{permission_id}

Get a data sharing permission

Road extension. Returns one of the calling CPO's permissions.

Request
Path parameters1
permission_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
idstring
kindstring
ownerobject
country_codestring
party_idstring
rolestring
counterpartyobject
country_codestring
party_idstring
rolestring
identity_policystring
cost_sharedboolean
include_cdrsboolean
scopeobject
allboolean
entriesobject[]
location_idstring
evse_uidstring
sourceobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
created_atstring <date-time>
revoked_atstring <date-time>
revoked_byobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/msp/datasharing/permissions/{permission_id}

Update a data sharing permission's scope

Road extension. Adds entries to and removes entries from an entries scope. An all-locations scope cannot be edited.

Request
Path parameters1
permission_idstringREQUIRED
Request bodyREQUIREDapplication/json
addobject[]
location_idstring
evse_uidstring
removeobject[]
location_idstring
evse_uidstring
Responses
200OCPI response envelope application/json
dataobject
idstring
kindstring
ownerobject
country_codestring
party_idstring
rolestring
counterpartyobject
country_codestring
party_idstring
rolestring
identity_policystring
cost_sharedboolean
include_cdrsboolean
scopeobject
allboolean
entriesobject[]
location_idstring
evse_uidstring
sourceobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
created_atstring <date-time>
revoked_atstring <date-time>
revoked_byobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
DELETE/msp/datasharing/permissions/{permission_id}

Revoke a data sharing permission

Road extension. Revokes the permission and returns its final record. Sessions created afterwards no longer carry it; sessions in flight finish as stamped.

Request
Path parameters1
permission_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
idstring
kindstring
ownerobject
country_codestring
party_idstring
rolestring
counterpartyobject
country_codestring
party_idstring
rolestring
identity_policystring
cost_sharedboolean
include_cdrsboolean
scopeobject
allboolean
entriesobject[]
location_idstring
evse_uidstring
sourceobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
created_atstring <date-time>
revoked_atstring <date-time>
revoked_byobject
adminobject
subjectstring
apiobject
connection_idstring
subjectstring
offerobject
offer_idstring
offer_acceptance_idstring
terms_versioninteger <int64>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.