Skip to navigation

Request the active charging profile of a partner session (2.2.1 / 2.3.0)

Asks the CPO for the charging profile active on a session it runs. The result arrives asynchronously. OCPI 2.2.1 and 2.3.0 only.

Authentication

AuthorizationBearer

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

Path parameters

versionenumRequired

OCPI version: 221 (2.2.1) or 230 (2.3.0). OCPI 2.1.1 has no charging profiles or charging preferences.

Allowed values:
session_idstringRequired1-36 characters

Query parameters

partner_idintegerRequired>=1

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

durationintegerRequired>=1
Schedule length in seconds.

Response

Successful Response
partner_idinteger or nullOptional
operationstring or nullOptional
session_idstring or nullOptional
resultstring or nullOptional
response_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