v2.2.1¶

Version enspoints¶

GET versions¶

Get OCPI Versions.

Retrieves a list of available OCPI versions.

Returns:: The OCPIResponse containing a list of available OCPI versions.

GET 2.2.1/details¶

Get Version Details.

Retrieves details of the OCPI version 2.2.1.

Returns:: The OCPIResponse containing details of the OCPI version 2.2.1.

API’s for CPO role¶

Credentials module¶

GET cpo/2.2.1/credentials/¶

Get credentials.

Retrieves credentials based on the specified parameters.

Returns:: The OCPIResponse containing the credentials.

POST cpo/2.2.1/credentials/¶

Create credentials.

Creates credentials based on the specified parameters.

Request body:

credentials (Credentials): The credentials object.

Returns:

The OCPIResponse containing the new credentials.

Raises:

HTTPException: If the client is already registered

(HTTP 405 Method Not Allowed): or if the token is not valid (HTTP 401 Unauthorized).

PUT cpo/2.2.1/credentials/¶

Update credentials.

Updates credentials based on the specified parameters.

Request body:

credentials (Credentials): The credentials object.

Returns:

The OCPIResponse containing the updated credentials.

Raises:

HTTPException: If the client is not registered: (HTTP 405 Method Not Allowed).

DELETE cpo/2.2.1/credentials/¶

Remove credentials.

Deletes credentials based on the specified parameters.

Returns:

The OCPIResponse indicating the successful removal of credentials.

Raises:

HTTPException: If the client is not registered: (HTTP 405 Method Not Allowed).

Locations module¶

GET cpo/2.2.1/locations/¶

Get locations.

Retrieves a list of locations based on the specified filters.

Query parameters:

limit (int): Maximum number of objects to GET (default=50).
offset (int): The offset of the first object returned (default=0).
date_from (datetime): Only return Locations that have
last_updated after this Date/Time (default=None).
date_to (datetime): Only return Locations that have
last_updated before this Date/Time (default=None).

Returns:

The OCPIResponse containing the list of locations.

GET cpo/2.2.1/locations/{location_id}¶

Get location by ID.

Retrieves location details based on the specified ID.

Path parameters:

location_id (str): The ID of the location to retrieve (36 characters).

Returns:

The OCPIResponse containing the location details.

Raises:

NotFoundOCPIError: If the location with the specified ID is not found.

GET cpo/2.2.1/locations/{location_id}/{evse_uid}¶

Get EVSE by ID.

Retrieves Electric Vehicle Supply Equipment (EVSE) details

based on the specified Location ID and EVSE UID.

Path parameters:

location_id (str): The ID of the location containing
the EVSE (36 characters).
evse_uid (str): The UID of the EVSE to retrieve (48 characters).

Returns:

The OCPIResponse containing the EVSE details.

Raises:

NotFoundOCPIError: If the location with the specified ID: or EVSE with the specified UID is not found.

GET cpo/2.2.1/locations/{location_id}/{evse_uid}/{connector_id}¶

Get Connector by ID.

Retrieves Connector details based on the specified Location ID,

EVSE UID, and Connector ID.

Path parameters:

location_id (str): The ID of the location containing
the EVSE (36 characters).
evse_uid (str): The UID of the EVSE to retrieve (48 characters).
connector_id (str): The ID of the connector
to retrieve (36 characters).

Returns:

The OCPIResponse containing the Connector details.

Raises:

NotFoundOCPIError: If the location with the specified ID,: EVSE with the specified UID, or Connector with the specified ID is not found.

CDRs module¶

GET cpo/2.2.1/cdrs/¶

Get CDRs.

Retrieves a list of Charge Detail Records (CDRs) based

on the specified filters.

Query parameters:

limit (int): Maximum number of objects to GET (default=50).
offset (int): The offset of the first object returned (default=0).
date_from (datetime): Only return Locations that have last_updated
after this Date/Time (default=None).
date_to (datetime): Only return Locations that have last_updated
before this Date/Time (default=None).

Returns:

The OCPIResponse containing the list of CDRs.

Sessions module¶

GET cpo/2.2.1/sessions/¶

Get sessions.

Retrieves a list of sessions based on the specified filters.

Query parameters:

limit (int): Maximum number of objects to GET (default=50).
offset (int): The offset of the first object returned (default=0).
date_from (datetime): Only return Sessions that have last_updated
after this Date/Time (default=None).
date_to (datetime): Only return Sessions that have last_updated
before this Date/Time (default=None).

Returns:

The OCPIResponse containing the list of CDRs.

Tokens module¶

GET cpo/2.2.1/tokens/{country_code}/{party_id}/{token_uid}¶

Get Token.

Retrieves information about a token based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
token_uid (str): The ID of the token (36 characters).

Query parameters:

token_type (TokenType): The type of the token (default=TokenType.rfid).

Returns:

The OCPIResponse containing the token information.

Raises:

NotFoundOCPIError: If the token is not found.

PUT cpo/2.2.1/tokens/{country_code}/{party_id}/{token_uid}¶

Add or Update Token.

Adds or updates a token based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
token_uid (str): The ID of the token (36 characters).

Query parameters:

token_type (TokenType): The type of the token (default=TokenType.rfid).

Request body:

token (Token): The token object.

Returns:

The OCPIResponse containing the token data.

PATCH cpo/2.2.1/tokens/{country_code}/{party_id}/{token_uid}¶

Partial Update Token.

Partially updates a token based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
token_uid (str): The ID of the token (36 characters).

Query parameters:

token_type (TokenType): The type of the token (default=TokenType.rfid).

Request body:

token (TokenPartialUpdate): The partial token update object.

Returns:

The OCPIResponse containing the partially updated token data.

Raises:

NotFoundOCPIError: If the token is not found.

Tariffs module¶

GET cpo/2.2.1/tariffs/¶

Get Tariffs.

Retrieves a list of tariffs based on the specified filters.

Query parameters:

limit (int): Maximum number of objects to GET (default=50).
offset (int): The offset of the first object returned (default=0).
date_from (datetime): Only return tariffs that have last_updated
after this Date/Time (default=None).
date_to (datetime): Only return tariffs that have last_updated
before this Date/Time (default=None).

Returns:

The OCPIResponse containing the list of tariffs.

Commands module¶

POST cpo/2.2.1/commands/{command}¶

Receive Command.

Processes and handles incoming commands.

Path parameters:

command (CommandType): The type of the command.

Request body:

data (dict): The data associated with the command.

Returns:

The OCPIResponse indicating the success or failure of the command.

Raises:

HTTPException: If there is a validation error or if
the command action returns without a result.
NotFoundOCPIError: If the associated location is not found.

Charging profiles module¶

GET cpo/2.2.1/chargingprofiles/{session_id}¶

Get Charging Profile.

Retrieves the charging profile for a specific session.

Path parameters:

session_id (str): The ID of the charging session.

Query parameters:

duration (int): The requested duration for the charging profile.
response_url (URL): The URL to send the charging profile response.

Returns:

The OCPIResponse containing the charging profile response.

Raises:

NotFoundOCPIError: If the specified charging session is not found.

PUT cpo/2.2.1/chargingprofiles/{session_id}¶

Add or Update Charging Profile.

Adds or updates the charging profile for a specific session.

Path parameters:

session_id (str): The ID of the charging session.

Request body:

charging_profile (SetChargingProfile): The charging profile data.

Returns:

The OCPIResponse containing the charging profile response.

Raises:

NotFoundOCPIError: If the specified charging session is not found.

DELETE cpo/2.2.1/chargingprofiles/{session_id}¶

Delete Charging Profile.

Deletes the charging profile for a specific session.

Path parameters:

session_id (str): The ID of the charging session.

Query parameters:

response_url (URL): The URL to send the response to.

Returns:

The OCPIResponse containing the charging profile response.

Raises:

NotFoundOCPIError: If the specified charging session is not found.

Hub client info module¶

GET cpo/2.2.1/clientinfo/{country_code}/{party_id}¶

Get Hub Client Info.

Gets information about the hub client with the specified

country code and party ID.

Parameters:

country_code (str): The country code of the hub client.
party_id (str): The party ID of the hub client.

Returns:

The OCPIResponse containing information about the hub client.

Raises:

NotFoundOCPIError: If the hub client info is not found.

PUT cpo/2.2.1/clientinfo/{country_code}/{party_id}¶

Add or Update Hub Client Info.

Adds or updates information about the hub client with the specified

country code and party ID.

Parameters:

country_code (str): The country code of the hub client.
party_id (str): The party ID of the hub client.

Request body:

client_hub_info (ClientInfo): The data to update or create
for the hub client.

Returns:

The OCPIResponse containing the updated or created information: about the hub client.

API’s for eMSP role¶

Credentials module¶

GET emsp/2.2.1/credentials/¶

Get credentials.

Retrieves credentials based on the specified parameters.

Returns:: The OCPIResponse containing the credentials.

POST emsp/2.2.1/credentials/¶

Create credentials.

Creates credentials based on the specified parameters.

Request body:

credentials (Credentials): The credentials object.

Returns:

The OCPIResponse containing the new credentials.

Raises:

HTTPException: If the client is already registered

(HTTP 405 Method Not Allowed): or if the token is not valid (HTTP 401 Unauthorized).

PUT emsp/2.2.1/credentials/¶

Update credentials.

Updates credentials based on the specified parameters.

Request body:

credentials (Credentials): The credentials object.

Returns:

The OCPIResponse containing the updated credentials.

Raises:

HTTPException: If the client is not registered: (HTTP 405 Method Not Allowed).

DELETE emsp/2.2.1/credentials/¶

Remove credentials.

Deletes credentials based on the specified parameters.

Returns:

The OCPIResponse indicating the successful removal of credentials.

Raises:

HTTPException: If the client is not registered: (HTTP 405 Method Not Allowed).

Locations module¶

GET emsp/2.2.1/locations/{country_code}/{party_id}/{location_id}¶

Get Location.

Retrieves a location based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str: The three-letter party ID.
location_id (str): The ID of the location to retrieve (36 characters).

Returns:

The OCPIResponse containing the location data.

Raises:

NotFoundOCPIError: NotFoundOCPIError: If the location is not found.

GET emsp/2.2.1/locations/{country_code}/{party_id}/{location_id}/{evse_uid}¶

Get EVSE.

Retrieves an EVSE based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
location_id (str): The ID of the location containing
the EVSE (36 characters).
evse_uid (str): The UID of the EVSE to retrieve (48 characters).

Returns:

The OCPIResponse containing the EVSE data.

Raises:

NotFoundOCPIError: If the location with the specified ID: or EVSE with the specified UID is not found.

GET emsp/2.2.1/locations/{country_code}/{party_id}/{location_id}/{evse_uid}/{connector_id}¶

Get Connector.

Retrieves a connector based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
location_id (str): The ID of the location containing
the EVSE (36 characters).
evse_uid (str): The UID of the EVSE containing
the connector (48 characters).
connector_id (str): The ID of the connector
to retrieve (36 characters).

Returns:

The OCPIResponse containing the connector data.

Raises:

NotFoundOCPIError: If the location with the specified ID, EVSE with the: specified UID, or Connector with the specified ID is not found.

PUT emsp/2.2.1/locations/{country_code}/{party_id}/{location_id}¶

Add or Update Location.

Adds or updates a location based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
location_id (str): The ID of the location to add
or update (36 characters).

Request body:

location (Location): The location object.

Returns:

The OCPIResponse containing the added or updated location data.

Raises:

NotFoundOCPIError: If the location is not found.

PUT emsp/2.2.1/locations/{country_code}/{party_id}/{location_id}/{evse_uid}¶

Add or Update EVSE.

Adds or updates an EVSE based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
location_id (str): The ID of the location (36 characters).
evse_uid (str): The ID of the EVSE to add or update (48 characters).

Request body:

evse (EVSE): The EVSE object.

Returns:

The OCPIResponse containing the added or updated EVSE data.

Raises:

NotFoundOCPIError: If the location with the specified ID is not found.

PUT emsp/2.2.1/locations/{country_code}/{party_id}/{location_id}/{evse_uid}/{connector_id}¶

Add or Update Connector.

Adds or updates a connector based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
location_id (str): The ID of the location (36 characters).
evse_uid (str): The ID of the EVSE (48 characters).
connector_id (str): The ID of the connector to add
or update (36 characters).

Request body:

connector (Connector): The connector object.

Returns:

The OCPIResponse containing the added or updated connector data.

Raises:

NotFoundOCPIError: If the location with the specified ID: or EVSE with the specified UID is not found.

PATCH emsp/2.2.1/locations/{country_code}/{party_id}/{location_id}¶

Partial Update Location.

Partially updates a location based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
location_id (str): The ID of the location to partially
update (36 characters).

Request body:

location (LocationPartialUpdate): The partial location update object.

Returns:

The OCPIResponse containing the partially updated location data.

Raises:

NotFoundOCPIError: If the location is not found.

PATCH emsp/2.2.1/locations/{country_code}/{party_id}/{location_id}/{evse_uid}¶

Partial Update EVSE.

Partially updates an EVSE based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
location_id (str): The ID of the location to partially
update (36 characters).
evse_uid (str): The UID of the EVSE
to partially update (48 characters).

Request body:

evse (EVSEPartialUpdate): The partial EVSE update object.

Returns:

The OCPIResponse containing the partially updated EVSE data.

Raises:

NotFoundOCPIError: If the location with the specified ID: or EVSE with the specified UID is not found.

PATCH emsp/2.2.1/locations/{country_code}/{party_id}/{location_id}/{evse_uid}/{connector_id}¶

Partial Update Connector.

Partially updates a connector based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
location_id (str): The ID of the location
to partially update (36 characters).
evse_uid (str): The UID of the EVSE
to partially update (48 characters).
connector_id (str): The ID of the connector
to partially update (36 characters).

Request body:

connector (ConnectorPartialUpdate): The partial connector update object.

Returns:

The OCPIResponse containing the partially updated connector data.

Raises:

NotFoundOCPIError:If the location with the specified ID, EVSE with: the specified UID, or Connector with the specified ID is not found.

CDRs module¶

GET emsp/2.2.1/cdrs/{cdr_id}¶

Get CDR by ID.

Retrieves a Charge Detail Record (CDR) based on the specified ID.

Path parameters:

cdr_id (str): The ID of the CDR to retrieve (36 characters).

Returns:

The OCPIResponse containing the CDR data.

Raises:

NotFoundOCPIError: If the CDR is not found.

POST emsp/2.2.1/cdrs/¶

Add CDR.

Creates a new Charge Detail Record (CDR) based on the specified parameters.

Request body:: cdr (Cdr): The CDR object.
Returns:: The OCPIResponse containing the created CDR data.

Sessions module¶

GET emsp/2.2.1/sessions/{country_code}/{party_id}/{session_id}¶

Get Session.

Retrieves a session based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
session_id (str): The ID of the session (36 characters).

Returns:

The OCPIResponse containing the session data.

Raises:

NotFoundOCPIError: If the session is not found.

PUT emsp/2.2.1/sessions/{country_code}/{party_id}/{session_id}¶

Add or Update Session.

Adds or updates a session based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
session_id (str): The ID of the session (36 characters).

Request body:

session (Session): The session object.

Returns:

The OCPIResponse containing the added or updated session data.

PATCH emsp/2.2.1/sessions/{country_code}/{party_id}/{session_id}¶

Partial Update Session.

Partially updates a session based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
session_id (str): The ID of the session (36 characters).

Request body:

session (SessionPartialUpdate): The partial session update object.

Returns:

The OCPIResponse containing the partially updated session data.

Raises:

NotFoundOCPIError: If the session is not found.

Tokens module¶

GET emsp/2.2.1/tokens/¶

Get Tokens.

Retrieves a list of tokens based on the specified filters.

Query parameters:

limit (int): Maximum number of objects to GET (default=50).
offset (int): The offset of the first object returned (default=0).
date_from (datetime): Only return tokens that have last_updated
after this Date/Time (default=None).
date_to (datetime): Only return tokens that have last_updated
before this Date/Time (default=None).

Returns:

The OCPIResponse containing the list of tokens.

POST emsp/2.2.1/tokens/{token_uid}/authorize¶

Authorize Token.

Authorizes a token based on the specified parameters.

Path parameters:

token_uid (str): The ID of the token to authorize (36 characters).

Query parameters:

token_type (TokenType): The type of the token (default=TokenType.rfid).

Request body:

location_reference (LocationReference): The location reference
for authorization (default=None).

Returns:

The OCPIResponse containing the authorization result.

Raises:

NotFoundOCPIError: If the token is not found.

Tariffs module¶

GET emsp/2.2.1/tariffs/{country_code}/{party_id}/{tariff_id}¶

Get Tariff.

Retrieves a tariff based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
tariff_id (str): The ID of the tariff (36 characters).

Returns:

The OCPIResponse containing the tariff data.

Raises:

NotFoundOCPIError: If the tariff is not found.

PUT emsp/2.2.1/tariffs/{country_code}/{party_id}/{tariff_id}¶

Add or Update Tariff.

Adds or updates a tariff based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
tariff_id (str): The ID of the tariff (36 characters).

Request body:

tariff (Tariff): The tariff object.

Returns:

The OCPIResponse containing the tariff data.

DELETE emsp/2.2.1/tariffs/{country_code}/{party_id}/{tariff_id}¶

Delete Tariff.

Deletes a tariff based on the specified parameters.

Path parameters:

country_code (str): The two-letter country code.
party_id (str): The three-letter party ID.
tariff_id (str): The ID of the tariff to delete (36 characters).

Returns:

The OCPIResponse indicating the success of the operation.

Raises:

NotFoundOCPIError: If the tariff is not found.

Commands module¶

POST emsp/2.2.1/commands/{uid}¶

Receive Command Result.

Processes and handles incoming command results.

Path parameters:

uid (str): The unique identifier associated with the command.

Request body:

command_response (CommandResponse): The response data: associated with the command.

Returns:

The OCPIResponse indicating the success or failure of: processing the command result.

Charging profiles module¶

POST emsp/2.2.1/chargingprofiles/¶

Receive Charging Profile Command.

Receives and processes the charging profile command.

Parameters:

data (dict): The charging profile command data.

Returns:

The OCPIResponse indicating the success of the operation.

PUT emsp/2.2.1/chargingprofiles/{session_id}¶

Add or Update Charging Profile.

Adds or updates the active charging profile for a specific session.

Parameters:

session_id (str): The ID of the charging session.

Request body:

active_charging_profile (ActiveChargingProfile): The data
of the active charging profile.

Returns:

The OCPIResponse indicating the success of the operation.

Hub client info module¶

GET emsp/2.2.1/clientinfo/{country_code}/{party_id}¶

Get Hub Client Info.

Gets information about the hub client with the specified

country code and party ID.

Parameters:

country_code (str): The country code of the hub client.
party_id (str): The party ID of the hub client.

Returns:

The OCPIResponse containing information about the hub client.

Raises:

NotFoundOCPIError: If the hub client info is not found.

PUT emsp/2.2.1/clientinfo/{country_code}/{party_id}¶

Add or Update Hub Client Info.

Adds or updates information about the hub client

with the specified country code and party ID.

Parameters:

country_code (str): The country code of the hub client.
party_id (str): The party ID of the hub client.

Request body:

client_hub_info (ClientInfo): The data to update or
create for the hub client.

Returns:

The OCPIResponse containing the updated or created: information about the hub client.

Schemas¶

Credentials module¶

pydantic model py_ocpi.modules.credentials.v_2_2_1.schemas.Credentials¶

https://github.com/ocpi/ocpi/blob/2.2.1/credentials.asciidoc#131-credentials-object

Show JSON schema

