Skip to navigation
OCPI roamingPartners

Register a roaming partner

Registers a roaming partner role (country_code, party_id, role, OCPI version) for this organization and links it to a roaming_partner_id. Run the credentials handshake next with ocpi_start_credentials_handshake.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
country_codestringRequired=2 characters
party_idstringRequired=3 characters
rolestringRequired1-50 characters
e.g. CPO, EMSP.
ocpi_versionenumRequired
Allowed values:
roaming_partner_idinteger or nullOptional>=1
partner_namestring or nullOptional1-255 characters
descriptionstring or nullOptional<=1000 characters
slugstring or nullOptional1-255 characters
partner_profile_ocpimap from strings to any or nullOptional
is_activebooleanOptionalDefaults to true

Response

Successful Response
idinteger
roaming_partner_idinteger
country_codestring
party_idstring
rolestring
is_activeboolean
ocpi_versionenum or nullOptional
Allowed values:
partner_namestring or nullOptional
descriptionstring or nullOptional
slugstring or nullOptional
created_atdatetime or nullOptional
updated_atdatetime or nullOptional
deleted_atdatetime or nullOptional
revisionintegerOptionalDefaults to 1
Bumped on every update.

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error