CSME bulk pairing

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

API for management of CSME pairings

GET/1/csme-clients

Get all CSME clients available to a specific account

This will return the array of available CSME clients. CSME client is an instance of configuration that exists in Road platform to store communication parameters between Road and a third-party system that aims to receive charging station telemetry and send commands to it. In theory, there might be multiple items in the response, due to multiple CSME clients available to the account.

Authorization

User sessionAPI credential

Permissions

evse-controllers-integrations:read

OAuth

Request

Query parameters1

accountIdstringREQUIRED

Responses

200Request successful application/json

dataCsmeClientDTO[]

idstring

The unique identifier of the CSME client

namestring

The name of the CSME client

400Invalid Request application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

401Request is unauthorized, ensure that valid authentication credentials are provided application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

403Request is forbidden, ensure that authentication credentials provided have necessary permissions application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

404Not Found application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

500Internal server error application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

GET/1/csme-pairings

Get the list of existing CSME pairings per user

Returns the list of established CSME pairings. May contain multiple items.

Authorization

User sessionAPI credential

Permissions

evse-controllers-integrations:read

OAuth

Request

Query parameters1

accountIdstringREQUIRED

Responses

200Request successful application/json

dataCsmePairingDTO[]

csmeClientIdstring

The unique identifier of the CSME client

evseControllerIdstring

The unique identifier of a charging station (EVSE controller) on Road platform

idstring

The unique identifier of the CSME pairing

400Invalid Request application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

401Request is unauthorized, ensure that valid authentication credentials are provided application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

403Request is forbidden, ensure that authentication credentials provided have necessary permissions. This can happen if the credentials don't have access to the account. application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

404Not Found application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

500Internal server error application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

POST/1/csme-pairings

Create new CSME pairing of a charging station with CSME client

Allows to establish new pairing.

Authorization

User sessionAPI credential

Permissions

evse-controllers-integrations:write

OAuth

Request

Request bodyapplication/json

csmeClientIdstring <uuid>REQUIRED

evseControllerIdstringREQUIRED

pairingCodestringREQUIRED

Responses

201Pairing successfully created application/json

dataCsmePairingDTO

csmeClientIdstring

The unique identifier of the CSME client

evseControllerIdstring

The unique identifier of a charging station (EVSE controller) on Road platform

idstring

The unique identifier of the CSME pairing

400Invalid Request application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

401Request is unauthorized, ensure that valid authentication credentials are provided application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

403Request is forbidden, ensure that authentication credentials provided have necessary permissions. This can happen if the credentials don't have access to the CSME client or EVSE controller. application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

404Invalid or expired pairing code application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

409Pairing already exists application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

500Internal server error application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

DELETE/1/csme-pairings/{pairingId}

Delete existing pairing

Deletes existing pairing by its ID

Authorization

User sessionAPI credential

Permissions

evse-controllers-integrations:write

OAuth

Request

Path parameters1

pairingIdstringREQUIRED

Responses

204Pairing successfully deleted text/plain

Returns a file (Text).

400Invalid Request application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

401Request is unauthorized, ensure that valid authentication credentials are provided application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

403Request is forbidden, ensure that authentication credentials provided have necessary permissions. This can happen if the credentials don't have access to the pairing. application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

404Pairing not found application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED

500Internal server error application/json

errorobject

detailsobject

messagestringREQUIRED

statusnumberREQUIRED

typestringREQUIRED