{
   "title": "Credentials",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/credentials.asciidoc#131-credentials-object",
   "type": "object",
   "properties": {
      "token": {
         "title": "Token",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "url": {
         "title": "Url",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "roles": {
         "title": "Roles",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CredentialsRole"
         }
      }
   },
   "required": [
      "token",
      "url",
      "roles"
   ],
   "definitions": {
      "RoleEnum": {
         "title": "RoleEnum",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/types.asciidoc#151-role-enum",
         "enum": [
            "CPO",
            "EMSP",
            "HUB",
            "NAP",
            "NSP",
            "OTHER",
            "SCSP"
         ],
         "type": "string"
      },
      "ImageCategory": {
         "title": "ImageCategory",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#415-imagecategory-enum",
         "enum": [
            "CHARGER",
            "ENTRANCE",
            "LOCATION",
            "NETWORK",
            "OPERATOR",
            "OTHER",
            "OWNER"
         ],
         "type": "string"
      },
      "Image": {
         "title": "Image",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1415-image-class",
         "type": "object",
         "properties": {
            "url": {
               "title": "Url",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "thumbnail": {
               "title": "Thumbnail",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "category": {
               "$ref": "#/definitions/ImageCategory"
            },
            "type": {
               "title": "Type",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "width": {
               "title": "Width",
               "type": "integer"
            },
            "height": {
               "title": "Height",
               "type": "integer"
            }
         },
         "required": [
            "url",
            "category",
            "type"
         ]
      },
      "BusinessDetails": {
         "title": "BusinessDetails",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_businessdetails_class",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "website": {
               "title": "Website",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "logo": {
               "$ref": "#/definitions/Image"
            }
         },
         "required": [
            "name"
         ]
      },
      "CredentialsRole": {
         "title": "CredentialsRole",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/credentials.asciidoc#141-credentialsrole-class",
         "type": "object",
         "properties": {
            "role": {
               "$ref": "#/definitions/RoleEnum"
            },
            "business_details": {
               "$ref": "#/definitions/BusinessDetails"
            },
            "party_id": {
               "title": "Party Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "country_code": {
               "title": "Country Code",
               "examples": [
                  "string"
               ],
               "type": "string"
            }
         },
         "required": [
            "role",
            "business_details",
            "party_id",
            "country_code"
         ]
      }
   }
}

Fields:

roles (List[py_ocpi.modules.credentials.v_2_2_1.schemas.CredentialsRole])
token (py_ocpi.core.data_types.String)
url (py_ocpi.core.data_types.URL)

field roles: List[CredentialsRole] [Required]¶

field token: String [Required]¶

Constraints:

examples = [‘String’]

field url: URL [Required]¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

pydantic model py_ocpi.modules.credentials.v_2_2_1.schemas.CredentialsRole¶

https://github.com/ocpi/ocpi/blob/2.2.1/credentials.asciidoc#141-credentialsrole-class

Show JSON schema

{
   "title": "CredentialsRole",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/credentials.asciidoc#141-credentialsrole-class",
   "type": "object",
   "properties": {
      "role": {
         "$ref": "#/definitions/RoleEnum"
      },
      "business_details": {
         "$ref": "#/definitions/BusinessDetails"
      },
      "party_id": {
         "title": "Party Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "country_code": {
         "title": "Country Code",
         "examples": [
            "string"
         ],
         "type": "string"
      }
   },
   "required": [
      "role",
      "business_details",
      "party_id",
      "country_code"
   ],
   "definitions": {
      "RoleEnum": {
         "title": "RoleEnum",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/types.asciidoc#151-role-enum",
         "enum": [
            "CPO",
            "EMSP",
            "HUB",
            "NAP",
            "NSP",
            "OTHER",
            "SCSP"
         ],
         "type": "string"
      },
      "ImageCategory": {
         "title": "ImageCategory",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#415-imagecategory-enum",
         "enum": [
            "CHARGER",
            "ENTRANCE",
            "LOCATION",
            "NETWORK",
            "OPERATOR",
            "OTHER",
            "OWNER"
         ],
         "type": "string"
      },
      "Image": {
         "title": "Image",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1415-image-class",
         "type": "object",
         "properties": {
            "url": {
               "title": "Url",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "thumbnail": {
               "title": "Thumbnail",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "category": {
               "$ref": "#/definitions/ImageCategory"
            },
            "type": {
               "title": "Type",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "width": {
               "title": "Width",
               "type": "integer"
            },
            "height": {
               "title": "Height",
               "type": "integer"
            }
         },
         "required": [
            "url",
            "category",
            "type"
         ]
      },
      "BusinessDetails": {
         "title": "BusinessDetails",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_businessdetails_class",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "website": {
               "title": "Website",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "logo": {
               "$ref": "#/definitions/Image"
            }
         },
         "required": [
            "name"
         ]
      }
   }
}

Fields:

business_details (py_ocpi.modules.locations.v_2_2_1.schemas.BusinessDetails)
country_code (py_ocpi.core.data_types.CiString)
party_id (py_ocpi.core.data_types.CiString)
role (py_ocpi.core.enums.RoleEnum)

field business_details: BusinessDetails [Required]¶

field country_code: CiString [Required]¶

Constraints:

examples = [‘string’]

field party_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field role: RoleEnum [Required]¶

Locations module¶

pydantic model py_ocpi.modules.locations.v_2_2_1.schemas.BusinessDetails¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_businessdetails_class

Show JSON schema

{
   "title": "BusinessDetails",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_businessdetails_class",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "website": {
         "title": "Website",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "logo": {
         "$ref": "#/definitions/Image"
      }
   },
   "required": [
      "name"
   ],
   "definitions": {
      "ImageCategory": {
         "title": "ImageCategory",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#415-imagecategory-enum",
         "enum": [
            "CHARGER",
            "ENTRANCE",
            "LOCATION",
            "NETWORK",
            "OPERATOR",
            "OTHER",
            "OWNER"
         ],
         "type": "string"
      },
      "Image": {
         "title": "Image",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1415-image-class",
         "type": "object",
         "properties": {
            "url": {
               "title": "Url",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "thumbnail": {
               "title": "Thumbnail",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "category": {
               "$ref": "#/definitions/ImageCategory"
            },
            "type": {
               "title": "Type",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "width": {
               "title": "Width",
               "type": "integer"
            },
            "height": {
               "title": "Height",
               "type": "integer"
            }
         },
         "required": [
            "url",
            "category",
            "type"
         ]
      }
   }
}

Fields:

logo (Optional[py_ocpi.modules.locations.v_2_2_1.schemas.Image])
name (py_ocpi.core.data_types.String)
website (Optional[py_ocpi.core.data_types.URL])

field logo: Optional[Image] = None¶

field name: String [Required]¶

Constraints:

examples = [‘String’]

field website: Optional[URL] = None¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

pydantic model py_ocpi.modules.locations.v_2_2_1.schemas.Connector¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#133-connector-object

Show JSON schema

{
   "title": "Connector",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#133-connector-object",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "standard": {
         "$ref": "#/definitions/ConnectorType"
      },
      "format": {
         "$ref": "#/definitions/ConnectorFormat"
      },
      "power_type": {
         "$ref": "#/definitions/PowerType"
      },
      "max_voltage": {
         "title": "Max Voltage",
         "type": "integer"
      },
      "max_amperage": {
         "title": "Max Amperage",
         "type": "integer"
      },
      "max_electric_power": {
         "title": "Max Electric Power",
         "type": "integer"
      },
      "tariff_ids": {
         "title": "Tariff Ids",
         "default": [],
         "type": "array",
         "items": {
            "type": "string",
            "examples": [
               "string"
            ]
         }
      },
      "terms_and_conditions": {
         "title": "Terms And Conditions",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "last_updated": {
         "title": "Last Updated",
         "examples": [
            "2025-07-16T06:33:49Z"
         ],
         "type": "string"
      }
   },
   "required": [
      "id",
      "standard",
      "format",
      "power_type",
      "max_voltage",
      "max_amperage",
      "last_updated"
   ],
   "definitions": {
      "ConnectorType": {
         "title": "ConnectorType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#145-connectortype-enum",
         "enum": [
            "CHADEMO",
            "CHAOJI",
            "DOMESTIC_A",
            "DOMESTIC_B",
            "DOMESTIC_C",
            "DOMESTIC_D",
            "DOMESTIC_E",
            "DOMESTIC_F",
            "DOMESTIC_G",
            "DOMESTIC_H",
            "DOMESTIC_I",
            "DOMESTIC_J",
            "DOMESTIC_K",
            "DOMESTIC_L",
            "DOMESTIC_M",
            "DOMESTIC_N",
            "DOMESTIC_O",
            "GBT_AC",
            "GBT_DC",
            "IEC_60309_2_single_16",
            "IEC_60309_2_three_16",
            "IEC_60309_2_three_32",
            "IEC_60309_2_three_64",
            "IEC_62196_T1",
            "IEC_62196_T1_COMBO",
            "IEC_62196_T2",
            "IEC_62196_T2_COMBO",
            "IEC_62196_T3A",
            "IEC_62196_T3C",
            "NEMA_5_20",
            "NEMA_6_30",
            "NEMA_6_50",
            "NEMA_10_30",
            "NEMA_10_50",
            "NEMA_14_30",
            "NEMA_14_50",
            "PANTOGRAPH_BOTTOM_UP",
            "PANTOGRAPH_TOP_DOWN",
            "TESLA_R",
            "TESLA_S"
         ],
         "type": "string"
      },
      "ConnectorFormat": {
         "title": "ConnectorFormat",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#144-connectorformat-enum",
         "enum": [
            "SOCKET",
            "CABLE"
         ],
         "type": "string"
      },
      "PowerType": {
         "title": "PowerType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1419-powertype-enum",
         "enum": [
            "AC_1_PHASE",
            "AC_2_PHASE",
            "AC_2_PHASE_SPLIT",
            "AC_3_PHASE",
            "DC"
         ],
         "type": "string"
      }
   }
}

Fields:

format (py_ocpi.modules.locations.enums.ConnectorFormat)
id (py_ocpi.core.data_types.CiString)
last_updated (py_ocpi.core.data_types.DateTime)
max_amperage (int)
max_electric_power (Optional[int])
max_voltage (int)
power_type (py_ocpi.modules.locations.v_2_2_1.enums.PowerType)
standard (py_ocpi.modules.locations.v_2_2_1.enums.ConnectorType)
tariff_ids (List[py_ocpi.core.data_types.CiString])
terms_and_conditions (Optional[py_ocpi.core.data_types.URL])

field format: ConnectorFormat [Required]¶

field id: CiString [Required]¶

Constraints:

examples = [‘string’]

field last_updated: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:49Z’]

field max_amperage: int [Required]¶

field max_electric_power: Optional[int] = None¶

field max_voltage: int [Required]¶

field power_type: PowerType [Required]¶

field standard: ConnectorType [Required]¶

field tariff_ids: List[CiString] = []¶

field terms_and_conditions: Optional[URL] = None¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

pydantic model py_ocpi.modules.locations.v_2_2_1.schemas.EVSE¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_evse_object

Show JSON schema

{
   "title": "EVSE",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_evse_object",
   "type": "object",
   "properties": {
      "uid": {
         "title": "Uid",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "evse_id": {
         "title": "Evse Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "status": {
         "$ref": "#/definitions/Status"
      },
      "status_schedule": {
         "$ref": "#/definitions/StatusSchedule"
      },
      "capabilities": {
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/Capability"
         }
      },
      "connectors": {
         "title": "Connectors",
         "type": "array",
         "items": {
            "$ref": "#/definitions/Connector"
         }
      },
      "floor_level": {
         "title": "Floor Level",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "coordinates": {
         "$ref": "#/definitions/GeoLocation"
      },
      "physical_reference": {
         "title": "Physical Reference",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "directions": {
         "title": "Directions",
         "default": [],
         "type": "array",
         "items": {
            "type": "object",
            "examples": [
               {
                  "language": "en",
                  "text": "Standard Tariff"
               }
            ]
         }
      },
      "parking_restrictions": {
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/ParkingRestriction"
         }
      },
      "images": {
         "title": "Images",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/Image"
         }
      },
      "last_updated": {
         "title": "Last Updated",
         "examples": [
            "2025-07-16T06:33:49Z"
         ],
         "type": "string"
      }
   },
   "required": [
      "uid",
      "status",
      "connectors",
      "last_updated"
   ],
   "definitions": {
      "Status": {
         "title": "Status",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#420-status-enum",
         "enum": [
            "AVAILABLE",
            "BLOCKED",
            "CHARGING",
            "INOPERATIVE",
            "OUTOFORDER",
            "PLANNED",
            "REMOVED",
            "RESERVED",
            "UNKNOWN"
         ],
         "type": "string"
      },
      "StatusSchedule": {
         "title": "StatusSchedule",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1423-statusschedule-class",
         "type": "object",
         "properties": {
            "period_begin": {
               "title": "Period Begin",
               "examples": [
                  "2025-07-16T06:33:49Z"
               ],
               "type": "string"
            },
            "period_end": {
               "title": "Period End",
               "examples": [
                  "2025-07-16T06:33:49Z"
               ],
               "type": "string"
            },
            "status": {
               "$ref": "#/definitions/Status"
            }
         },
         "required": [
            "period_begin",
            "status"
         ]
      },
      "Capability": {
         "title": "Capability",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#143-capability-enum",
         "enum": [
            "CHARGING_PROFILE_CAPABLE",
            "CHARGING_PREFERENCES_CAPABLE",
            "CHIP_CARD_SUPPORT",
            "CONTACTLESS_CARD_SUPPORT",
            "CREDIT_CARD_PAYABLE",
            "DEBIT_CARD_PAYABLE",
            "PED_TERMINAL",
            "REMOTE_START_STOP_CAPABLE",
            "RESERVABLE",
            "RFID_READER",
            "START_SESSION_CONNECTOR_REQUIRED",
            "TOKEN_GROUP_CAPABLE",
            "UNLOCK_CAPABLE"
         ],
         "type": "string"
      },
      "ConnectorType": {
         "title": "ConnectorType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#145-connectortype-enum",
         "enum": [
            "CHADEMO",
            "CHAOJI",
            "DOMESTIC_A",
            "DOMESTIC_B",
            "DOMESTIC_C",
            "DOMESTIC_D",
            "DOMESTIC_E",
            "DOMESTIC_F",
            "DOMESTIC_G",
            "DOMESTIC_H",
            "DOMESTIC_I",
            "DOMESTIC_J",
            "DOMESTIC_K",
            "DOMESTIC_L",
            "DOMESTIC_M",
            "DOMESTIC_N",
            "DOMESTIC_O",
            "GBT_AC",
            "GBT_DC",
            "IEC_60309_2_single_16",
            "IEC_60309_2_three_16",
            "IEC_60309_2_three_32",
            "IEC_60309_2_three_64",
            "IEC_62196_T1",
            "IEC_62196_T1_COMBO",
            "IEC_62196_T2",
            "IEC_62196_T2_COMBO",
            "IEC_62196_T3A",
            "IEC_62196_T3C",
            "NEMA_5_20",
            "NEMA_6_30",
            "NEMA_6_50",
            "NEMA_10_30",
            "NEMA_10_50",
            "NEMA_14_30",
            "NEMA_14_50",
            "PANTOGRAPH_BOTTOM_UP",
            "PANTOGRAPH_TOP_DOWN",
            "TESLA_R",
            "TESLA_S"
         ],
         "type": "string"
      },
      "ConnectorFormat": {
         "title": "ConnectorFormat",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#144-connectorformat-enum",
         "enum": [
            "SOCKET",
            "CABLE"
         ],
         "type": "string"
      },
      "PowerType": {
         "title": "PowerType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1419-powertype-enum",
         "enum": [
            "AC_1_PHASE",
            "AC_2_PHASE",
            "AC_2_PHASE_SPLIT",
            "AC_3_PHASE",
            "DC"
         ],
         "type": "string"
      },
      "Connector": {
         "title": "Connector",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#133-connector-object",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "standard": {
               "$ref": "#/definitions/ConnectorType"
            },
            "format": {
               "$ref": "#/definitions/ConnectorFormat"
            },
            "power_type": {
               "$ref": "#/definitions/PowerType"
            },
            "max_voltage": {
               "title": "Max Voltage",
               "type": "integer"
            },
            "max_amperage": {
               "title": "Max Amperage",
               "type": "integer"
            },
            "max_electric_power": {
               "title": "Max Electric Power",
               "type": "integer"
            },
            "tariff_ids": {
               "title": "Tariff Ids",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string",
                  "examples": [
                     "string"
                  ]
               }
            },
            "terms_and_conditions": {
               "title": "Terms And Conditions",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "last_updated": {
               "title": "Last Updated",
               "examples": [
                  "2025-07-16T06:33:49Z"
               ],
               "type": "string"
            }
         },
         "required": [
            "id",
            "standard",
            "format",
            "power_type",
            "max_voltage",
            "max_amperage",
            "last_updated"
         ]
      },
      "GeoLocation": {
         "title": "GeoLocation",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_geolocation_class",
         "type": "object",
         "properties": {
            "latitude": {
               "title": "Latitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "longitude": {
               "title": "Longitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "latitude",
            "longitude"
         ]
      },
      "ParkingRestriction": {
         "title": "ParkingRestriction",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#417-parkingrestriction-enum",
         "enum": [
            "EV_ONLY",
            "PLUGGED",
            "DISABLED",
            "CUSTOMERS",
            "MOTORCYCLES"
         ],
         "type": "string"
      },
      "ImageCategory": {
         "title": "ImageCategory",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#415-imagecategory-enum",
         "enum": [
            "CHARGER",
            "ENTRANCE",
            "LOCATION",
            "NETWORK",
            "OPERATOR",
            "OTHER",
            "OWNER"
         ],
         "type": "string"
      },
      "Image": {
         "title": "Image",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1415-image-class",
         "type": "object",
         "properties": {
            "url": {
               "title": "Url",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "thumbnail": {
               "title": "Thumbnail",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "category": {
               "$ref": "#/definitions/ImageCategory"
            },
            "type": {
               "title": "Type",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "width": {
               "title": "Width",
               "type": "integer"
            },
            "height": {
               "title": "Height",
               "type": "integer"
            }
         },
         "required": [
            "url",
            "category",
            "type"
         ]
      }
   }
}

Fields:

capabilities (List[py_ocpi.modules.locations.v_2_2_1.enums.Capability])
connectors (List[py_ocpi.modules.locations.v_2_2_1.schemas.Connector])
coordinates (Optional[py_ocpi.modules.locations.schemas.GeoLocation])
directions (List[py_ocpi.core.data_types.DisplayText])
evse_id (Optional[py_ocpi.core.data_types.CiString])
floor_level (Optional[py_ocpi.core.data_types.String])
images (List[py_ocpi.modules.locations.v_2_2_1.schemas.Image])
last_updated (py_ocpi.core.data_types.DateTime)
parking_restrictions (List[py_ocpi.modules.locations.enums.ParkingRestriction])
physical_reference (Optional[py_ocpi.core.data_types.String])
status (py_ocpi.modules.locations.enums.Status)
status_schedule (Optional[py_ocpi.modules.locations.schemas.StatusSchedule])
uid (py_ocpi.core.data_types.CiString)

field capabilities: List[Capability] = []¶

field connectors: List[Connector] [Required]¶

field coordinates: Optional[GeoLocation] = None¶

field directions: List[DisplayText] = []¶

field evse_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field floor_level: Optional[String] = None¶

Constraints:

examples = [‘String’]

field images: List[Image] = []¶

field last_updated: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:49Z’]

field parking_restrictions: List[ParkingRestriction] = []¶

field physical_reference: Optional[String] = None¶

Constraints:

examples = [‘String’]

field status: Status [Required]¶

field status_schedule: Optional[StatusSchedule] = None¶

field uid: CiString [Required]¶

Constraints:

examples = [‘string’]

pydantic model py_ocpi.modules.locations.v_2_2_1.schemas.Image¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1415-image-class

Show JSON schema

{
   "title": "Image",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1415-image-class",
   "type": "object",
   "properties": {
      "url": {
         "title": "Url",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "thumbnail": {
         "title": "Thumbnail",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "category": {
         "$ref": "#/definitions/ImageCategory"
      },
      "type": {
         "title": "Type",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "width": {
         "title": "Width",
         "type": "integer"
      },
      "height": {
         "title": "Height",
         "type": "integer"
      }
   },
   "required": [
      "url",
      "category",
      "type"
   ],
   "definitions": {
      "ImageCategory": {
         "title": "ImageCategory",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#415-imagecategory-enum",
         "enum": [
            "CHARGER",
            "ENTRANCE",
            "LOCATION",
            "NETWORK",
            "OPERATOR",
            "OTHER",
            "OWNER"
         ],
         "type": "string"
      }
   }
}

Fields:

category (py_ocpi.modules.locations.enums.ImageCategory)
height (Optional[int])
thumbnail (Optional[py_ocpi.core.data_types.URL])
type (py_ocpi.core.data_types.CiString)
url (py_ocpi.core.data_types.URL)
width (Optional[int])

field category: ImageCategory [Required]¶

field height: Optional[int] = None¶

field thumbnail: Optional[URL] = None¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

field type: CiString [Required]¶

Constraints:

examples = [‘string’]

field url: URL [Required]¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

field width: Optional[int] = None¶

pydantic model py_ocpi.modules.locations.v_2_2_1.schemas.Location¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#131-location-object

Show JSON schema

{
   "title": "Location",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#131-location-object",
   "type": "object",
   "properties": {
      "country_code": {
         "title": "Country Code",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "party_id": {
         "title": "Party Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "id": {
         "title": "Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "publish": {
         "title": "Publish",
         "type": "boolean"
      },
      "publish_allowed_to": {
         "title": "Publish Allowed To",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/PublishTokenType"
         }
      },
      "name": {
         "title": "Name",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "address": {
         "title": "Address",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "city": {
         "title": "City",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "postal_code": {
         "title": "Postal Code",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "state": {
         "title": "State",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "country": {
         "title": "Country",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "coordinates": {
         "$ref": "#/definitions/GeoLocation"
      },
      "related_locations": {
         "title": "Related Locations",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/AdditionalGeoLocation"
         }
      },
      "parking_type": {
         "$ref": "#/definitions/ParkingType"
      },
      "evses": {
         "title": "Evses",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/EVSE"
         }
      },
      "directions": {
         "title": "Directions",
         "default": [],
         "type": "array",
         "items": {
            "type": "object",
            "examples": [
               {
                  "language": "en",
                  "text": "Standard Tariff"
               }
            ]
         }
      },
      "operator": {
         "$ref": "#/definitions/BusinessDetails"
      },
      "suboperator": {
         "$ref": "#/definitions/BusinessDetails"
      },
      "owner": {
         "$ref": "#/definitions/BusinessDetails"
      },
      "facilities": {
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/Facility"
         }
      },
      "time_zone": {
         "title": "Time Zone",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "opening_times": {
         "$ref": "#/definitions/Hours"
      },
      "charging_when_closed": {
         "title": "Charging When Closed",
         "type": "boolean"
      },
      "images": {
         "title": "Images",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/Image"
         }
      },
      "energy_mix": {
         "$ref": "#/definitions/EnergyMix"
      },
      "last_updated": {
         "title": "Last Updated",
         "examples": [
            "2025-07-16T06:33:49Z"
         ],
         "type": "string"
      }
   },
   "required": [
      "country_code",
      "party_id",
      "id",
      "publish",
      "address",
      "city",
      "country",
      "coordinates",
      "time_zone",
      "last_updated"
   ],
   "definitions": {
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      },
      "PublishTokenType": {
         "title": "PublishTokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_publish_token_class",
         "type": "object",
         "properties": {
            "uid": {
               "title": "Uid",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/TokenType"
            },
            "visual_number": {
               "title": "Visual Number",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "issuer": {
               "title": "Issuer",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "group_id": {
               "title": "Group Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            }
         }
      },
      "GeoLocation": {
         "title": "GeoLocation",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_geolocation_class",
         "type": "object",
         "properties": {
            "latitude": {
               "title": "Latitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "longitude": {
               "title": "Longitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "latitude",
            "longitude"
         ]
      },
      "AdditionalGeoLocation": {
         "title": "AdditionalGeoLocation",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_additionalgeolocation_class",
         "type": "object",
         "properties": {
            "latitude": {
               "title": "Latitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "longitude": {
               "title": "Longitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "name": {
               "title": "Name",
               "examples": [
                  {
                     "language": "en",
                     "text": "Standard Tariff"
                  }
               ],
               "type": "object"
            }
         },
         "required": [
            "latitude",
            "longitude"
         ]
      },
      "ParkingType": {
         "title": "ParkingType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1418-parkingtype-enum",
         "enum": [
            "ALONG_MOTORWAY",
            "PARKING_GARAGE",
            "PARKING_LOT",
            "ON_DRIVEWAY",
            "ON_STREET",
            "UNDERGROUND_GARAGE"
         ],
         "type": "string"
      },
      "Status": {
         "title": "Status",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#420-status-enum",
         "enum": [
            "AVAILABLE",
            "BLOCKED",
            "CHARGING",
            "INOPERATIVE",
            "OUTOFORDER",
            "PLANNED",
            "REMOVED",
            "RESERVED",
            "UNKNOWN"
         ],
         "type": "string"
      },
      "StatusSchedule": {
         "title": "StatusSchedule",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1423-statusschedule-class",
         "type": "object",
         "properties": {
            "period_begin": {
               "title": "Period Begin",
               "examples": [
                  "2025-07-16T06:33:49Z"
               ],
               "type": "string"
            },
            "period_end": {
               "title": "Period End",
               "examples": [
                  "2025-07-16T06:33:49Z"
               ],
               "type": "string"
            },
            "status": {
               "$ref": "#/definitions/Status"
            }
         },
         "required": [
            "period_begin",
            "status"
         ]
      },
      "Capability": {
         "title": "Capability",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#143-capability-enum",
         "enum": [
            "CHARGING_PROFILE_CAPABLE",
            "CHARGING_PREFERENCES_CAPABLE",
            "CHIP_CARD_SUPPORT",
            "CONTACTLESS_CARD_SUPPORT",
            "CREDIT_CARD_PAYABLE",
            "DEBIT_CARD_PAYABLE",
            "PED_TERMINAL",
            "REMOTE_START_STOP_CAPABLE",
            "RESERVABLE",
            "RFID_READER",
            "START_SESSION_CONNECTOR_REQUIRED",
            "TOKEN_GROUP_CAPABLE",
            "UNLOCK_CAPABLE"
         ],
         "type": "string"
      },
      "ConnectorType": {
         "title": "ConnectorType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#145-connectortype-enum",
         "enum": [
            "CHADEMO",
            "CHAOJI",
            "DOMESTIC_A",
            "DOMESTIC_B",
            "DOMESTIC_C",
            "DOMESTIC_D",
            "DOMESTIC_E",
            "DOMESTIC_F",
            "DOMESTIC_G",
            "DOMESTIC_H",
            "DOMESTIC_I",
            "DOMESTIC_J",
            "DOMESTIC_K",
            "DOMESTIC_L",
            "DOMESTIC_M",
            "DOMESTIC_N",
            "DOMESTIC_O",
            "GBT_AC",
            "GBT_DC",
            "IEC_60309_2_single_16",
            "IEC_60309_2_three_16",
            "IEC_60309_2_three_32",
            "IEC_60309_2_three_64",
            "IEC_62196_T1",
            "IEC_62196_T1_COMBO",
            "IEC_62196_T2",
            "IEC_62196_T2_COMBO",
            "IEC_62196_T3A",
            "IEC_62196_T3C",
            "NEMA_5_20",
            "NEMA_6_30",
            "NEMA_6_50",
            "NEMA_10_30",
            "NEMA_10_50",
            "NEMA_14_30",
            "NEMA_14_50",
            "PANTOGRAPH_BOTTOM_UP",
            "PANTOGRAPH_TOP_DOWN",
            "TESLA_R",
            "TESLA_S"
         ],
         "type": "string"
      },
      "ConnectorFormat": {
         "title": "ConnectorFormat",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#144-connectorformat-enum",
         "enum": [
            "SOCKET",
            "CABLE"
         ],
         "type": "string"
      },
      "PowerType": {
         "title": "PowerType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1419-powertype-enum",
         "enum": [
            "AC_1_PHASE",
            "AC_2_PHASE",
            "AC_2_PHASE_SPLIT",
            "AC_3_PHASE",
            "DC"
         ],
         "type": "string"
      },
      "Connector": {
         "title": "Connector",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#133-connector-object",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "standard": {
               "$ref": "#/definitions/ConnectorType"
            },
            "format": {
               "$ref": "#/definitions/ConnectorFormat"
            },
            "power_type": {
               "$ref": "#/definitions/PowerType"
            },
            "max_voltage": {
               "title": "Max Voltage",
               "type": "integer"
            },
            "max_amperage": {
               "title": "Max Amperage",
               "type": "integer"
            },
            "max_electric_power": {
               "title": "Max Electric Power",
               "type": "integer"
            },
            "tariff_ids": {
               "title": "Tariff Ids",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string",
                  "examples": [
                     "string"
                  ]
               }
            },
            "terms_and_conditions": {
               "title": "Terms And Conditions",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "last_updated": {
               "title": "Last Updated",
               "examples": [
                  "2025-07-16T06:33:49Z"
               ],
               "type": "string"
            }
         },
         "required": [
            "id",
            "standard",
            "format",
            "power_type",
            "max_voltage",
            "max_amperage",
            "last_updated"
         ]
      },
      "ParkingRestriction": {
         "title": "ParkingRestriction",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#417-parkingrestriction-enum",
         "enum": [
            "EV_ONLY",
            "PLUGGED",
            "DISABLED",
            "CUSTOMERS",
            "MOTORCYCLES"
         ],
         "type": "string"
      },
      "ImageCategory": {
         "title": "ImageCategory",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#415-imagecategory-enum",
         "enum": [
            "CHARGER",
            "ENTRANCE",
            "LOCATION",
            "NETWORK",
            "OPERATOR",
            "OTHER",
            "OWNER"
         ],
         "type": "string"
      },
      "Image": {
         "title": "Image",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1415-image-class",
         "type": "object",
         "properties": {
            "url": {
               "title": "Url",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "thumbnail": {
               "title": "Thumbnail",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "category": {
               "$ref": "#/definitions/ImageCategory"
            },
            "type": {
               "title": "Type",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "width": {
               "title": "Width",
               "type": "integer"
            },
            "height": {
               "title": "Height",
               "type": "integer"
            }
         },
         "required": [
            "url",
            "category",
            "type"
         ]
      },
      "EVSE": {
         "title": "EVSE",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_evse_object",
         "type": "object",
         "properties": {
            "uid": {
               "title": "Uid",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "evse_id": {
               "title": "Evse Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "status": {
               "$ref": "#/definitions/Status"
            },
            "status_schedule": {
               "$ref": "#/definitions/StatusSchedule"
            },
            "capabilities": {
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Capability"
               }
            },
            "connectors": {
               "title": "Connectors",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Connector"
               }
            },
            "floor_level": {
               "title": "Floor Level",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "coordinates": {
               "$ref": "#/definitions/GeoLocation"
            },
            "physical_reference": {
               "title": "Physical Reference",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "directions": {
               "title": "Directions",
               "default": [],
               "type": "array",
               "items": {
                  "type": "object",
                  "examples": [
                     {
                        "language": "en",
                        "text": "Standard Tariff"
                     }
                  ]
               }
            },
            "parking_restrictions": {
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ParkingRestriction"
               }
            },
            "images": {
               "title": "Images",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/Image"
               }
            },
            "last_updated": {
               "title": "Last Updated",
               "examples": [
                  "2025-07-16T06:33:49Z"
               ],
               "type": "string"
            }
         },
         "required": [
            "uid",
            "status",
            "connectors",
            "last_updated"
         ]
      },
      "BusinessDetails": {
         "title": "BusinessDetails",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_businessdetails_class",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "website": {
               "title": "Website",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "logo": {
               "$ref": "#/definitions/Image"
            }
         },
         "required": [
            "name"
         ]
      },
      "Facility": {
         "title": "Facility",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1412-facility-enum",
         "enum": [
            "HOTEL",
            "RESTAURANT",
            "CAFE",
            "MALL",
            "SUPERMARKET",
            "SPORT",
            "RECREATION_AREA",
            "NATURE",
            "MUSEUM",
            "BIKE_SHARING",
            "BUS_STOP",
            "TAXI_STAND",
            "TRAM_STOP",
            "METRO_STATION",
            "TRAIN_STATION",
            "AIRPORT",
            "PARKING_LOT",
            "CARPOOL_PARKING",
            "FUEL_STATION",
            "WIFI"
         ],
         "type": "string"
      },
      "RegularHours": {
         "title": "RegularHours",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1421-regularhours-class",
         "type": "object",
         "properties": {
            "weekday": {
               "title": "Weekday",
               "type": "integer"
            },
            "period_begin": {
               "title": "Period Begin",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "period_end": {
               "title": "Period End",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "weekday",
            "period_begin",
            "period_end"
         ]
      },
      "ExceptionalPeriod": {
         "title": "ExceptionalPeriod",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1411-exceptionalperiod-class",
         "type": "object",
         "properties": {
            "period_begin": {
               "title": "Period Begin",
               "examples": [
                  "2025-07-16T06:33:49Z"
               ],
               "type": "string"
            },
            "period_end": {
               "title": "Period End",
               "examples": [
                  "2025-07-16T06:33:49Z"
               ],
               "type": "string"
            }
         },
         "required": [
            "period_begin",
            "period_end"
         ]
      },
      "Hours": {
         "title": "Hours",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_hours_class",
         "type": "object",
         "properties": {
            "twentyfourseven": {
               "title": "Twentyfourseven",
               "type": "boolean"
            },
            "regular_hours": {
               "title": "Regular Hours",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/RegularHours"
               }
            },
            "exceptional_openings": {
               "title": "Exceptional Openings",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ExceptionalPeriod"
               }
            },
            "exceptional_closings": {
               "title": "Exceptional Closings",
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/ExceptionalPeriod"
               }
            }
         },
         "required": [
            "twentyfourseven"
         ]
      },
      "EnergySourceCategory": {
         "title": "EnergySourceCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#148-energysourcecategory-enum",
         "enum": [
            "NUCLEAR",
            "GENERAL_FOSSIL",
            "COAL",
            "GAS",
            "GENERAL_GREEN",
            "SOLAR",
            "WIND",
            "WATER"
         ],
         "type": "string"
      },
      "EnergySource": {
         "title": "EnergySource",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#147-energysource-class",
         "type": "object",
         "properties": {
            "source": {
               "$ref": "#/definitions/EnergySourceCategory"
            },
            "percentage": {
               "title": "Percentage",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "source",
            "percentage"
         ]
      },
      "EnvironmentalImpactCategory": {
         "title": "EnvironmentalImpactCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1410-environmentalimpactcategory-enum",
         "enum": [
            "NUCLEAR_WASTE",
            "CARBON_DIOXIDE"
         ],
         "type": "string"
      },
      "EnvironmentalImpact": {
         "title": "EnvironmentalImpact",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#149-environmentalimpact-class",
         "type": "object",
         "properties": {
            "category": {
               "$ref": "#/definitions/EnvironmentalImpactCategory"
            },
            "amount": {
               "title": "Amount",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "category",
            "amount"
         ]
      },
      "EnergyMix": {
         "title": "EnergyMix",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_energymix_class",
         "type": "object",
         "properties": {
            "is_green_energy": {
               "title": "Is Green Energy",
               "type": "boolean"
            },
            "energy_sources": {
               "title": "Energy Sources",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/EnergySource"
               }
            },
            "environ_impact": {
               "$ref": "#/definitions/EnvironmentalImpact"
            },
            "supplier_name": {
               "title": "Supplier Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "energy_product_name": {
               "title": "Energy Product Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "is_green_energy",
            "energy_sources",
            "supplier_name",
            "energy_product_name"
         ]
      }
   }
}

Fields:

address (py_ocpi.core.data_types.String)
charging_when_closed (Optional[bool])
city (py_ocpi.core.data_types.String)
coordinates (py_ocpi.modules.locations.schemas.GeoLocation)
country (py_ocpi.core.data_types.String)
country_code (py_ocpi.core.data_types.CiString)
directions (List[py_ocpi.core.data_types.DisplayText])
energy_mix (Optional[py_ocpi.modules.locations.schemas.EnergyMix])
evses (List[py_ocpi.modules.locations.v_2_2_1.schemas.EVSE])
facilities (List[py_ocpi.modules.locations.v_2_2_1.enums.Facility])
id (py_ocpi.core.data_types.CiString)
images (List[py_ocpi.modules.locations.v_2_2_1.schemas.Image])
last_updated (py_ocpi.core.data_types.DateTime)
name (Optional[py_ocpi.core.data_types.String])
opening_times (Optional[py_ocpi.modules.locations.schemas.Hours])
operator (Optional[py_ocpi.modules.locations.v_2_2_1.schemas.BusinessDetails])
owner (Optional[py_ocpi.modules.locations.v_2_2_1.schemas.BusinessDetails])
parking_type (Optional[py_ocpi.modules.locations.v_2_2_1.enums.ParkingType])
party_id (py_ocpi.core.data_types.CiString)
postal_code (Optional[py_ocpi.core.data_types.String])
publish (bool)
publish_allowed_to (List[py_ocpi.modules.locations.v_2_2_1.schemas.PublishTokenType])
related_locations (List[py_ocpi.modules.locations.schemas.AdditionalGeoLocation])
state (Optional[py_ocpi.core.data_types.String])
suboperator (Optional[py_ocpi.modules.locations.v_2_2_1.schemas.BusinessDetails])
time_zone (py_ocpi.core.data_types.String)

field address: String [Required]¶

Constraints:

examples = [‘String’]

field charging_when_closed: Optional[bool] = None¶

field city: String [Required]¶

Constraints:

examples = [‘String’]

field coordinates: GeoLocation [Required]¶

field country: String [Required]¶

Constraints:

examples = [‘String’]

field country_code: CiString [Required]¶

Constraints:

examples = [‘string’]

field directions: List[DisplayText] = []¶

field energy_mix: Optional[EnergyMix] = None¶

field evses: List[EVSE] = []¶

field facilities: List[Facility] = []¶

field id: CiString [Required]¶

Constraints:

examples = [‘string’]

field images: List[Image] = []¶

field last_updated: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:49Z’]

field name: Optional[String] = None¶

Constraints:

examples = [‘String’]

field opening_times: Optional[Hours] = None¶

field operator: Optional[BusinessDetails] = None¶

field owner: Optional[BusinessDetails] = None¶

field parking_type: Optional[ParkingType] = None¶

field party_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field postal_code: Optional[String] = None¶

Constraints:

examples = [‘String’]

field publish: bool [Required]¶

field publish_allowed_to: List[PublishTokenType] = []¶

field related_locations: List[AdditionalGeoLocation] = []¶

field state: Optional[String] = None¶

Constraints:

examples = [‘String’]

field suboperator: Optional[BusinessDetails] = None¶

field time_zone: String [Required]¶

Constraints:

examples = [‘String’]

pydantic model py_ocpi.modules.locations.v_2_2_1.schemas.PublishTokenType¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_publish_token_class

Show JSON schema

{
   "title": "PublishTokenType",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_publish_token_class",
   "type": "object",
   "properties": {
      "uid": {
         "title": "Uid",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "type": {
         "$ref": "#/definitions/TokenType"
      },
      "visual_number": {
         "title": "Visual Number",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "issuer": {
         "title": "Issuer",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "group_id": {
         "title": "Group Id",
         "examples": [
            "string"
         ],
         "type": "string"
      }
   },
   "definitions": {
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      }
   }
}

Fields:

group_id (Optional[py_ocpi.core.data_types.CiString])
issuer (Optional[py_ocpi.core.data_types.String])
type (Optional[py_ocpi.modules.tokens.v_2_2_1.enums.TokenType])
uid (Optional[py_ocpi.core.data_types.CiString])
visual_number (Optional[py_ocpi.core.data_types.String])

field group_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field issuer: Optional[String] = None¶

Constraints:

examples = [‘String’]

field type: Optional[TokenType] = None¶

field uid: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field visual_number: Optional[String] = None¶

Constraints:

examples = [‘String’]

pydantic model py_ocpi.modules.locations.schemas.AdditionalGeoLocation¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_additionalgeolocation_class

Show JSON schema

{
   "title": "AdditionalGeoLocation",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_additionalgeolocation_class",
   "type": "object",
   "properties": {
      "latitude": {
         "title": "Latitude",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "longitude": {
         "title": "Longitude",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "name": {
         "title": "Name",
         "examples": [
            {
               "language": "en",
               "text": "Standard Tariff"
            }
         ],
         "type": "object"
      }
   },
   "required": [
      "latitude",
      "longitude"
   ]
}

Fields:

latitude (py_ocpi.core.data_types.String)
longitude (py_ocpi.core.data_types.String)
name (Optional[py_ocpi.core.data_types.DisplayText])

field latitude: String [Required]¶

Constraints:

examples = [‘String’]

field longitude: String [Required]¶

Constraints:

examples = [‘String’]

field name: Optional[DisplayText] = None¶

Constraints:

examples = [{‘language’: ‘en’, ‘text’: ‘Standard Tariff’}]

pydantic model py_ocpi.modules.locations.schemas.EnergyMix¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_energymix_class

Show JSON schema

{
   "title": "EnergyMix",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_energymix_class",
   "type": "object",
   "properties": {
      "is_green_energy": {
         "title": "Is Green Energy",
         "type": "boolean"
      },
      "energy_sources": {
         "title": "Energy Sources",
         "type": "array",
         "items": {
            "$ref": "#/definitions/EnergySource"
         }
      },
      "environ_impact": {
         "$ref": "#/definitions/EnvironmentalImpact"
      },
      "supplier_name": {
         "title": "Supplier Name",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "energy_product_name": {
         "title": "Energy Product Name",
         "examples": [
            "String"
         ],
         "type": "string"
      }
   },
   "required": [
      "is_green_energy",
      "energy_sources",
      "supplier_name",
      "energy_product_name"
   ],
   "definitions": {
      "EnergySourceCategory": {
         "title": "EnergySourceCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#148-energysourcecategory-enum",
         "enum": [
            "NUCLEAR",
            "GENERAL_FOSSIL",
            "COAL",
            "GAS",
            "GENERAL_GREEN",
            "SOLAR",
            "WIND",
            "WATER"
         ],
         "type": "string"
      },
      "EnergySource": {
         "title": "EnergySource",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#147-energysource-class",
         "type": "object",
         "properties": {
            "source": {
               "$ref": "#/definitions/EnergySourceCategory"
            },
            "percentage": {
               "title": "Percentage",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "source",
            "percentage"
         ]
      },
      "EnvironmentalImpactCategory": {
         "title": "EnvironmentalImpactCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1410-environmentalimpactcategory-enum",
         "enum": [
            "NUCLEAR_WASTE",
            "CARBON_DIOXIDE"
         ],
         "type": "string"
      },
      "EnvironmentalImpact": {
         "title": "EnvironmentalImpact",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#149-environmentalimpact-class",
         "type": "object",
         "properties": {
            "category": {
               "$ref": "#/definitions/EnvironmentalImpactCategory"
            },
            "amount": {
               "title": "Amount",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "category",
            "amount"
         ]
      }
   }
}

Fields:

energy_product_name (py_ocpi.core.data_types.String)
energy_sources (List[py_ocpi.modules.locations.schemas.EnergySource])
environ_impact (Optional[py_ocpi.modules.locations.schemas.EnvironmentalImpact])
is_green_energy (bool)
supplier_name (py_ocpi.core.data_types.String)

field energy_product_name: String [Required]¶

Constraints:

examples = [‘String’]

field energy_sources: List[EnergySource] [Required]¶

field environ_impact: Optional[EnvironmentalImpact] = None¶

field is_green_energy: bool [Required]¶

field supplier_name: String [Required]¶

Constraints:

examples = [‘String’]

pydantic model py_ocpi.modules.locations.schemas.EnergySource¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#147-energysource-class

Show JSON schema

{
   "title": "EnergySource",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#147-energysource-class",
   "type": "object",
   "properties": {
      "source": {
         "$ref": "#/definitions/EnergySourceCategory"
      },
      "percentage": {
         "title": "Percentage",
         "examples": [],
         "type": "number"
      }
   },
   "required": [
      "source",
      "percentage"
   ],
   "definitions": {
      "EnergySourceCategory": {
         "title": "EnergySourceCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#148-energysourcecategory-enum",
         "enum": [
            "NUCLEAR",
            "GENERAL_FOSSIL",
            "COAL",
            "GAS",
            "GENERAL_GREEN",
            "SOLAR",
            "WIND",
            "WATER"
         ],
         "type": "string"
      }
   }
}

Fields:

percentage (py_ocpi.core.data_types.Number)
source (py_ocpi.modules.locations.enums.EnergySourceCategory)

field percentage: Number [Required]¶

Constraints:

examples = []

field source: EnergySourceCategory [Required]¶

pydantic model py_ocpi.modules.locations.schemas.EnvironmentalImpact¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#149-environmentalimpact-class

Show JSON schema

{
   "title": "EnvironmentalImpact",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#149-environmentalimpact-class",
   "type": "object",
   "properties": {
      "category": {
         "$ref": "#/definitions/EnvironmentalImpactCategory"
      },
      "amount": {
         "title": "Amount",
         "examples": [],
         "type": "number"
      }
   },
   "required": [
      "category",
      "amount"
   ],
   "definitions": {
      "EnvironmentalImpactCategory": {
         "title": "EnvironmentalImpactCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1410-environmentalimpactcategory-enum",
         "enum": [
            "NUCLEAR_WASTE",
            "CARBON_DIOXIDE"
         ],
         "type": "string"
      }
   }
}

Fields:

amount (py_ocpi.core.data_types.Number)
category (py_ocpi.modules.locations.enums.EnvironmentalImpactCategory)

field amount: Number [Required]¶

Constraints:

examples = []

field category: EnvironmentalImpactCategory [Required]¶

pydantic model py_ocpi.modules.locations.schemas.ExceptionalPeriod¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1411-exceptionalperiod-class

Show JSON schema

{
   "title": "ExceptionalPeriod",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1411-exceptionalperiod-class",
   "type": "object",
   "properties": {
      "period_begin": {
         "title": "Period Begin",
         "examples": [
            "2025-07-16T06:33:48Z"
         ],
         "type": "string"
      },
      "period_end": {
         "title": "Period End",
         "examples": [
            "2025-07-16T06:33:48Z"
         ],
         "type": "string"
      }
   },
   "required": [
      "period_begin",
      "period_end"
   ]
}

Fields:

period_begin (py_ocpi.core.data_types.DateTime)
period_end (py_ocpi.core.data_types.DateTime)

field period_begin: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field period_end: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

pydantic model py_ocpi.modules.locations.schemas.GeoLocation¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_geolocation_class

Show JSON schema

{
   "title": "GeoLocation",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_geolocation_class",
   "type": "object",
   "properties": {
      "latitude": {
         "title": "Latitude",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "longitude": {
         "title": "Longitude",
         "examples": [
            "String"
         ],
         "type": "string"
      }
   },
   "required": [
      "latitude",
      "longitude"
   ]
}

Fields:

latitude (py_ocpi.core.data_types.String)
longitude (py_ocpi.core.data_types.String)

field latitude: String [Required]¶

Constraints:

examples = [‘String’]

field longitude: String [Required]¶

Constraints:

examples = [‘String’]

pydantic model py_ocpi.modules.locations.schemas.Hours¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_hours_class

Show JSON schema

{
   "title": "Hours",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_hours_class",
   "type": "object",
   "properties": {
      "twentyfourseven": {
         "title": "Twentyfourseven",
         "type": "boolean"
      },
      "regular_hours": {
         "title": "Regular Hours",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/RegularHours"
         }
      },
      "exceptional_openings": {
         "title": "Exceptional Openings",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/ExceptionalPeriod"
         }
      },
      "exceptional_closings": {
         "title": "Exceptional Closings",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/ExceptionalPeriod"
         }
      }
   },
   "required": [
      "twentyfourseven"
   ],
   "definitions": {
      "RegularHours": {
         "title": "RegularHours",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1421-regularhours-class",
         "type": "object",
         "properties": {
            "weekday": {
               "title": "Weekday",
               "type": "integer"
            },
            "period_begin": {
               "title": "Period Begin",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "period_end": {
               "title": "Period End",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "weekday",
            "period_begin",
            "period_end"
         ]
      },
      "ExceptionalPeriod": {
         "title": "ExceptionalPeriod",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1411-exceptionalperiod-class",
         "type": "object",
         "properties": {
            "period_begin": {
               "title": "Period Begin",
               "examples": [
                  "2025-07-16T06:33:48Z"
               ],
               "type": "string"
            },
            "period_end": {
               "title": "Period End",
               "examples": [
                  "2025-07-16T06:33:48Z"
               ],
               "type": "string"
            }
         },
         "required": [
            "period_begin",
            "period_end"
         ]
      }
   }
}

Fields:

exceptional_closings (List[py_ocpi.modules.locations.schemas.ExceptionalPeriod])
exceptional_openings (List[py_ocpi.modules.locations.schemas.ExceptionalPeriod])
regular_hours (List[py_ocpi.modules.locations.schemas.RegularHours])
twentyfourseven (bool)

field exceptional_closings: List[ExceptionalPeriod] = []¶

field exceptional_openings: List[ExceptionalPeriod] = []¶

field regular_hours: List[RegularHours] = []¶

field twentyfourseven: bool [Required]¶

pydantic model py_ocpi.modules.locations.schemas.RegularHours¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1421-regularhours-class

Show JSON schema

{
   "title": "RegularHours",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1421-regularhours-class",
   "type": "object",
   "properties": {
      "weekday": {
         "title": "Weekday",
         "type": "integer"
      },
      "period_begin": {
         "title": "Period Begin",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "period_end": {
         "title": "Period End",
         "examples": [
            "String"
         ],
         "type": "string"
      }
   },
   "required": [
      "weekday",
      "period_begin",
      "period_end"
   ]
}

Fields:

period_begin (py_ocpi.core.data_types.String)
period_end (py_ocpi.core.data_types.String)
weekday (int)

field period_begin: String [Required]¶

Constraints:

examples = [‘String’]

field period_end: String [Required]¶

Constraints:

examples = [‘String’]

field weekday: int [Required]¶

pydantic model py_ocpi.modules.locations.schemas.StatusSchedule¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1423-statusschedule-class

Show JSON schema

{
   "title": "StatusSchedule",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1423-statusschedule-class",
   "type": "object",
   "properties": {
      "period_begin": {
         "title": "Period Begin",
         "examples": [
            "2025-07-16T06:33:48Z"
         ],
         "type": "string"
      },
      "period_end": {
         "title": "Period End",
         "examples": [
            "2025-07-16T06:33:48Z"
         ],
         "type": "string"
      },
      "status": {
         "$ref": "#/definitions/Status"
      }
   },
   "required": [
      "period_begin",
      "status"
   ],
   "definitions": {
      "Status": {
         "title": "Status",
         "description": "https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#420-status-enum",
         "enum": [
            "AVAILABLE",
            "BLOCKED",
            "CHARGING",
            "INOPERATIVE",
            "OUTOFORDER",
            "PLANNED",
            "REMOVED",
            "RESERVED",
            "UNKNOWN"
         ],
         "type": "string"
      }
   }
}

Fields:

period_begin (py_ocpi.core.data_types.DateTime)
period_end (Optional[py_ocpi.core.data_types.DateTime])
status (py_ocpi.modules.locations.enums.Status)

field period_begin: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field period_end: Optional[DateTime] = None¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field status: Status [Required]¶

CDRs module¶

pydantic model py_ocpi.modules.cdrs.v_2_2_1.schemas.Cdr¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#131-cdr-object

Show JSON schema

{
   "title": "Cdr",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#131-cdr-object",
   "type": "object",
   "properties": {
      "country_code": {
         "title": "Country Code",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "party_id": {
         "title": "Party Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "id": {
         "title": "Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "start_date_time": {
         "title": "Start Date Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "end_date_time": {
         "title": "End Date Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "session_id": {
         "title": "Session Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "cdr_token": {
         "$ref": "#/definitions/CdrToken"
      },
      "auth_method": {
         "$ref": "#/definitions/AuthMethod"
      },
      "authorization_reference": {
         "title": "Authorization Reference",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "cdr_location": {
         "$ref": "#/definitions/CdrLocation"
      },
      "meter_id": {
         "title": "Meter Id",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "currency": {
         "title": "Currency",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "tariffs": {
         "title": "Tariffs",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/Tariff"
         }
      },
      "charging_periods": {
         "title": "Charging Periods",
         "type": "array",
         "items": {
            "$ref": "#/definitions/ChargingPeriod"
         }
      },
      "signed_data": {
         "$ref": "#/definitions/SignedData"
      },
      "total_cost": {
         "title": "Total Cost",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "total_fixed_cost": {
         "title": "Total Fixed Cost",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "total_energy": {
         "title": "Total Energy",
         "examples": [],
         "type": "number"
      },
      "total_energy_cost": {
         "title": "Total Energy Cost",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "total_time": {
         "title": "Total Time",
         "examples": [],
         "type": "number"
      },
      "total_time_cost": {
         "title": "Total Time Cost",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "total_parking_time": {
         "title": "Total Parking Time",
         "examples": [],
         "type": "number"
      },
      "total_parking_cost": {
         "title": "Total Parking Cost",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "total_reservation_cost": {
         "title": "Total Reservation Cost",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "remark": {
         "title": "Remark",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "invoice_reference_id": {
         "title": "Invoice Reference Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "credit": {
         "title": "Credit",
         "type": "boolean"
      },
      "credit_reference_id": {
         "title": "Credit Reference Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "home_charging_compensation": {
         "title": "Home Charging Compensation",
         "type": "boolean"
      },
      "last_updated": {
         "title": "Last Updated",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      }
   },
   "required": [
      "country_code",
      "party_id",
      "id",
      "start_date_time",
      "end_date_time",
      "cdr_token",
      "auth_method",
      "cdr_location",
      "currency",
      "charging_periods",
      "total_cost",
      "total_energy",
      "total_time",
      "last_updated"
   ],
   "definitions": {
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      },
      "CdrToken": {
         "title": "CdrToken",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#145-cdrtoken-class",
         "type": "object",
         "properties": {
            "country_code": {
               "title": "Country Code",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "party_id": {
               "title": "Party Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "uid": {
               "title": "Uid",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/TokenType"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            }
         },
         "required": [
            "country_code",
            "party_id",
            "uid",
            "type",
            "contract_id"
         ]
      },
      "AuthMethod": {
         "title": "AuthMethod",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#141-authmethod-enum",
         "enum": [
            "AUTH_REQUEST",
            "COMMAND",
            "WHITELIST"
         ],
         "type": "string"
      },
      "GeoLocation": {
         "title": "GeoLocation",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_geolocation_class",
         "type": "object",
         "properties": {
            "latitude": {
               "title": "Latitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "longitude": {
               "title": "Longitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "latitude",
            "longitude"
         ]
      },
      "ConnectorType": {
         "title": "ConnectorType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#145-connectortype-enum",
         "enum": [
            "CHADEMO",
            "CHAOJI",
            "DOMESTIC_A",
            "DOMESTIC_B",
            "DOMESTIC_C",
            "DOMESTIC_D",
            "DOMESTIC_E",
            "DOMESTIC_F",
            "DOMESTIC_G",
            "DOMESTIC_H",
            "DOMESTIC_I",
            "DOMESTIC_J",
            "DOMESTIC_K",
            "DOMESTIC_L",
            "DOMESTIC_M",
            "DOMESTIC_N",
            "DOMESTIC_O",
            "GBT_AC",
            "GBT_DC",
            "IEC_60309_2_single_16",
            "IEC_60309_2_three_16",
            "IEC_60309_2_three_32",
            "IEC_60309_2_three_64",
            "IEC_62196_T1",
            "IEC_62196_T1_COMBO",
            "IEC_62196_T2",
            "IEC_62196_T2_COMBO",
            "IEC_62196_T3A",
            "IEC_62196_T3C",
            "NEMA_5_20",
            "NEMA_6_30",
            "NEMA_6_50",
            "NEMA_10_30",
            "NEMA_10_50",
            "NEMA_14_30",
            "NEMA_14_50",
            "PANTOGRAPH_BOTTOM_UP",
            "PANTOGRAPH_TOP_DOWN",
            "TESLA_R",
            "TESLA_S"
         ],
         "type": "string"
      },
      "ConnectorFormat": {
         "title": "ConnectorFormat",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#144-connectorformat-enum",
         "enum": [
            "SOCKET",
            "CABLE"
         ],
         "type": "string"
      },
      "PowerType": {
         "title": "PowerType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1419-powertype-enum",
         "enum": [
            "AC_1_PHASE",
            "AC_2_PHASE",
            "AC_2_PHASE_SPLIT",
            "AC_3_PHASE",
            "DC"
         ],
         "type": "string"
      },
      "CdrLocation": {
         "title": "CdrLocation",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#144-cdrlocation-class",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "name": {
               "title": "Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "address": {
               "title": "Address",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "city": {
               "title": "City",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "postal_code": {
               "title": "Postal Code",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "state": {
               "title": "State",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "country": {
               "title": "Country",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "coordinates": {
               "$ref": "#/definitions/GeoLocation"
            },
            "evse_id": {
               "title": "Evse Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "connector_id": {
               "title": "Connector Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "connector_standard": {
               "$ref": "#/definitions/ConnectorType"
            },
            "connector_format": {
               "$ref": "#/definitions/ConnectorFormat"
            },
            "connector_power_type": {
               "$ref": "#/definitions/PowerType"
            }
         },
         "required": [
            "id",
            "address",
            "city",
            "country",
            "coordinates",
            "evse_id",
            "connector_id",
            "connector_standard",
            "connector_format",
            "connector_power_type"
         ]
      },
      "TariffType": {
         "title": "TariffType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#147-tarifftype-enum",
         "enum": [
            "AD_HOC_PAYMENT",
            "PROFILE_CHEAP",
            "PROFILE_FAST",
            "PROFILE_GREEN",
            "REGULAR"
         ],
         "type": "string"
      },
      "TariffDimensionType": {
         "title": "TariffDimensionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#145-tariffdimensiontype-enum",
         "enum": [
            "ENERGY",
            "FLAT",
            "PARKING_TIME",
            "TIME"
         ],
         "type": "string"
      },
      "PriceComponent": {
         "title": "PriceComponent",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#142-pricecomponent-class",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/TariffDimensionType"
            },
            "price": {
               "title": "Price",
               "examples": [],
               "type": "number"
            },
            "vat": {
               "title": "Vat",
               "examples": [],
               "type": "number"
            },
            "step_size": {
               "title": "Step Size",
               "type": "integer"
            }
         },
         "required": [
            "type",
            "price",
            "step_size"
         ]
      },
      "DayOfWeek": {
         "title": "DayOfWeek",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#141-dayofweek-enum",
         "enum": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY",
            "SATURDAY",
            "SUNDAY"
         ],
         "type": "string"
      },
      "ReservationRestrictionType": {
         "title": "ReservationRestrictionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#143-reservationrestrictiontype-enum",
         "enum": [
            "RESERVATION",
            "RESERVATION_EXPIRES"
         ],
         "type": "string"
      },
      "TariffRestrictions": {
         "title": "TariffRestrictions",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#146-tariffrestrictions-class",
         "type": "object",
         "properties": {
            "start_time": {
               "title": "Start Time",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "end_time": {
               "title": "End Time",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "start_date": {
               "title": "Start Date",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "end_date": {
               "title": "End Date",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "min_kwh": {
               "title": "Min Kwh",
               "examples": [],
               "type": "number"
            },
            "max_kwh": {
               "title": "Max Kwh",
               "examples": [],
               "type": "number"
            },
            "min_current": {
               "title": "Min Current",
               "examples": [],
               "type": "number"
            },
            "max_current": {
               "title": "Max Current",
               "examples": [],
               "type": "number"
            },
            "min_power": {
               "title": "Min Power",
               "examples": [],
               "type": "number"
            },
            "max_power": {
               "title": "Max Power",
               "examples": [],
               "type": "number"
            },
            "min_duration": {
               "title": "Min Duration",
               "type": "integer"
            },
            "max_duration": {
               "title": "Max Duration",
               "type": "integer"
            },
            "day_of_week": {
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/DayOfWeek"
               }
            },
            "reservation": {
               "$ref": "#/definitions/ReservationRestrictionType"
            }
         }
      },
      "TariffElement": {
         "title": "TariffElement",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#144-tariffelement-class",
         "type": "object",
         "properties": {
            "price_components": {
               "title": "Price Components",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/PriceComponent"
               }
            },
            "restrictions": {
               "$ref": "#/definitions/TariffRestrictions"
            }
         },
         "required": [
            "price_components"
         ]
      },
      "EnergySourceCategory": {
         "title": "EnergySourceCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#148-energysourcecategory-enum",
         "enum": [
            "NUCLEAR",
            "GENERAL_FOSSIL",
            "COAL",
            "GAS",
            "GENERAL_GREEN",
            "SOLAR",
            "WIND",
            "WATER"
         ],
         "type": "string"
      },
      "EnergySource": {
         "title": "EnergySource",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#147-energysource-class",
         "type": "object",
         "properties": {
            "source": {
               "$ref": "#/definitions/EnergySourceCategory"
            },
            "percentage": {
               "title": "Percentage",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "source",
            "percentage"
         ]
      },
      "EnvironmentalImpactCategory": {
         "title": "EnvironmentalImpactCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1410-environmentalimpactcategory-enum",
         "enum": [
            "NUCLEAR_WASTE",
            "CARBON_DIOXIDE"
         ],
         "type": "string"
      },
      "EnvironmentalImpact": {
         "title": "EnvironmentalImpact",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#149-environmentalimpact-class",
         "type": "object",
         "properties": {
            "category": {
               "$ref": "#/definitions/EnvironmentalImpactCategory"
            },
            "amount": {
               "title": "Amount",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "category",
            "amount"
         ]
      },
      "EnergyMix": {
         "title": "EnergyMix",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_energymix_class",
         "type": "object",
         "properties": {
            "is_green_energy": {
               "title": "Is Green Energy",
               "type": "boolean"
            },
            "energy_sources": {
               "title": "Energy Sources",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/EnergySource"
               }
            },
            "environ_impact": {
               "$ref": "#/definitions/EnvironmentalImpact"
            },
            "supplier_name": {
               "title": "Supplier Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "energy_product_name": {
               "title": "Energy Product Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "is_green_energy",
            "energy_sources",
            "supplier_name",
            "energy_product_name"
         ]
      },
      "Tariff": {
         "title": "Tariff",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#131-tariff-object",
         "type": "object",
         "properties": {
            "country_code": {
               "title": "Country Code",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "party_id": {
               "title": "Party Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "id": {
               "title": "Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "currency": {
               "title": "Currency",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/TariffType"
            },
            "tariff_alt_text": {
               "title": "Tariff Alt Text",
               "default": [],
               "type": "array",
               "items": {
                  "type": "object",
                  "examples": [
                     {
                        "language": "en",
                        "text": "Standard Tariff"
                     }
                  ]
               }
            },
            "tariff_alt_url": {
               "title": "Tariff Alt Url",
               "examples": [
                  "http://www.w3.org/Addressing/URL/uri-spec.html"
               ],
               "type": "string"
            },
            "min_price": {
               "title": "Min Price",
               "examples": [
                  {
                     "excl_vat": 1.0,
                     "incl_vat": 1.25
                  }
               ],
               "type": "object"
            },
            "max_price": {
               "title": "Max Price",
               "examples": [
                  {
                     "excl_vat": 1.0,
                     "incl_vat": 1.25
                  }
               ],
               "type": "object"
            },
            "elements": {
               "title": "Elements",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/TariffElement"
               }
            },
            "start_date_time": {
               "title": "Start Date Time",
               "examples": [
                  "2025-07-16T06:33:50Z"
               ],
               "type": "string"
            },
            "end_date_time": {
               "title": "End Date Time",
               "examples": [
                  "2025-07-16T06:33:50Z"
               ],
               "type": "string"
            },
            "energy_mix": {
               "$ref": "#/definitions/EnergyMix"
            },
            "last_updated": {
               "title": "Last Updated",
               "examples": [
                  "2025-07-16T06:33:50Z"
               ],
               "type": "string"
            }
         },
         "required": [
            "country_code",
            "party_id",
            "id",
            "currency",
            "elements",
            "last_updated"
         ]
      },
      "CdrDimensionType": {
         "title": "CdrDimensionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#143-cdrdimensiontype-enum",
         "enum": [
            "CURRENT",
            "ENERGY",
            "ENERGY_EXPORT",
            "ENERGY_IMPORT",
            "MAX_CURRENT",
            "MIN_CURRENT",
            "MAX_POWER",
            "MIN_POWER",
            "PARKING_TIME",
            "POWER",
            "RESERVATION_TIME",
            "STATE_OF_CHARGE",
            "TIME"
         ],
         "type": "string"
      },
      "CdrDimension": {
         "title": "CdrDimension",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#142-cdrdimension-class",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/CdrDimensionType"
            },
            "volume": {
               "title": "Volume",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "type",
            "volume"
         ]
      },
      "ChargingPeriod": {
         "title": "ChargingPeriod",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#146-chargingperiod-class",
         "type": "object",
         "properties": {
            "start_date_time": {
               "title": "Start Date Time",
               "examples": [
                  "2025-07-16T06:33:50Z"
               ],
               "type": "string"
            },
            "dimensions": {
               "title": "Dimensions",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CdrDimension"
               }
            },
            "tariff_id": {
               "title": "Tariff Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            }
         },
         "required": [
            "start_date_time",
            "dimensions"
         ]
      },
      "SignedValue": {
         "title": "SignedValue",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#148-signedvalue-class",
         "type": "object",
         "properties": {
            "nature": {
               "title": "Nature",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "plain_data": {
               "title": "Plain Data",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "signed_data": {
               "title": "Signed Data",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "nature",
            "plain_data",
            "signed_data"
         ]
      },
      "SignedData": {
         "title": "SignedData",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#147-signeddata-class",
         "type": "object",
         "properties": {
            "encoding_method": {
               "title": "Encoding Method",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "encoding_method_version": {
               "title": "Encoding Method Version",
               "type": "integer"
            },
            "public_key": {
               "title": "Public Key",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "signed_values": {
               "title": "Signed Values",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/SignedValue"
               }
            },
            "url": {
               "title": "Url",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "encoding_method",
            "signed_values"
         ]
      }
   }
}

Fields:

auth_method (py_ocpi.modules.cdrs.v_2_2_1.enums.AuthMethod)
authorization_reference (Optional[py_ocpi.core.data_types.CiString])
cdr_location (py_ocpi.modules.cdrs.v_2_2_1.schemas.CdrLocation)
cdr_token (py_ocpi.modules.cdrs.v_2_2_1.schemas.CdrToken)
charging_periods (List[py_ocpi.modules.cdrs.v_2_2_1.schemas.ChargingPeriod])
country_code (py_ocpi.core.data_types.CiString)
credit (Optional[bool])
credit_reference_id (Optional[py_ocpi.core.data_types.CiString])
currency (py_ocpi.core.data_types.String)
end_date_time (py_ocpi.core.data_types.DateTime)
home_charging_compensation (Optional[bool])
id (py_ocpi.core.data_types.CiString)
invoice_reference_id (Optional[py_ocpi.core.data_types.CiString])
last_updated (py_ocpi.core.data_types.DateTime)
meter_id (Optional[py_ocpi.core.data_types.String])
party_id (py_ocpi.core.data_types.CiString)
remark (Optional[py_ocpi.core.data_types.String])
session_id (Optional[py_ocpi.core.data_types.CiString])
signed_data (Optional[py_ocpi.modules.cdrs.v_2_2_1.schemas.SignedData])
start_date_time (py_ocpi.core.data_types.DateTime)
tariffs (List[py_ocpi.modules.tariffs.v_2_2_1.schemas.Tariff])
total_cost (py_ocpi.core.data_types.Price)
total_energy (py_ocpi.core.data_types.Number)
total_energy_cost (Optional[py_ocpi.core.data_types.Price])
total_fixed_cost (Optional[py_ocpi.core.data_types.Price])
total_parking_cost (Optional[py_ocpi.core.data_types.Price])
total_parking_time (Optional[py_ocpi.core.data_types.Number])
total_reservation_cost (Optional[py_ocpi.core.data_types.Price])
total_time (py_ocpi.core.data_types.Number)
total_time_cost (Optional[py_ocpi.core.data_types.Price])

field auth_method: AuthMethod [Required]¶

field authorization_reference: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field cdr_location: CdrLocation [Required]¶

field cdr_token: CdrToken [Required]¶

field charging_periods: List[ChargingPeriod] [Required]¶

field country_code: CiString [Required]¶

Constraints:

examples = [‘string’]

field credit: Optional[bool] = None¶

field credit_reference_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field currency: String [Required]¶

Constraints:

examples = [‘String’]

field end_date_time: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field home_charging_compensation: Optional[bool] = None¶

field id: CiString [Required]¶

Constraints:

examples = [‘string’]

field invoice_reference_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field last_updated: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field meter_id: Optional[String] = None¶

Constraints:

examples = [‘String’]

field party_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field remark: Optional[String] = None¶

Constraints:

examples = [‘String’]

field session_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field signed_data: Optional[SignedData] = None¶

field start_date_time: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field tariffs: List[Tariff] = []¶

field total_cost: Price [Required]¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

field total_energy: Number [Required]¶

Constraints:

examples = []

field total_energy_cost: Optional[Price] = None¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

field total_fixed_cost: Optional[Price] = None¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

field total_parking_cost: Optional[Price] = None¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

field total_parking_time: Optional[Number] = None¶

Constraints:

examples = []

field total_reservation_cost: Optional[Price] = None¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

field total_time: Number [Required]¶

Constraints:

examples = []

field total_time_cost: Optional[Price] = None¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

pydantic model py_ocpi.modules.cdrs.v_2_2_1.schemas.CdrDimension¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#142-cdrdimension-class

Show JSON schema

{
   "title": "CdrDimension",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#142-cdrdimension-class",
   "type": "object",
   "properties": {
      "type": {
         "$ref": "#/definitions/CdrDimensionType"
      },
      "volume": {
         "title": "Volume",
         "examples": [],
         "type": "number"
      }
   },
   "required": [
      "type",
      "volume"
   ],
   "definitions": {
      "CdrDimensionType": {
         "title": "CdrDimensionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#143-cdrdimensiontype-enum",
         "enum": [
            "CURRENT",
            "ENERGY",
            "ENERGY_EXPORT",
            "ENERGY_IMPORT",
            "MAX_CURRENT",
            "MIN_CURRENT",
            "MAX_POWER",
            "MIN_POWER",
            "PARKING_TIME",
            "POWER",
            "RESERVATION_TIME",
            "STATE_OF_CHARGE",
            "TIME"
         ],
         "type": "string"
      }
   }
}

Fields:

type (py_ocpi.modules.cdrs.v_2_2_1.enums.CdrDimensionType)
volume (py_ocpi.core.data_types.Number)

field type: CdrDimensionType [Required]¶

field volume: Number [Required]¶

Constraints:

examples = []

pydantic model py_ocpi.modules.cdrs.v_2_2_1.schemas.CdrLocation¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#144-cdrlocation-class

Show JSON schema

{
   "title": "CdrLocation",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#144-cdrlocation-class",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "name": {
         "title": "Name",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "address": {
         "title": "Address",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "city": {
         "title": "City",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "postal_code": {
         "title": "Postal Code",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "state": {
         "title": "State",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "country": {
         "title": "Country",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "coordinates": {
         "$ref": "#/definitions/GeoLocation"
      },
      "evse_id": {
         "title": "Evse Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "connector_id": {
         "title": "Connector Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "connector_standard": {
         "$ref": "#/definitions/ConnectorType"
      },
      "connector_format": {
         "$ref": "#/definitions/ConnectorFormat"
      },
      "connector_power_type": {
         "$ref": "#/definitions/PowerType"
      }
   },
   "required": [
      "id",
      "address",
      "city",
      "country",
      "coordinates",
      "evse_id",
      "connector_id",
      "connector_standard",
      "connector_format",
      "connector_power_type"
   ],
   "definitions": {
      "GeoLocation": {
         "title": "GeoLocation",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_geolocation_class",
         "type": "object",
         "properties": {
            "latitude": {
               "title": "Latitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "longitude": {
               "title": "Longitude",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "latitude",
            "longitude"
         ]
      },
      "ConnectorType": {
         "title": "ConnectorType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#145-connectortype-enum",
         "enum": [
            "CHADEMO",
            "CHAOJI",
            "DOMESTIC_A",
            "DOMESTIC_B",
            "DOMESTIC_C",
            "DOMESTIC_D",
            "DOMESTIC_E",
            "DOMESTIC_F",
            "DOMESTIC_G",
            "DOMESTIC_H",
            "DOMESTIC_I",
            "DOMESTIC_J",
            "DOMESTIC_K",
            "DOMESTIC_L",
            "DOMESTIC_M",
            "DOMESTIC_N",
            "DOMESTIC_O",
            "GBT_AC",
            "GBT_DC",
            "IEC_60309_2_single_16",
            "IEC_60309_2_three_16",
            "IEC_60309_2_three_32",
            "IEC_60309_2_three_64",
            "IEC_62196_T1",
            "IEC_62196_T1_COMBO",
            "IEC_62196_T2",
            "IEC_62196_T2_COMBO",
            "IEC_62196_T3A",
            "IEC_62196_T3C",
            "NEMA_5_20",
            "NEMA_6_30",
            "NEMA_6_50",
            "NEMA_10_30",
            "NEMA_10_50",
            "NEMA_14_30",
            "NEMA_14_50",
            "PANTOGRAPH_BOTTOM_UP",
            "PANTOGRAPH_TOP_DOWN",
            "TESLA_R",
            "TESLA_S"
         ],
         "type": "string"
      },
      "ConnectorFormat": {
         "title": "ConnectorFormat",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#144-connectorformat-enum",
         "enum": [
            "SOCKET",
            "CABLE"
         ],
         "type": "string"
      },
      "PowerType": {
         "title": "PowerType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1419-powertype-enum",
         "enum": [
            "AC_1_PHASE",
            "AC_2_PHASE",
            "AC_2_PHASE_SPLIT",
            "AC_3_PHASE",
            "DC"
         ],
         "type": "string"
      }
   }
}

Fields:

address (py_ocpi.core.data_types.String)
city (py_ocpi.core.data_types.String)
connector_format (py_ocpi.modules.locations.enums.ConnectorFormat)
connector_id (py_ocpi.core.data_types.CiString)
connector_power_type (py_ocpi.modules.locations.v_2_2_1.enums.PowerType)
connector_standard (py_ocpi.modules.locations.v_2_2_1.enums.ConnectorType)
coordinates (py_ocpi.modules.locations.schemas.GeoLocation)
country (py_ocpi.core.data_types.String)
evse_id (py_ocpi.core.data_types.CiString)
id (py_ocpi.core.data_types.CiString)
name (Optional[py_ocpi.core.data_types.String])
postal_code (Optional[py_ocpi.core.data_types.String])
state (Optional[py_ocpi.core.data_types.String])

field address: String [Required]¶

Constraints:

examples = [‘String’]

field city: String [Required]¶

Constraints:

examples = [‘String’]

field connector_format: ConnectorFormat [Required]¶

field connector_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field connector_power_type: PowerType [Required]¶

field connector_standard: ConnectorType [Required]¶

field coordinates: GeoLocation [Required]¶

field country: String [Required]¶

Constraints:

examples = [‘String’]

field evse_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field id: CiString [Required]¶

Constraints:

examples = [‘string’]

field name: Optional[String] = None¶

Constraints:

examples = [‘String’]

field postal_code: Optional[String] = None¶

Constraints:

examples = [‘String’]

field state: Optional[String] = None¶

Constraints:

examples = [‘String’]

pydantic model py_ocpi.modules.cdrs.v_2_2_1.schemas.CdrToken¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#145-cdrtoken-class

Show JSON schema

{
   "title": "CdrToken",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#145-cdrtoken-class",
   "type": "object",
   "properties": {
      "country_code": {
         "title": "Country Code",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "party_id": {
         "title": "Party Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "uid": {
         "title": "Uid",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "type": {
         "$ref": "#/definitions/TokenType"
      },
      "contract_id": {
         "title": "Contract Id",
         "examples": [
            "string"
         ],
         "type": "string"
      }
   },
   "required": [
      "country_code",
      "party_id",
      "uid",
      "type",
      "contract_id"
   ],
   "definitions": {
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      }
   }
}

Fields:

contract_id (py_ocpi.core.data_types.CiString)
country_code (py_ocpi.core.data_types.CiString)
party_id (py_ocpi.core.data_types.CiString)
type (py_ocpi.modules.tokens.v_2_2_1.enums.TokenType)
uid (py_ocpi.core.data_types.CiString)

field contract_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field country_code: CiString [Required]¶

Constraints:

examples = [‘string’]

field party_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field type: TokenType [Required]¶

field uid: CiString [Required]¶

Constraints:

examples = [‘string’]

pydantic model py_ocpi.modules.cdrs.v_2_2_1.schemas.ChargingPeriod¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#146-chargingperiod-class

Show JSON schema

{
   "title": "ChargingPeriod",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#146-chargingperiod-class",
   "type": "object",
   "properties": {
      "start_date_time": {
         "title": "Start Date Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "dimensions": {
         "title": "Dimensions",
         "type": "array",
         "items": {
            "$ref": "#/definitions/CdrDimension"
         }
      },
      "tariff_id": {
         "title": "Tariff Id",
         "examples": [
            "string"
         ],
         "type": "string"
      }
   },
   "required": [
      "start_date_time",
      "dimensions"
   ],
   "definitions": {
      "CdrDimensionType": {
         "title": "CdrDimensionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#143-cdrdimensiontype-enum",
         "enum": [
            "CURRENT",
            "ENERGY",
            "ENERGY_EXPORT",
            "ENERGY_IMPORT",
            "MAX_CURRENT",
            "MIN_CURRENT",
            "MAX_POWER",
            "MIN_POWER",
            "PARKING_TIME",
            "POWER",
            "RESERVATION_TIME",
            "STATE_OF_CHARGE",
            "TIME"
         ],
         "type": "string"
      },
      "CdrDimension": {
         "title": "CdrDimension",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#142-cdrdimension-class",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/CdrDimensionType"
            },
            "volume": {
               "title": "Volume",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "type",
            "volume"
         ]
      }
   }
}

Fields:

dimensions (List[py_ocpi.modules.cdrs.v_2_2_1.schemas.CdrDimension])
start_date_time (py_ocpi.core.data_types.DateTime)
tariff_id (Optional[py_ocpi.core.data_types.CiString])

field dimensions: List[CdrDimension] [Required]¶

field start_date_time: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field tariff_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

pydantic model py_ocpi.modules.cdrs.v_2_2_1.schemas.SignedData¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#147-signeddata-class

Show JSON schema

{
   "title": "SignedData",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#147-signeddata-class",
   "type": "object",
   "properties": {
      "encoding_method": {
         "title": "Encoding Method",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "encoding_method_version": {
         "title": "Encoding Method Version",
         "type": "integer"
      },
      "public_key": {
         "title": "Public Key",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "signed_values": {
         "title": "Signed Values",
         "type": "array",
         "items": {
            "$ref": "#/definitions/SignedValue"
         }
      },
      "url": {
         "title": "Url",
         "examples": [
            "String"
         ],
         "type": "string"
      }
   },
   "required": [
      "encoding_method",
      "signed_values"
   ],
   "definitions": {
      "SignedValue": {
         "title": "SignedValue",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#148-signedvalue-class",
         "type": "object",
         "properties": {
            "nature": {
               "title": "Nature",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "plain_data": {
               "title": "Plain Data",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "signed_data": {
               "title": "Signed Data",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "nature",
            "plain_data",
            "signed_data"
         ]
      }
   }
}

Fields:

encoding_method (py_ocpi.core.data_types.CiString)
encoding_method_version (Optional[int])
public_key (Optional[py_ocpi.core.data_types.String])
signed_values (List[py_ocpi.modules.cdrs.v_2_2_1.schemas.SignedValue])
url (Optional[py_ocpi.core.data_types.String])

field encoding_method: CiString [Required]¶

Constraints:

examples = [‘string’]

field encoding_method_version: Optional[int] = None¶

field public_key: Optional[String] = None¶

Constraints:

examples = [‘String’]

field signed_values: List[SignedValue] [Required]¶

field url: Optional[String] = None¶

Constraints:

examples = [‘String’]

pydantic model py_ocpi.modules.cdrs.v_2_2_1.schemas.SignedValue¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#148-signedvalue-class

Show JSON schema

{
   "title": "SignedValue",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#148-signedvalue-class",
   "type": "object",
   "properties": {
      "nature": {
         "title": "Nature",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "plain_data": {
         "title": "Plain Data",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "signed_data": {
         "title": "Signed Data",
         "examples": [
            "String"
         ],
         "type": "string"
      }
   },
   "required": [
      "nature",
      "plain_data",
      "signed_data"
   ]
}

Fields:

nature (py_ocpi.core.data_types.CiString)
plain_data (py_ocpi.core.data_types.String)
signed_data (py_ocpi.core.data_types.String)

field nature: CiString [Required]¶

Constraints:

examples = [‘string’]

field plain_data: String [Required]¶

Constraints:

examples = [‘String’]

field signed_data: String [Required]¶

Constraints:

examples = [‘String’]

Sessions module¶

pydantic model py_ocpi.modules.sessions.v_2_2_1.schemas.ChargingPreferences¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#132-chargingpreferences-object

Show JSON schema

{
   "title": "ChargingPreferences",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#132-chargingpreferences-object",
   "type": "object",
   "properties": {
      "profile_type": {
         "$ref": "#/definitions/ProfileType"
      },
      "departure_time": {
         "title": "Departure Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "energy_need": {
         "title": "Energy Need",
         "examples": [],
         "type": "number"
      },
      "discharge_allowed": {
         "title": "Discharge Allowed",
         "type": "boolean"
      }
   },
   "required": [
      "profile_type"
   ],
   "definitions": {
      "ProfileType": {
         "title": "ProfileType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#142-profiletype-enum",
         "enum": [
            "CHEAP",
            "FAST",
            "GREEN",
            "REGULAR"
         ],
         "type": "string"
      }
   }
}

Fields:

departure_time (Optional[py_ocpi.core.data_types.DateTime])
discharge_allowed (Optional[bool])
energy_need (Optional[py_ocpi.core.data_types.Number])
profile_type (py_ocpi.modules.sessions.v_2_2_1.enums.ProfileType)

field departure_time: Optional[DateTime] = None¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field discharge_allowed: Optional[bool] = None¶

field energy_need: Optional[Number] = None¶

Constraints:

examples = []

field profile_type: ProfileType [Required]¶

pydantic model py_ocpi.modules.sessions.v_2_2_1.schemas.Session¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#131-session-object

Show JSON schema

{
   "title": "Session",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#131-session-object",
   "type": "object",
   "properties": {
      "country_code": {
         "title": "Country Code",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "party_id": {
         "title": "Party Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "id": {
         "title": "Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "start_date_time": {
         "title": "Start Date Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "end_date_time": {
         "title": "End Date Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "kwh": {
         "title": "Kwh",
         "examples": [],
         "type": "number"
      },
      "cdr_token": {
         "$ref": "#/definitions/CdrToken"
      },
      "auth_method": {
         "$ref": "#/definitions/AuthMethod"
      },
      "authorization_reference": {
         "title": "Authorization Reference",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "location_id": {
         "title": "Location Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "evse_uid": {
         "title": "Evse Uid",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "connector_id": {
         "title": "Connector Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "meter_id": {
         "title": "Meter Id",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "currency": {
         "title": "Currency",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "charging_periods": {
         "title": "Charging Periods",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/ChargingPeriod"
         }
      },
      "total_cost": {
         "title": "Total Cost",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "status": {
         "$ref": "#/definitions/SessionStatus"
      },
      "last_updated": {
         "title": "Last Updated",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      }
   },
   "required": [
      "country_code",
      "party_id",
      "id",
      "start_date_time",
      "kwh",
      "cdr_token",
      "auth_method",
      "location_id",
      "evse_uid",
      "connector_id",
      "currency",
      "status",
      "last_updated"
   ],
   "definitions": {
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      },
      "CdrToken": {
         "title": "CdrToken",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#145-cdrtoken-class",
         "type": "object",
         "properties": {
            "country_code": {
               "title": "Country Code",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "party_id": {
               "title": "Party Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "uid": {
               "title": "Uid",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/TokenType"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            }
         },
         "required": [
            "country_code",
            "party_id",
            "uid",
            "type",
            "contract_id"
         ]
      },
      "AuthMethod": {
         "title": "AuthMethod",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#141-authmethod-enum",
         "enum": [
            "AUTH_REQUEST",
            "COMMAND",
            "WHITELIST"
         ],
         "type": "string"
      },
      "CdrDimensionType": {
         "title": "CdrDimensionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#143-cdrdimensiontype-enum",
         "enum": [
            "CURRENT",
            "ENERGY",
            "ENERGY_EXPORT",
            "ENERGY_IMPORT",
            "MAX_CURRENT",
            "MIN_CURRENT",
            "MAX_POWER",
            "MIN_POWER",
            "PARKING_TIME",
            "POWER",
            "RESERVATION_TIME",
            "STATE_OF_CHARGE",
            "TIME"
         ],
         "type": "string"
      },
      "CdrDimension": {
         "title": "CdrDimension",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#142-cdrdimension-class",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/CdrDimensionType"
            },
            "volume": {
               "title": "Volume",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "type",
            "volume"
         ]
      },
      "ChargingPeriod": {
         "title": "ChargingPeriod",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#146-chargingperiod-class",
         "type": "object",
         "properties": {
            "start_date_time": {
               "title": "Start Date Time",
               "examples": [
                  "2025-07-16T06:33:50Z"
               ],
               "type": "string"
            },
            "dimensions": {
               "title": "Dimensions",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CdrDimension"
               }
            },
            "tariff_id": {
               "title": "Tariff Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            }
         },
         "required": [
            "start_date_time",
            "dimensions"
         ]
      },
      "SessionStatus": {
         "title": "SessionStatus",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#143-sessionstatus-enum",
         "enum": [
            "ACTIVE",
            "COMPLETED",
            "INVALID",
            "PENDING",
            "RESERVATION"
         ],
         "type": "string"
      }
   }
}

Fields:

auth_method (py_ocpi.modules.cdrs.v_2_2_1.enums.AuthMethod)
authorization_reference (Optional[py_ocpi.core.data_types.CiString])
cdr_token (py_ocpi.modules.cdrs.v_2_2_1.schemas.CdrToken)
charging_periods (List[py_ocpi.modules.cdrs.v_2_2_1.schemas.ChargingPeriod])
connector_id (py_ocpi.core.data_types.CiString)
country_code (py_ocpi.core.data_types.CiString)
currency (py_ocpi.core.data_types.String)
end_date_time (Optional[py_ocpi.core.data_types.DateTime])
evse_uid (py_ocpi.core.data_types.CiString)
id (py_ocpi.core.data_types.CiString)
kwh (py_ocpi.core.data_types.Number)
last_updated (py_ocpi.core.data_types.DateTime)
location_id (py_ocpi.core.data_types.CiString)
meter_id (Optional[py_ocpi.core.data_types.String])
party_id (py_ocpi.core.data_types.CiString)
start_date_time (py_ocpi.core.data_types.DateTime)
status (py_ocpi.modules.sessions.v_2_2_1.enums.SessionStatus)
total_cost (Optional[py_ocpi.core.data_types.Price])

field auth_method: AuthMethod [Required]¶

field authorization_reference: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field cdr_token: CdrToken [Required]¶

field charging_periods: List[ChargingPeriod] = []¶

field connector_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field country_code: CiString [Required]¶

Constraints:

examples = [‘string’]

field currency: String [Required]¶

Constraints:

examples = [‘String’]

field end_date_time: Optional[DateTime] = None¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field evse_uid: CiString [Required]¶

Constraints:

examples = [‘string’]

field id: CiString [Required]¶

Constraints:

examples = [‘string’]

field kwh: Number [Required]¶

Constraints:

examples = []

field last_updated: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field location_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field meter_id: Optional[String] = None¶

Constraints:

examples = [‘String’]

field party_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field start_date_time: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field status: SessionStatus [Required]¶

field total_cost: Optional[Price] = None¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

pydantic model py_ocpi.modules.sessions.v_2_2_1.schemas.SessionPartialUpdate¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#131-session-object

Show JSON schema

{
   "title": "SessionPartialUpdate",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#131-session-object",
   "type": "object",
   "properties": {
      "country_code": {
         "title": "Country Code",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "party_id": {
         "title": "Party Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "id": {
         "title": "Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "start_date_time": {
         "title": "Start Date Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "end_date_time": {
         "title": "End Date Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "kwh": {
         "title": "Kwh",
         "examples": [],
         "type": "number"
      },
      "cdr_token": {
         "$ref": "#/definitions/CdrToken"
      },
      "auth_method": {
         "$ref": "#/definitions/AuthMethod"
      },
      "authorization_reference": {
         "title": "Authorization Reference",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "location_id": {
         "title": "Location Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "evse_uid": {
         "title": "Evse Uid",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "connector_id": {
         "title": "Connector Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "meter_id": {
         "title": "Meter Id",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "currency": {
         "title": "Currency",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "charging_periods": {
         "title": "Charging Periods",
         "type": "array",
         "items": {
            "$ref": "#/definitions/ChargingPeriod"
         }
      },
      "total_cost": {
         "title": "Total Cost",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "status": {
         "$ref": "#/definitions/SessionStatus"
      },
      "last_updated": {
         "title": "Last Updated",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      }
   },
   "definitions": {
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      },
      "CdrToken": {
         "title": "CdrToken",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#145-cdrtoken-class",
         "type": "object",
         "properties": {
            "country_code": {
               "title": "Country Code",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "party_id": {
               "title": "Party Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "uid": {
               "title": "Uid",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/TokenType"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            }
         },
         "required": [
            "country_code",
            "party_id",
            "uid",
            "type",
            "contract_id"
         ]
      },
      "AuthMethod": {
         "title": "AuthMethod",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#141-authmethod-enum",
         "enum": [
            "AUTH_REQUEST",
            "COMMAND",
            "WHITELIST"
         ],
         "type": "string"
      },
      "CdrDimensionType": {
         "title": "CdrDimensionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#143-cdrdimensiontype-enum",
         "enum": [
            "CURRENT",
            "ENERGY",
            "ENERGY_EXPORT",
            "ENERGY_IMPORT",
            "MAX_CURRENT",
            "MIN_CURRENT",
            "MAX_POWER",
            "MIN_POWER",
            "PARKING_TIME",
            "POWER",
            "RESERVATION_TIME",
            "STATE_OF_CHARGE",
            "TIME"
         ],
         "type": "string"
      },
      "CdrDimension": {
         "title": "CdrDimension",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#142-cdrdimension-class",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/CdrDimensionType"
            },
            "volume": {
               "title": "Volume",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "type",
            "volume"
         ]
      },
      "ChargingPeriod": {
         "title": "ChargingPeriod",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#146-chargingperiod-class",
         "type": "object",
         "properties": {
            "start_date_time": {
               "title": "Start Date Time",
               "examples": [
                  "2025-07-16T06:33:50Z"
               ],
               "type": "string"
            },
            "dimensions": {
               "title": "Dimensions",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/CdrDimension"
               }
            },
            "tariff_id": {
               "title": "Tariff Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            }
         },
         "required": [
            "start_date_time",
            "dimensions"
         ]
      },
      "SessionStatus": {
         "title": "SessionStatus",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#143-sessionstatus-enum",
         "enum": [
            "ACTIVE",
            "COMPLETED",
            "INVALID",
            "PENDING",
            "RESERVATION"
         ],
         "type": "string"
      }
   }
}

Fields:

auth_method (Optional[py_ocpi.modules.cdrs.v_2_2_1.enums.AuthMethod])
authorization_reference (Optional[py_ocpi.core.data_types.CiString])
cdr_token (Optional[py_ocpi.modules.cdrs.v_2_2_1.schemas.CdrToken])
charging_periods (Optional[List[py_ocpi.modules.cdrs.v_2_2_1.schemas.ChargingPeriod]])
connector_id (Optional[py_ocpi.core.data_types.CiString])
country_code (Optional[py_ocpi.core.data_types.CiString])
currency (Optional[py_ocpi.core.data_types.String])
end_date_time (Optional[py_ocpi.core.data_types.DateTime])
evse_uid (Optional[py_ocpi.core.data_types.CiString])
id (Optional[py_ocpi.core.data_types.CiString])
kwh (Optional[py_ocpi.core.data_types.Number])
last_updated (Optional[py_ocpi.core.data_types.DateTime])
location_id (Optional[py_ocpi.core.data_types.CiString])
meter_id (Optional[py_ocpi.core.data_types.String])
party_id (Optional[py_ocpi.core.data_types.CiString])
start_date_time (Optional[py_ocpi.core.data_types.DateTime])
status (Optional[py_ocpi.modules.sessions.v_2_2_1.enums.SessionStatus])
total_cost (Optional[py_ocpi.core.data_types.Price])

field auth_method: Optional[AuthMethod] = None¶

field authorization_reference: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field cdr_token: Optional[CdrToken] = None¶

field charging_periods: Optional[List[ChargingPeriod]] = None¶

field connector_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field country_code: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field currency: Optional[String] = None¶

Constraints:

examples = [‘String’]

field end_date_time: Optional[DateTime] = None¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field evse_uid: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field kwh: Optional[Number] = None¶

Constraints:

examples = []

field last_updated: Optional[DateTime] = None¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field location_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field meter_id: Optional[String] = None¶

Constraints:

examples = [‘String’]

field party_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field start_date_time: Optional[DateTime] = None¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field status: Optional[SessionStatus] = None¶

field total_cost: Optional[Price] = None¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

Tokens module¶

pydantic model py_ocpi.modules.tokens.v_2_2_1.schemas.AuthorizationInfo¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#131-authorizationinfo-object

Show JSON schema

{
   "title": "AuthorizationInfo",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#131-authorizationinfo-object",
   "type": "object",
   "properties": {
      "allowed": {
         "$ref": "#/definitions/AllowedType"
      },
      "token": {
         "$ref": "#/definitions/Token"
      },
      "location": {
         "$ref": "#/definitions/LocationReference"
      },
      "authorization_reference": {
         "title": "Authorization Reference",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "info": {
         "title": "Info",
         "examples": [
            {
               "language": "en",
               "text": "Standard Tariff"
            }
         ],
         "type": "object"
      }
   },
   "required": [
      "allowed",
      "token"
   ],
   "definitions": {
      "AllowedType": {
         "title": "AllowedType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#141-allowedtype-enum",
         "enum": [
            "ALLOWED",
            "BLOCKED",
            "EXPIRED",
            "NO_CREDIT",
            "NOT_ALLOWED"
         ],
         "type": "string"
      },
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      },
      "WhitelistType": {
         "title": "WhitelistType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#145-whitelisttype-enum",
         "enum": [
            "ALWAYS",
            "ALLOWED",
            "ALLOWED_OFFLINE",
            "NEVER"
         ],
         "type": "string"
      },
      "ProfileType": {
         "title": "ProfileType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#142-profiletype-enum",
         "enum": [
            "CHEAP",
            "FAST",
            "GREEN",
            "REGULAR"
         ],
         "type": "string"
      },
      "EnergyContract": {
         "title": "EnergyContract",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#142-energycontract-class",
         "type": "object",
         "properties": {
            "supplier_name": {
               "title": "Supplier Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "supplier_name"
         ]
      },
      "Token": {
         "title": "Token",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#132-token-object",
         "type": "object",
         "properties": {
            "country_code": {
               "title": "Country Code",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "party_id": {
               "title": "Party Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "uid": {
               "title": "Uid",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/TokenType"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "visual_number": {
               "title": "Visual Number",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "issuer": {
               "title": "Issuer",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "group_id": {
               "title": "Group Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "valid": {
               "title": "Valid",
               "type": "boolean"
            },
            "whitelist": {
               "$ref": "#/definitions/WhitelistType"
            },
            "language": {
               "title": "Language",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "default_profile_type": {
               "$ref": "#/definitions/ProfileType"
            },
            "energy_contract": {
               "$ref": "#/definitions/EnergyContract"
            },
            "last_updated": {
               "title": "Last Updated",
               "examples": [
                  "2025-07-16T06:33:50Z"
               ],
               "type": "string"
            }
         },
         "required": [
            "country_code",
            "party_id",
            "uid",
            "type",
            "contract_id",
            "issuer",
            "valid",
            "whitelist",
            "last_updated"
         ]
      },
      "LocationReference": {
         "title": "LocationReference",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#143-locationreferences-class",
         "type": "object",
         "properties": {
            "location_id": {
               "title": "Location Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "evse_uids": {
               "title": "Evse Uids",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string",
                  "examples": [
                     "string"
                  ]
               }
            }
         },
         "required": [
            "location_id"
         ]
      }
   }
}

Fields:

allowed (py_ocpi.modules.tokens.v_2_2_1.enums.AllowedType)
authorization_reference (Optional[py_ocpi.core.data_types.CiString])
info (Optional[py_ocpi.core.data_types.DisplayText])
location (Optional[py_ocpi.modules.tokens.v_2_2_1.schemas.LocationReference])
token (py_ocpi.modules.tokens.v_2_2_1.schemas.Token)

field allowed: AllowedType [Required]¶

field authorization_reference: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field info: Optional[DisplayText] = None¶

Constraints:

examples = [{‘language’: ‘en’, ‘text’: ‘Standard Tariff’}]

field location: Optional[LocationReference] = None¶

field token: Token [Required]¶

pydantic model py_ocpi.modules.tokens.v_2_2_1.schemas.EnergyContract¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#142-energycontract-class

Show JSON schema

{
   "title": "EnergyContract",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#142-energycontract-class",
   "type": "object",
   "properties": {
      "supplier_name": {
         "title": "Supplier Name",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "contract_id": {
         "title": "Contract Id",
         "examples": [
            "String"
         ],
         "type": "string"
      }
   },
   "required": [
      "supplier_name"
   ]
}

Fields:

contract_id (Optional[py_ocpi.core.data_types.String])
supplier_name (py_ocpi.core.data_types.String)

field contract_id: Optional[String] = None¶

Constraints:

examples = [‘String’]

field supplier_name: String [Required]¶

Constraints:

examples = [‘String’]

pydantic model py_ocpi.modules.tokens.v_2_2_1.schemas.LocationReference¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#143-locationreferences-class

Show JSON schema

{
   "title": "LocationReference",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#143-locationreferences-class",
   "type": "object",
   "properties": {
      "location_id": {
         "title": "Location Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "evse_uids": {
         "title": "Evse Uids",
         "default": [],
         "type": "array",
         "items": {
            "type": "string",
            "examples": [
               "string"
            ]
         }
      }
   },
   "required": [
      "location_id"
   ]
}

Fields:

evse_uids (List[py_ocpi.core.data_types.CiString])
location_id (py_ocpi.core.data_types.CiString)

field evse_uids: List[CiString] = []¶

field location_id: CiString [Required]¶

Constraints:

examples = [‘string’]

pydantic model py_ocpi.modules.tokens.v_2_2_1.schemas.Token¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#132-token-object

Show JSON schema

{
   "title": "Token",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#132-token-object",
   "type": "object",
   "properties": {
      "country_code": {
         "title": "Country Code",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "party_id": {
         "title": "Party Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "uid": {
         "title": "Uid",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "type": {
         "$ref": "#/definitions/TokenType"
      },
      "contract_id": {
         "title": "Contract Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "visual_number": {
         "title": "Visual Number",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "issuer": {
         "title": "Issuer",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "group_id": {
         "title": "Group Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "valid": {
         "title": "Valid",
         "type": "boolean"
      },
      "whitelist": {
         "$ref": "#/definitions/WhitelistType"
      },
      "language": {
         "title": "Language",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "default_profile_type": {
         "$ref": "#/definitions/ProfileType"
      },
      "energy_contract": {
         "$ref": "#/definitions/EnergyContract"
      },
      "last_updated": {
         "title": "Last Updated",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      }
   },
   "required": [
      "country_code",
      "party_id",
      "uid",
      "type",
      "contract_id",
      "issuer",
      "valid",
      "whitelist",
      "last_updated"
   ],
   "definitions": {
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      },
      "WhitelistType": {
         "title": "WhitelistType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#145-whitelisttype-enum",
         "enum": [
            "ALWAYS",
            "ALLOWED",
            "ALLOWED_OFFLINE",
            "NEVER"
         ],
         "type": "string"
      },
      "ProfileType": {
         "title": "ProfileType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#142-profiletype-enum",
         "enum": [
            "CHEAP",
            "FAST",
            "GREEN",
            "REGULAR"
         ],
         "type": "string"
      },
      "EnergyContract": {
         "title": "EnergyContract",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#142-energycontract-class",
         "type": "object",
         "properties": {
            "supplier_name": {
               "title": "Supplier Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "supplier_name"
         ]
      }
   }
}

Fields:

contract_id (py_ocpi.core.data_types.CiString)
country_code (py_ocpi.core.data_types.CiString)
default_profile_type (Optional[py_ocpi.modules.sessions.v_2_2_1.enums.ProfileType])
energy_contract (Optional[py_ocpi.modules.tokens.v_2_2_1.schemas.EnergyContract])
group_id (Optional[py_ocpi.core.data_types.CiString])
issuer (py_ocpi.core.data_types.String)
language (Optional[py_ocpi.core.data_types.String])
last_updated (py_ocpi.core.data_types.DateTime)
party_id (py_ocpi.core.data_types.CiString)
type (py_ocpi.modules.tokens.v_2_2_1.enums.TokenType)
uid (py_ocpi.core.data_types.CiString)
valid (bool)
visual_number (Optional[py_ocpi.core.data_types.String])
whitelist (py_ocpi.modules.tokens.v_2_2_1.enums.WhitelistType)

field contract_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field country_code: CiString [Required]¶

Constraints:

examples = [‘string’]

field default_profile_type: Optional[ProfileType] = None¶

field energy_contract: Optional[EnergyContract] = None¶

field group_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field issuer: String [Required]¶

Constraints:

examples = [‘String’]

field language: Optional[String] = None¶

Constraints:

examples = [‘String’]

field last_updated: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field party_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field type: TokenType [Required]¶

field uid: CiString [Required]¶

Constraints:

examples = [‘string’]

field valid: bool [Required]¶

field visual_number: Optional[String] = None¶

Constraints:

examples = [‘String’]

field whitelist: WhitelistType [Required]¶

Tariffs module¶

pydantic model py_ocpi.modules.tariffs.v_2_2_1.schemas.PriceComponent¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#142-pricecomponent-class

Show JSON schema

{
   "title": "PriceComponent",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#142-pricecomponent-class",
   "type": "object",
   "properties": {
      "type": {
         "$ref": "#/definitions/TariffDimensionType"
      },
      "price": {
         "title": "Price",
         "examples": [],
         "type": "number"
      },
      "vat": {
         "title": "Vat",
         "examples": [],
         "type": "number"
      },
      "step_size": {
         "title": "Step Size",
         "type": "integer"
      }
   },
   "required": [
      "type",
      "price",
      "step_size"
   ],
   "definitions": {
      "TariffDimensionType": {
         "title": "TariffDimensionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#145-tariffdimensiontype-enum",
         "enum": [
            "ENERGY",
            "FLAT",
            "PARKING_TIME",
            "TIME"
         ],
         "type": "string"
      }
   }
}

Fields:

price (py_ocpi.core.data_types.Number)
step_size (int)
type (py_ocpi.modules.tariffs.v_2_2_1.enums.TariffDimensionType)
vat (Optional[py_ocpi.core.data_types.Number])

field price: Number [Required]¶

Constraints:

examples = []

field step_size: int [Required]¶

field type: TariffDimensionType [Required]¶

field vat: Optional[Number] = None¶

Constraints:

examples = []

pydantic model py_ocpi.modules.tariffs.v_2_2_1.schemas.Tariff¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#131-tariff-object

Show JSON schema

{
   "title": "Tariff",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#131-tariff-object",
   "type": "object",
   "properties": {
      "country_code": {
         "title": "Country Code",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "party_id": {
         "title": "Party Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "id": {
         "title": "Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "currency": {
         "title": "Currency",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "type": {
         "$ref": "#/definitions/TariffType"
      },
      "tariff_alt_text": {
         "title": "Tariff Alt Text",
         "default": [],
         "type": "array",
         "items": {
            "type": "object",
            "examples": [
               {
                  "language": "en",
                  "text": "Standard Tariff"
               }
            ]
         }
      },
      "tariff_alt_url": {
         "title": "Tariff Alt Url",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "min_price": {
         "title": "Min Price",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "max_price": {
         "title": "Max Price",
         "examples": [
            {
               "excl_vat": 1.0,
               "incl_vat": 1.25
            }
         ],
         "type": "object"
      },
      "elements": {
         "title": "Elements",
         "type": "array",
         "items": {
            "$ref": "#/definitions/TariffElement"
         }
      },
      "start_date_time": {
         "title": "Start Date Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "end_date_time": {
         "title": "End Date Time",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "energy_mix": {
         "$ref": "#/definitions/EnergyMix"
      },
      "last_updated": {
         "title": "Last Updated",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      }
   },
   "required": [
      "country_code",
      "party_id",
      "id",
      "currency",
      "elements",
      "last_updated"
   ],
   "definitions": {
      "TariffType": {
         "title": "TariffType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#147-tarifftype-enum",
         "enum": [
            "AD_HOC_PAYMENT",
            "PROFILE_CHEAP",
            "PROFILE_FAST",
            "PROFILE_GREEN",
            "REGULAR"
         ],
         "type": "string"
      },
      "TariffDimensionType": {
         "title": "TariffDimensionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#145-tariffdimensiontype-enum",
         "enum": [
            "ENERGY",
            "FLAT",
            "PARKING_TIME",
            "TIME"
         ],
         "type": "string"
      },
      "PriceComponent": {
         "title": "PriceComponent",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#142-pricecomponent-class",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/TariffDimensionType"
            },
            "price": {
               "title": "Price",
               "examples": [],
               "type": "number"
            },
            "vat": {
               "title": "Vat",
               "examples": [],
               "type": "number"
            },
            "step_size": {
               "title": "Step Size",
               "type": "integer"
            }
         },
         "required": [
            "type",
            "price",
            "step_size"
         ]
      },
      "DayOfWeek": {
         "title": "DayOfWeek",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#141-dayofweek-enum",
         "enum": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY",
            "SATURDAY",
            "SUNDAY"
         ],
         "type": "string"
      },
      "ReservationRestrictionType": {
         "title": "ReservationRestrictionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#143-reservationrestrictiontype-enum",
         "enum": [
            "RESERVATION",
            "RESERVATION_EXPIRES"
         ],
         "type": "string"
      },
      "TariffRestrictions": {
         "title": "TariffRestrictions",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#146-tariffrestrictions-class",
         "type": "object",
         "properties": {
            "start_time": {
               "title": "Start Time",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "end_time": {
               "title": "End Time",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "start_date": {
               "title": "Start Date",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "end_date": {
               "title": "End Date",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "min_kwh": {
               "title": "Min Kwh",
               "examples": [],
               "type": "number"
            },
            "max_kwh": {
               "title": "Max Kwh",
               "examples": [],
               "type": "number"
            },
            "min_current": {
               "title": "Min Current",
               "examples": [],
               "type": "number"
            },
            "max_current": {
               "title": "Max Current",
               "examples": [],
               "type": "number"
            },
            "min_power": {
               "title": "Min Power",
               "examples": [],
               "type": "number"
            },
            "max_power": {
               "title": "Max Power",
               "examples": [],
               "type": "number"
            },
            "min_duration": {
               "title": "Min Duration",
               "type": "integer"
            },
            "max_duration": {
               "title": "Max Duration",
               "type": "integer"
            },
            "day_of_week": {
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/DayOfWeek"
               }
            },
            "reservation": {
               "$ref": "#/definitions/ReservationRestrictionType"
            }
         }
      },
      "TariffElement": {
         "title": "TariffElement",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#144-tariffelement-class",
         "type": "object",
         "properties": {
            "price_components": {
               "title": "Price Components",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/PriceComponent"
               }
            },
            "restrictions": {
               "$ref": "#/definitions/TariffRestrictions"
            }
         },
         "required": [
            "price_components"
         ]
      },
      "EnergySourceCategory": {
         "title": "EnergySourceCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#148-energysourcecategory-enum",
         "enum": [
            "NUCLEAR",
            "GENERAL_FOSSIL",
            "COAL",
            "GAS",
            "GENERAL_GREEN",
            "SOLAR",
            "WIND",
            "WATER"
         ],
         "type": "string"
      },
      "EnergySource": {
         "title": "EnergySource",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#147-energysource-class",
         "type": "object",
         "properties": {
            "source": {
               "$ref": "#/definitions/EnergySourceCategory"
            },
            "percentage": {
               "title": "Percentage",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "source",
            "percentage"
         ]
      },
      "EnvironmentalImpactCategory": {
         "title": "EnvironmentalImpactCategory",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1410-environmentalimpactcategory-enum",
         "enum": [
            "NUCLEAR_WASTE",
            "CARBON_DIOXIDE"
         ],
         "type": "string"
      },
      "EnvironmentalImpact": {
         "title": "EnvironmentalImpact",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#149-environmentalimpact-class",
         "type": "object",
         "properties": {
            "category": {
               "$ref": "#/definitions/EnvironmentalImpactCategory"
            },
            "amount": {
               "title": "Amount",
               "examples": [],
               "type": "number"
            }
         },
         "required": [
            "category",
            "amount"
         ]
      },
      "EnergyMix": {
         "title": "EnergyMix",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#mod_locations_energymix_class",
         "type": "object",
         "properties": {
            "is_green_energy": {
               "title": "Is Green Energy",
               "type": "boolean"
            },
            "energy_sources": {
               "title": "Energy Sources",
               "type": "array",
               "items": {
                  "$ref": "#/definitions/EnergySource"
               }
            },
            "environ_impact": {
               "$ref": "#/definitions/EnvironmentalImpact"
            },
            "supplier_name": {
               "title": "Supplier Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "energy_product_name": {
               "title": "Energy Product Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "is_green_energy",
            "energy_sources",
            "supplier_name",
            "energy_product_name"
         ]
      }
   }
}

Fields:

country_code (py_ocpi.core.data_types.CiString)
currency (py_ocpi.core.data_types.String)
elements (List[py_ocpi.modules.tariffs.v_2_2_1.schemas.TariffElement])
end_date_time (Optional[py_ocpi.core.data_types.DateTime])
energy_mix (Optional[py_ocpi.modules.locations.schemas.EnergyMix])
id (py_ocpi.core.data_types.CiString)
last_updated (py_ocpi.core.data_types.DateTime)
max_price (Optional[py_ocpi.core.data_types.Price])
min_price (Optional[py_ocpi.core.data_types.Price])
party_id (py_ocpi.core.data_types.CiString)
start_date_time (Optional[py_ocpi.core.data_types.DateTime])
tariff_alt_text (List[py_ocpi.core.data_types.DisplayText])
tariff_alt_url (Optional[py_ocpi.core.data_types.URL])
type (Optional[py_ocpi.modules.tariffs.v_2_2_1.enums.TariffType])

field country_code: CiString [Required]¶

Constraints:

examples = [‘string’]

field currency: String [Required]¶

Constraints:

examples = [‘String’]

field elements: List[TariffElement] [Required]¶

field end_date_time: Optional[DateTime] = None¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field energy_mix: Optional[EnergyMix] = None¶

field id: CiString [Required]¶

Constraints:

examples = [‘string’]

field last_updated: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field max_price: Optional[Price] = None¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

field min_price: Optional[Price] = None¶

Constraints:

examples = [{‘excl_vat’: 1.0, ‘incl_vat’: 1.25}]

field party_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field start_date_time: Optional[DateTime] = None¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field tariff_alt_text: List[DisplayText] = []¶

field tariff_alt_url: Optional[URL] = None¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

field type: Optional[TariffType] = None¶

pydantic model py_ocpi.modules.tariffs.v_2_2_1.schemas.TariffElement¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#144-tariffelement-class

Show JSON schema

{
   "title": "TariffElement",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#144-tariffelement-class",
   "type": "object",
   "properties": {
      "price_components": {
         "title": "Price Components",
         "type": "array",
         "items": {
            "$ref": "#/definitions/PriceComponent"
         }
      },
      "restrictions": {
         "$ref": "#/definitions/TariffRestrictions"
      }
   },
   "required": [
      "price_components"
   ],
   "definitions": {
      "TariffDimensionType": {
         "title": "TariffDimensionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#145-tariffdimensiontype-enum",
         "enum": [
            "ENERGY",
            "FLAT",
            "PARKING_TIME",
            "TIME"
         ],
         "type": "string"
      },
      "PriceComponent": {
         "title": "PriceComponent",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#142-pricecomponent-class",
         "type": "object",
         "properties": {
            "type": {
               "$ref": "#/definitions/TariffDimensionType"
            },
            "price": {
               "title": "Price",
               "examples": [],
               "type": "number"
            },
            "vat": {
               "title": "Vat",
               "examples": [],
               "type": "number"
            },
            "step_size": {
               "title": "Step Size",
               "type": "integer"
            }
         },
         "required": [
            "type",
            "price",
            "step_size"
         ]
      },
      "DayOfWeek": {
         "title": "DayOfWeek",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#141-dayofweek-enum",
         "enum": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY",
            "SATURDAY",
            "SUNDAY"
         ],
         "type": "string"
      },
      "ReservationRestrictionType": {
         "title": "ReservationRestrictionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#143-reservationrestrictiontype-enum",
         "enum": [
            "RESERVATION",
            "RESERVATION_EXPIRES"
         ],
         "type": "string"
      },
      "TariffRestrictions": {
         "title": "TariffRestrictions",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#146-tariffrestrictions-class",
         "type": "object",
         "properties": {
            "start_time": {
               "title": "Start Time",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "end_time": {
               "title": "End Time",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "start_date": {
               "title": "Start Date",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "end_date": {
               "title": "End Date",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "min_kwh": {
               "title": "Min Kwh",
               "examples": [],
               "type": "number"
            },
            "max_kwh": {
               "title": "Max Kwh",
               "examples": [],
               "type": "number"
            },
            "min_current": {
               "title": "Min Current",
               "examples": [],
               "type": "number"
            },
            "max_current": {
               "title": "Max Current",
               "examples": [],
               "type": "number"
            },
            "min_power": {
               "title": "Min Power",
               "examples": [],
               "type": "number"
            },
            "max_power": {
               "title": "Max Power",
               "examples": [],
               "type": "number"
            },
            "min_duration": {
               "title": "Min Duration",
               "type": "integer"
            },
            "max_duration": {
               "title": "Max Duration",
               "type": "integer"
            },
            "day_of_week": {
               "default": [],
               "type": "array",
               "items": {
                  "$ref": "#/definitions/DayOfWeek"
               }
            },
            "reservation": {
               "$ref": "#/definitions/ReservationRestrictionType"
            }
         }
      }
   }
}

Fields:

price_components (List[py_ocpi.modules.tariffs.v_2_2_1.schemas.PriceComponent])
restrictions (Optional[py_ocpi.modules.tariffs.v_2_2_1.schemas.TariffRestrictions])

field price_components: List[PriceComponent] [Required]¶

field restrictions: Optional[TariffRestrictions] = None¶

pydantic model py_ocpi.modules.tariffs.v_2_2_1.schemas.TariffRestrictions¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#146-tariffrestrictions-class

Show JSON schema

{
   "title": "TariffRestrictions",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#146-tariffrestrictions-class",
   "type": "object",
   "properties": {
      "start_time": {
         "title": "Start Time",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "end_time": {
         "title": "End Time",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "start_date": {
         "title": "Start Date",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "end_date": {
         "title": "End Date",
         "examples": [
            "String"
         ],
         "type": "string"
      },
      "min_kwh": {
         "title": "Min Kwh",
         "examples": [],
         "type": "number"
      },
      "max_kwh": {
         "title": "Max Kwh",
         "examples": [],
         "type": "number"
      },
      "min_current": {
         "title": "Min Current",
         "examples": [],
         "type": "number"
      },
      "max_current": {
         "title": "Max Current",
         "examples": [],
         "type": "number"
      },
      "min_power": {
         "title": "Min Power",
         "examples": [],
         "type": "number"
      },
      "max_power": {
         "title": "Max Power",
         "examples": [],
         "type": "number"
      },
      "min_duration": {
         "title": "Min Duration",
         "type": "integer"
      },
      "max_duration": {
         "title": "Max Duration",
         "type": "integer"
      },
      "day_of_week": {
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/DayOfWeek"
         }
      },
      "reservation": {
         "$ref": "#/definitions/ReservationRestrictionType"
      }
   },
   "definitions": {
      "DayOfWeek": {
         "title": "DayOfWeek",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#141-dayofweek-enum",
         "enum": [
            "MONDAY",
            "TUESDAY",
            "WEDNESDAY",
            "THURSDAY",
            "FRIDAY",
            "SATURDAY",
            "SUNDAY"
         ],
         "type": "string"
      },
      "ReservationRestrictionType": {
         "title": "ReservationRestrictionType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#143-reservationrestrictiontype-enum",
         "enum": [
            "RESERVATION",
            "RESERVATION_EXPIRES"
         ],
         "type": "string"
      }
   }
}

Fields:

day_of_week (List[py_ocpi.modules.tariffs.enums.DayOfWeek])
end_date (Optional[py_ocpi.core.data_types.String])
end_time (Optional[py_ocpi.core.data_types.String])
max_current (Optional[py_ocpi.core.data_types.Number])
max_duration (Optional[int])
max_kwh (Optional[py_ocpi.core.data_types.Number])
max_power (Optional[py_ocpi.core.data_types.Number])
min_current (Optional[py_ocpi.core.data_types.Number])
min_duration (Optional[int])
min_kwh (Optional[py_ocpi.core.data_types.Number])
min_power (Optional[py_ocpi.core.data_types.Number])
reservation (Optional[py_ocpi.modules.tariffs.v_2_2_1.enums.ReservationRestrictionType])
start_date (Optional[py_ocpi.core.data_types.String])
start_time (Optional[py_ocpi.core.data_types.String])

field day_of_week: List[DayOfWeek] = []¶

field end_date: Optional[String] = None¶

Constraints:

examples = [‘String’]

field end_time: Optional[String] = None¶

Constraints:

examples = [‘String’]

field max_current: Optional[Number] = None¶

Constraints:

examples = []

field max_duration: Optional[int] = None¶

field max_kwh: Optional[Number] = None¶

Constraints:

examples = []

field max_power: Optional[Number] = None¶

Constraints:

examples = []

field min_current: Optional[Number] = None¶

Constraints:

examples = []

field min_duration: Optional[int] = None¶

field min_kwh: Optional[Number] = None¶

Constraints:

examples = []

field min_power: Optional[Number] = None¶

Constraints:

examples = []

field reservation: Optional[ReservationRestrictionType] = None¶

field start_date: Optional[String] = None¶

Constraints:

examples = [‘String’]

field start_time: Optional[String] = None¶

Constraints:

examples = [‘String’]

Commands module¶

pydantic model py_ocpi.modules.commands.v_2_2_1.schemas.CancelReservation¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#131-cancelreservation-object

Show JSON schema

{
   "title": "CancelReservation",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#131-cancelreservation-object",
   "type": "object",
   "properties": {
      "response_url": {
         "title": "Response Url",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "reservation_id": {
         "title": "Reservation Id",
         "examples": [
            "string"
         ],
         "type": "string"
      }
   },
   "required": [
      "response_url",
      "reservation_id"
   ]
}

Fields:

reservation_id (py_ocpi.core.data_types.CiString)
response_url (py_ocpi.core.data_types.URL)

field reservation_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field response_url: URL [Required]¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

pydantic model py_ocpi.modules.commands.v_2_2_1.schemas.CommandResponse¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#132-commandresponse-object

Show JSON schema

{
   "title": "CommandResponse",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#132-commandresponse-object",
   "type": "object",
   "properties": {
      "result": {
         "$ref": "#/definitions/CommandResponseType"
      },
      "timeout": {
         "title": "Timeout",
         "type": "integer"
      },
      "message": {
         "title": "Message",
         "default": [],
         "type": "array",
         "items": {
            "type": "object",
            "examples": [
               {
                  "language": "en",
                  "text": "Standard Tariff"
               }
            ]
         }
      }
   },
   "required": [
      "result",
      "timeout"
   ],
   "definitions": {
      "CommandResponseType": {
         "title": "CommandResponseType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#141-commandresponsetype-enum",
         "enum": [
            "NOT_SUPPORTED",
            "REJECTED",
            "ACCEPTED",
            "UNKNOWN_SESSION"
         ],
         "type": "string"
      }
   }
}

Fields:

message (List[py_ocpi.core.data_types.DisplayText])
result (py_ocpi.modules.commands.v_2_2_1.enums.CommandResponseType)
timeout (int)

field message: List[DisplayText] = []¶

field result: CommandResponseType [Required]¶

field timeout: int [Required]¶

pydantic model py_ocpi.modules.commands.v_2_2_1.schemas.CommandResult¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#133-commandresult-object

Show JSON schema

{
   "title": "CommandResult",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#133-commandresult-object",
   "type": "object",
   "properties": {
      "result": {
         "$ref": "#/definitions/CommandResultType"
      },
      "message": {
         "title": "Message",
         "default": [],
         "type": "array",
         "items": {
            "type": "object",
            "examples": [
               {
                  "language": "en",
                  "text": "Standard Tariff"
               }
            ]
         }
      }
   },
   "required": [
      "result"
   ],
   "definitions": {
      "CommandResultType": {
         "title": "CommandResultType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#142-commandresulttype-enum",
         "enum": [
            "ACCEPTED",
            "CANCELED_RESERVATION",
            "EVSE_OCCUPIED",
            "EVSE_INOPERATIVE",
            "FAILED",
            "NOT_SUPPORTED",
            "REJECTED",
            "TIMEOUT",
            "UNKNOWN_RESERVATION"
         ],
         "type": "string"
      }
   }
}

Fields:

message (List[py_ocpi.core.data_types.DisplayText])
result (py_ocpi.modules.commands.v_2_2_1.enums.CommandResultType)

field message: List[DisplayText] = []¶

field result: CommandResultType [Required]¶

pydantic model py_ocpi.modules.commands.v_2_2_1.schemas.ReserveNow¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#134-reservenow-object

Show JSON schema

{
   "title": "ReserveNow",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#134-reservenow-object",
   "type": "object",
   "properties": {
      "response_url": {
         "title": "Response Url",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "token": {
         "$ref": "#/definitions/Token"
      },
      "expiry_date": {
         "title": "Expiry Date",
         "examples": [
            "2025-07-16T06:33:50Z"
         ],
         "type": "string"
      },
      "reservation_id": {
         "title": "Reservation Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "location_id": {
         "title": "Location Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "evse_uid": {
         "title": "Evse Uid",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "authorization_reference": {
         "title": "Authorization Reference",
         "examples": [
            "string"
         ],
         "type": "string"
      }
   },
   "required": [
      "response_url",
      "token",
      "expiry_date",
      "reservation_id",
      "location_id"
   ],
   "definitions": {
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      },
      "WhitelistType": {
         "title": "WhitelistType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#145-whitelisttype-enum",
         "enum": [
            "ALWAYS",
            "ALLOWED",
            "ALLOWED_OFFLINE",
            "NEVER"
         ],
         "type": "string"
      },
      "ProfileType": {
         "title": "ProfileType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#142-profiletype-enum",
         "enum": [
            "CHEAP",
            "FAST",
            "GREEN",
            "REGULAR"
         ],
         "type": "string"
      },
      "EnergyContract": {
         "title": "EnergyContract",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#142-energycontract-class",
         "type": "object",
         "properties": {
            "supplier_name": {
               "title": "Supplier Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "supplier_name"
         ]
      },
      "Token": {
         "title": "Token",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#132-token-object",
         "type": "object",
         "properties": {
            "country_code": {
               "title": "Country Code",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "party_id": {
               "title": "Party Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "uid": {
               "title": "Uid",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/TokenType"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "visual_number": {
               "title": "Visual Number",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "issuer": {
               "title": "Issuer",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "group_id": {
               "title": "Group Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "valid": {
               "title": "Valid",
               "type": "boolean"
            },
            "whitelist": {
               "$ref": "#/definitions/WhitelistType"
            },
            "language": {
               "title": "Language",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "default_profile_type": {
               "$ref": "#/definitions/ProfileType"
            },
            "energy_contract": {
               "$ref": "#/definitions/EnergyContract"
            },
            "last_updated": {
               "title": "Last Updated",
               "examples": [
                  "2025-07-16T06:33:50Z"
               ],
               "type": "string"
            }
         },
         "required": [
            "country_code",
            "party_id",
            "uid",
            "type",
            "contract_id",
            "issuer",
            "valid",
            "whitelist",
            "last_updated"
         ]
      }
   }
}

Fields:

authorization_reference (Optional[py_ocpi.core.data_types.CiString])
evse_uid (Optional[py_ocpi.core.data_types.CiString])
expiry_date (py_ocpi.core.data_types.DateTime)
location_id (py_ocpi.core.data_types.CiString)
reservation_id (py_ocpi.core.data_types.CiString)
response_url (py_ocpi.core.data_types.URL)
token (py_ocpi.modules.tokens.v_2_2_1.schemas.Token)

field authorization_reference: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field evse_uid: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field expiry_date: DateTime [Required]¶

Constraints:

examples = [‘2025-07-16T06:33:50Z’]

field location_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field reservation_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field response_url: URL [Required]¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

field token: Token [Required]¶

pydantic model py_ocpi.modules.commands.v_2_2_1.schemas.StartSession¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#135-startsession-object

Show JSON schema

{
   "title": "StartSession",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#135-startsession-object",
   "type": "object",
   "properties": {
      "response_url": {
         "title": "Response Url",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "token": {
         "$ref": "#/definitions/Token"
      },
      "location_id": {
         "title": "Location Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "evse_uid": {
         "title": "Evse Uid",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "connector_id": {
         "title": "Connector Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "authorization_reference": {
         "title": "Authorization Reference",
         "examples": [
            "string"
         ],
         "type": "string"
      }
   },
   "required": [
      "response_url",
      "token",
      "location_id"
   ],
   "definitions": {
      "TokenType": {
         "title": "TokenType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum",
         "enum": [
            "AD_HOC_USER",
            "APP_USER",
            "OTHER",
            "RFID"
         ],
         "type": "string"
      },
      "WhitelistType": {
         "title": "WhitelistType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#145-whitelisttype-enum",
         "enum": [
            "ALWAYS",
            "ALLOWED",
            "ALLOWED_OFFLINE",
            "NEVER"
         ],
         "type": "string"
      },
      "ProfileType": {
         "title": "ProfileType",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#142-profiletype-enum",
         "enum": [
            "CHEAP",
            "FAST",
            "GREEN",
            "REGULAR"
         ],
         "type": "string"
      },
      "EnergyContract": {
         "title": "EnergyContract",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#142-energycontract-class",
         "type": "object",
         "properties": {
            "supplier_name": {
               "title": "Supplier Name",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "String"
               ],
               "type": "string"
            }
         },
         "required": [
            "supplier_name"
         ]
      },
      "Token": {
         "title": "Token",
         "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#132-token-object",
         "type": "object",
         "properties": {
            "country_code": {
               "title": "Country Code",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "party_id": {
               "title": "Party Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "uid": {
               "title": "Uid",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "type": {
               "$ref": "#/definitions/TokenType"
            },
            "contract_id": {
               "title": "Contract Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "visual_number": {
               "title": "Visual Number",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "issuer": {
               "title": "Issuer",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "group_id": {
               "title": "Group Id",
               "examples": [
                  "string"
               ],
               "type": "string"
            },
            "valid": {
               "title": "Valid",
               "type": "boolean"
            },
            "whitelist": {
               "$ref": "#/definitions/WhitelistType"
            },
            "language": {
               "title": "Language",
               "examples": [
                  "String"
               ],
               "type": "string"
            },
            "default_profile_type": {
               "$ref": "#/definitions/ProfileType"
            },
            "energy_contract": {
               "$ref": "#/definitions/EnergyContract"
            },
            "last_updated": {
               "title": "Last Updated",
               "examples": [
                  "2025-07-16T06:33:50Z"
               ],
               "type": "string"
            }
         },
         "required": [
            "country_code",
            "party_id",
            "uid",
            "type",
            "contract_id",
            "issuer",
            "valid",
            "whitelist",
            "last_updated"
         ]
      }
   }
}

Fields:

authorization_reference (Optional[py_ocpi.core.data_types.CiString])
connector_id (Optional[py_ocpi.core.data_types.CiString])
evse_uid (Optional[py_ocpi.core.data_types.CiString])
location_id (py_ocpi.core.data_types.CiString)
response_url (py_ocpi.core.data_types.URL)
token (py_ocpi.modules.tokens.v_2_2_1.schemas.Token)

field authorization_reference: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field connector_id: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field evse_uid: Optional[CiString] = None¶

Constraints:

examples = [‘string’]

field location_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field response_url: URL [Required]¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

field token: Token [Required]¶

pydantic model py_ocpi.modules.commands.v_2_2_1.schemas.StopSession¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#136-stopsession-object

Show JSON schema

{
   "title": "StopSession",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#136-stopsession-object",
   "type": "object",
   "properties": {
      "response_url": {
         "title": "Response Url",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "session_id": {
         "title": "Session Id",
         "examples": [
            "string"
         ],
         "type": "string"
      }
   },
   "required": [
      "response_url",
      "session_id"
   ]
}

Fields:

response_url (py_ocpi.core.data_types.URL)
session_id (py_ocpi.core.data_types.CiString)

field response_url: URL [Required]¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

field session_id: CiString [Required]¶

Constraints:

examples = [‘string’]

pydantic model py_ocpi.modules.commands.v_2_2_1.schemas.UnlockConnector¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#137-unlockconnector-object

Show JSON schema

{
   "title": "UnlockConnector",
   "description": "https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#137-unlockconnector-object",
   "type": "object",
   "properties": {
      "response_url": {
         "title": "Response Url",
         "examples": [
            "http://www.w3.org/Addressing/URL/uri-spec.html"
         ],
         "type": "string"
      },
      "location_id": {
         "title": "Location Id",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "evse_uid": {
         "title": "Evse Uid",
         "examples": [
            "string"
         ],
         "type": "string"
      },
      "connector_id": {
         "title": "Connector Id",
         "examples": [
            "string"
         ],
         "type": "string"
      }
   },
   "required": [
      "response_url",
      "location_id",
      "evse_uid",
      "connector_id"
   ]
}

Fields:

connector_id (py_ocpi.core.data_types.CiString)
evse_uid (py_ocpi.core.data_types.CiString)
location_id (py_ocpi.core.data_types.CiString)
response_url (py_ocpi.core.data_types.URL)

field connector_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field evse_uid: CiString [Required]¶

Constraints:

examples = [‘string’]

field location_id: CiString [Required]¶

Constraints:

examples = [‘string’]

field response_url: URL [Required]¶

Constraints:

examples = [’http://www.w3.org/Addressing/URL/uri-spec.html’]

Enums¶

Credentials module¶

Locations module¶

class py_ocpi.modules.locations.v_2_2_1.enums.Capability(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#143-capability-enum

charging_preferences_capable = 'CHARGING_PREFERENCES_CAPABLE'¶

charging_profile_capable = 'CHARGING_PROFILE_CAPABLE'¶

chip_card_support = 'CHIP_CARD_SUPPORT'¶

contactless_card_support = 'CONTACTLESS_CARD_SUPPORT'¶

credit_card_payable = 'CREDIT_CARD_PAYABLE'¶

debit_card_payable = 'DEBIT_CARD_PAYABLE'¶

ped_terminal = 'PED_TERMINAL'¶

remote_start_stop_capable = 'REMOTE_START_STOP_CAPABLE'¶

reservable = 'RESERVABLE'¶

rfid_reader = 'RFID_READER'¶

start_session_connector_required = 'START_SESSION_CONNECTOR_REQUIRED'¶

token_group_capable = 'TOKEN_GROUP_CAPABLE'¶

unlook_capable = 'UNLOCK_CAPABLE'¶

class py_ocpi.modules.locations.v_2_2_1.enums.ConnectorType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#145-connectortype-enum

chademo = 'CHADEMO'¶

chaoji = 'CHAOJI'¶

domestic_a = 'DOMESTIC_A'¶

domestic_b = 'DOMESTIC_B'¶

domestic_c = 'DOMESTIC_C'¶

domestic_d = 'DOMESTIC_D'¶

domestic_e = 'DOMESTIC_E'¶

domestic_f = 'DOMESTIC_F'¶

domestic_g = 'DOMESTIC_G'¶

domestic_h = 'DOMESTIC_H'¶

domestic_i = 'DOMESTIC_I'¶

domestic_j = 'DOMESTIC_J'¶

domestic_k = 'DOMESTIC_K'¶

domestic_l = 'DOMESTIC_L'¶

domestic_m = 'DOMESTIC_M'¶

domestic_n = 'DOMESTIC_N'¶

domestic_o = 'DOMESTIC_O'¶

gbt_ac = 'GBT_AC'¶

gbt_dc = 'GBT_DC'¶

iec_60309_2_single_16 = 'IEC_60309_2_single_16'¶

iec_60309_2_three_16 = 'IEC_60309_2_three_16'¶

iec_60309_2_three_32 = 'IEC_60309_2_three_32'¶

iec_60309_2_three_64 = 'IEC_60309_2_three_64'¶

iec_62196_t1 = 'IEC_62196_T1'¶

iec_62196_t1_combo = 'IEC_62196_T1_COMBO'¶

iec_62196_t2 = 'IEC_62196_T2'¶

iec_62196_t2_combo = 'IEC_62196_T2_COMBO'¶

iec_62196_t3a = 'IEC_62196_T3A'¶

iec_62196_t3c = 'IEC_62196_T3C'¶

nema_10_30 = 'NEMA_10_30'¶

nema_10_50 = 'NEMA_10_50'¶

nema_14_30 = 'NEMA_14_30'¶

nema_14_50 = 'NEMA_14_50'¶

nema_5_20 = 'NEMA_5_20'¶

nema_6_30 = 'NEMA_6_30'¶

nema_6_50 = 'NEMA_6_50'¶

pantograph_bottom_up = 'PANTOGRAPH_BOTTOM_UP'¶

pantograph_top_down = 'PANTOGRAPH_TOP_DOWN'¶

tesla_r = 'TESLA_R'¶

tesla_s = 'TESLA_S'¶

class py_ocpi.modules.locations.v_2_2_1.enums.Facility(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1412-facility-enum

airport = 'AIRPORT'¶

bike_sharing = 'BIKE_SHARING'¶

bus_stop = 'BUS_STOP'¶

cafe = 'CAFE'¶

carpool_parking = 'CARPOOL_PARKING'¶

fuel_station = 'FUEL_STATION'¶

hotel = 'HOTEL'¶

mall = 'MALL'¶

metro_station = 'METRO_STATION'¶

museum = 'MUSEUM'¶

nature = 'NATURE'¶

parking_lot = 'PARKING_LOT'¶

recreation_area = 'RECREATION_AREA'¶

restaurant = 'RESTAURANT'¶

sport = 'SPORT'¶

supermarket = 'SUPERMARKET'¶

taxi_stand = 'TAXI_STAND'¶

train_station = 'TRAIN_STATION'¶

tram_shop = 'TRAM_STOP'¶

wifi = 'WIFI'¶

class py_ocpi.modules.locations.v_2_2_1.enums.ParkingType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1418-parkingtype-enum

along_motorway = 'ALONG_MOTORWAY'¶

on_driveway = 'ON_DRIVEWAY'¶

on_street = 'ON_STREET'¶

parking_garage = 'PARKING_GARAGE'¶

parking_lot = 'PARKING_LOT'¶

underground_garage = 'UNDERGROUND_GARAGE'¶

class py_ocpi.modules.locations.v_2_2_1.enums.PowerType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1419-powertype-enum

ac_1_phase = 'AC_1_PHASE'¶

ac_2_phase = 'AC_2_PHASE'¶

ac_2_phase_split = 'AC_2_PHASE_SPLIT'¶

ac_3_phase = 'AC_3_PHASE'¶

dc = 'DC'¶

class py_ocpi.modules.locations.enums.ConnectorFormat(value)

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#144-connectorformat-enum

cable = 'CABLE'

socket = 'SOCKET'

class py_ocpi.modules.locations.enums.EnergySourceCategory(value)

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#148-energysourcecategory-enum

coal = 'COAL'

gas = 'GAS'

general_fossil = 'GENERAL_FOSSIL'

general_green = 'GENERAL_GREEN'

nuclear = 'NUCLEAR'

solar = 'SOLAR'

water = 'WATER'

wind = 'WIND'

class py_ocpi.modules.locations.enums.EnvironmentalImpactCategory(value)

https://github.com/ocpi/ocpi/blob/2.2.1/mod_locations.asciidoc#1410-environmentalimpactcategory-enum

carbon_dioxide = 'CARBON_DIOXIDE'

nuclear_waste = 'NUCLEAR_WASTE'

class py_ocpi.modules.locations.enums.ImageCategory(value)

https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#415-imagecategory-enum

charger = 'CHARGER'

entrance = 'ENTRANCE'

location = 'LOCATION'

network = 'NETWORK'

operator = 'OPERATOR'

other = 'OTHER'

owner = 'OWNER'

class py_ocpi.modules.locations.enums.ParkingRestriction(value)

https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#417-parkingrestriction-enum

customers = 'CUSTOMERS'

disables = 'DISABLED'

ev_only = 'EV_ONLY'

motorcycle = 'MOTORCYCLES'

plugged = 'PLUGGED'

class py_ocpi.modules.locations.enums.Status(value)

https://github.com/ocpi/ocpi/blob/release-2.1.1-bugfixes/mod_locations.md#420-status-enum

available = 'AVAILABLE'

blocked = 'BLOCKED'

charging = 'CHARGING'

inoperative = 'INOPERATIVE'

outoforder = 'OUTOFORDER'

planned = 'PLANNED'

removed = 'REMOVED'

reserved = 'RESERVED'

unknown = 'UNKNOWN'

CDRs module¶

class py_ocpi.modules.cdrs.v_2_2_1.enums.AuthMethod(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#141-authmethod-enum

auth_request = 'AUTH_REQUEST'¶

command = 'COMMAND'¶

whitelist = 'WHITELIST'¶

class py_ocpi.modules.cdrs.v_2_2_1.enums.CdrDimensionType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_cdrs.asciidoc#143-cdrdimensiontype-enum

current = 'CURRENT'¶

energy = 'ENERGY'¶

energy_export = 'ENERGY_EXPORT'¶

energy_import = 'ENERGY_IMPORT'¶

max_current = 'MAX_CURRENT'¶

max_power = 'MAX_POWER'¶

min_current = 'MIN_CURRENT'¶

min_power = 'MIN_POWER'¶

parking_time = 'PARKING_TIME'¶

power = 'POWER'¶

reservation_time = 'RESERVATION_TIME'¶

state_of_change = 'STATE_OF_CHARGE'¶

time = 'TIME'¶

Sessions module¶

class py_ocpi.modules.sessions.v_2_2_1.enums.ChargingPreferencesResponse(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#141-chargingpreferencesresponse-enum

accepted = 'ACCEPTED'¶

departure_required = 'DEPARTURE_REQUIRED'¶

energy_need_required = 'ENERGY_NEED_REQUIRED'¶

not_possible = 'NOT_POSSIBLE'¶

profile_type_not_supported = 'PROFILE_TYPE_NOT_SUPPORTED'¶

class py_ocpi.modules.sessions.v_2_2_1.enums.ProfileType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#142-profiletype-enum

cheap = 'CHEAP'¶

fast = 'FAST'¶

green = 'GREEN'¶

regular = 'REGULAR'¶

class py_ocpi.modules.sessions.v_2_2_1.enums.SessionStatus(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_sessions.asciidoc#143-sessionstatus-enum

active = 'ACTIVE'¶

completed = 'COMPLETED'¶

invalid = 'INVALID'¶

pending = 'PENDING'¶

reservation = 'RESERVATION'¶

Tokens module¶

class py_ocpi.modules.tokens.v_2_2_1.enums.AllowedType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#141-allowedtype-enum

allowed = 'ALLOWED'¶

blocked = 'BLOCKED'¶

expired = 'EXPIRED'¶

no_credit = 'NO_CREDIT'¶

not_allowed = 'NOT_ALLOWED'¶

class py_ocpi.modules.tokens.v_2_2_1.enums.TokenType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#144-tokentype-enum

ad_hoc_user = 'AD_HOC_USER'¶

app_user = 'APP_USER'¶

other = 'OTHER'¶

rfid = 'RFID'¶

class py_ocpi.modules.tokens.v_2_2_1.enums.WhitelistType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tokens.asciidoc#145-whitelisttype-enum

allowed = 'ALLOWED'¶

allowed_offline = 'ALLOWED_OFFLINE'¶

always = 'ALWAYS'¶

never = 'NEVER'¶

Tariffs module¶

class py_ocpi.modules.tariffs.v_2_2_1.enums.ReservationRestrictionType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#143-reservationrestrictiontype-enum

reservation = 'RESERVATION'¶

reservation_expires = 'RESERVATION_EXPIRES'¶

class py_ocpi.modules.tariffs.v_2_2_1.enums.TariffDimensionType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#145-tariffdimensiontype-enum

energy = 'ENERGY'¶

flat = 'FLAT'¶

parking_time = 'PARKING_TIME'¶

time = 'TIME'¶

class py_ocpi.modules.tariffs.v_2_2_1.enums.TariffType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#147-tarifftype-enum

ad_hoc_payment = 'AD_HOC_PAYMENT'¶

profile_cheap = 'PROFILE_CHEAP'¶

profile_fast = 'PROFILE_FAST'¶

profile_green = 'PROFILE_GREEN'¶

regular = 'REGULAR'¶

class py_ocpi.modules.tariffs.enums.DayOfWeek(value)

https://github.com/ocpi/ocpi/blob/2.2.1/mod_tariffs.asciidoc#141-dayofweek-enum

friday = 'FRIDAY'

monday = 'MONDAY'

saturday = 'SATURDAY'

sunday = 'SUNDAY'

thursday = 'THURSDAY'

tuesday = 'TUESDAY'

wednesday = 'WEDNESDAY'

Commands module¶

class py_ocpi.modules.commands.v_2_2_1.enums.CommandResponseType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#141-commandresponsetype-enum

accepted = 'ACCEPTED'¶

not_supported = 'NOT_SUPPORTED'¶

rejected = 'REJECTED'¶

unknown_session = 'UNKNOWN_SESSION'¶

class py_ocpi.modules.commands.v_2_2_1.enums.CommandResultType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#142-commandresulttype-enum

accepted = 'ACCEPTED'¶

canceled_reservation = 'CANCELED_RESERVATION'¶

evse_inoperative = 'EVSE_INOPERATIVE'¶

evse_occupied = 'EVSE_OCCUPIED'¶

failed = 'FAILED'¶

not_supported = 'NOT_SUPPORTED'¶

rejected = 'REJECTED'¶

timeout = 'TIMEOUT'¶

unknown_reservation = 'UNKNOWN_RESERVATION'¶

class py_ocpi.modules.commands.v_2_2_1.enums.CommandType(value)¶

https://github.com/ocpi/ocpi/blob/2.2.1/mod_commands.asciidoc#143-commandtype-enum

cancel_reservation = 'CANCEL_RESERVATION'¶

reserve_now = 'RESERVE_NOW'¶

start_session = 'START_SESSION'¶

stop_session = 'STOP_SESSION'¶

unlock_connector = 'UNLOCK_CONNECTOR'¶

Hub client info module¶

class py_ocpi.modules.hubclientinfo.v_2_2_1.enums.ConnectionStatus(value)¶

https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_hub_client_info.asciidoc#151-connectionstatus-enum

connected = 'CONNECTED'¶

offline = 'OFFLINE'¶

planned = 'PLANNED'¶

suspended = 'SUSPENDED'¶

Charging profile module¶

class py_ocpi.modules.chargingprofiles.v_2_2_1.enums.ChargingProfileResponseType(value)¶

https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_charging_profiles.asciidoc#165-chargingprofileresponsetype-enum

accepted = 'ACCEPTED'¶

not_supported = 'NOT_SUPPORTED'¶

rejected = 'REJECTED'¶

too_often = 'TOO_OFTEN'¶

unknown_session = 'UNKNOWN_SESSION'¶

class py_ocpi.modules.chargingprofiles.v_2_2_1.enums.ChargingProfileResultType(value)¶

https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_charging_profiles.asciidoc#166-chargingprofileresulttype-enum

accepted = 'ACCEPTED'¶

rejected = 'REJECTED'¶

unknown = 'UNKNOWN'¶

class py_ocpi.modules.chargingprofiles.v_2_2_1.enums.ChargingRateUnit(value)¶

https://github.com/ocpi/ocpi/blob/release-2.2.1-bugfixes/mod_charging_profiles.asciidoc#162-chargingrateunit-enum

amperes = 'A'¶

watts = 'W'¶