Skip to navigation

Send a command to a partner CPO

Returns the CPO’s immediate CommandResponse. The async CommandResult is delivered to the OCPI gateway’s own callback; clients cannot set response_url.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionenumRequired

OCPI version: 211 (2.1.1), 221 (2.2.1) or 230 (2.3.0).

Allowed values:
commandenumRequired
Allowed values:

Query parameters

partner_idintegerRequired>=1

Roaming partner to talk to (from GET /ocpi/partners).

Request

This endpoint expects an object.
tokenmap from strings to any or nullOptional

OCPI Token for the path version (validated by the gateway).

location_idstring or nullOptional1-36 characters
evse_uidstring or nullOptional1-36 characters
connector_idstring or nullOptional1-36 characters
authorization_referencestring or nullOptional1-36 characters
session_idstring or nullOptional1-36 characters
reservation_idstring or nullOptional1-36 characters
expiry_datedatetime or nullOptional

Response

Successful Response
partner_idinteger or nullOptional
command_typestring or nullOptional
resultstring or nullOptional
command_resultstring or nullOptional
timeoutinteger or nullOptional
http_statusinteger or nullOptional
ocpi_status_codeinteger or nullOptional
duration_msinteger or nullOptional
errorstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error