Skip to navigation
OCPI roamingSync

Pull a Hub’s ClientInfo list into our CPO side (2.2.1 / 2.3.0)

Fetches a Hub’s ClientInfo list (which parties are reachable through it) into our CPO side. OCPI 2.2.1 and 2.3.0 only. Results are stored in the OCPI store. Pulls are incremental from the last sync; set date_from (and full_replace=true) for a full resync. partner_id is the roaming partner id (roaming_partner_id), not the operation id from GET /ocpi/partners.

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:

Query parameters

partner_idintegerRequired>=1
Roaming partner to pull from.
date_fromdatetime or nullOptional
date_todatetime or nullOptional
offsetinteger or nullOptional>=0
limitinteger or nullOptional1-1000
full_replacebooleanOptionalDefaults to false

Response

Successful Response
partner_idinteger
fetchedinteger
upsertedinteger
completeboolean
duration_msinteger
last_errorstring or nullOptional
skipped_invalidinteger or nullOptional
sweep_invalidatedinteger or nullOptional
next_urlstring 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