{"openapi":"3.1.0","info":{"title":"VOLTERAS CONNECT","version":"0.1.0"},"servers":[{"url":"https://api.volteras.com"},{"url":"https://api.sandbox.volteras.com"}],"paths":{"/v1/oauth2/token":{"post":{"tags":["Authentication"],"summary":"Auth Token","description":"Obtain OAuth 2.0 access token. This endpoint follows the OAuth 2.0 industry-standard protocol for authorization.\nIt performs authorization and returns the access token and refresh token.\n\nTo use, pass the `grant_type` in the form data, which will be:\n- `client_credentials` grant type to authenticate with `client_id` and `client_secret`.\n- `refresh_token` grant type to refresh an existing token.\n\nIf using `client_credentials` grant type, please use HTTP Basic Auth to pass the credentials\n(with the username being the `client_id` and the password being the `client_secret`).\n\nThe `client_id` and `client_secret` can be passed in the form data, but this is deprecated and\nnot recommended.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- SERVER_ERROR","operationId":"auth_token_v1_oauth2_token_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_auth_token_v1_oauth2_token_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIAccessToken"}}}}},"security":[{"HTTPBasic":[]}],"x-list-error-codes":[]}},"/v1/oauth2/test-token":{"post":{"tags":["Authentication"],"summary":"Test Token","description":"This endpoint validates the access token and retrieves the associated `clientId` and `organizationId`.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- SERVER_ERROR","operationId":"test_token_v1_oauth2_test_token_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIAccess"}}}}},"security":[{"OAuth2ClientCredentialsBearer":[]}],"x-list-error-codes":[]}},"/v1/accounts":{"get":{"tags":["Accounts"],"summary":"List Accounts","description":"Retrieve a paginated list of active accounts associated with the current organization.\n\n_Find details on list filter syntax in our documentation [here](/overview/listing-filter-json)._\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- PAGE_SIZE_TOO_LARGE\n- PAGINATED_QUERY_FILTER_CHANGED\n- REQUEST_VALIDATION_ERROR\n- SERVER_ERROR","operationId":"list_accounts_v1_accounts_get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"maxPageSize","in":"query","required":false,"schema":{"type":"integer","title":"Max page size","description":"Max size of the returned list."},"description":"Max size of the returned list."},{"name":"pageToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page token","description":"Page token used for pagination."},"description":"Page token used for pagination."},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","contentMediaType":"application/json","contentSchema":{}},{"type":"null"}],"title":"Filter","description":"Listing filter schema."},"description":"Listing filter schema."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_OEMAccount_"}}}}},"x-list-error-codes":["PAGINATED_QUERY_FILTER_CHANGED","PAGE_SIZE_TOO_LARGE"]}},"/v1/accounts/{account_id}":{"get":{"tags":["Accounts"],"summary":"Get Account","description":"Retrieve account details by providing its unique identifier.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_account_v1_accounts__account_id__get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account ID","description":"ID of the account."},"description":"ID of the account."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OEMAccount"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/accounts:connect":{"post":{"tags":["Accounts"],"summary":"Action Connect","description":"Generate a URL to initiate the account connection flow, which allows users to connect their accounts.\nThe generated URL is active for a **one-hour period**. If not authenticated within this timeframe, the link will become invalid.\n\nAfter the connection flow is completed, the device owner is redirected to the provided return URL with the following parameters:\n- `result` indicating success or failure.\n- `accountId` representing the ID of the connected account.\n\nFor further customization and integration details, consider the following resources:\n- See the [Scopes documentation](/overview/scopes) for information on how to utilize scopes in your integration.\n- See the [Regions documentation](/overview/regions) for guidelines on setting geographic regions.\n\nYou can also connect a single vehicle using the VIN upload flow. Pass the VIN, and (if available) the model and model year.\nThis will generate a consent flow link that's dedicated to uploading a single vehicle.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- DEVICE_LIMIT_REACHED\n- NOT_PERMITTED\n- REQUEST_VALIDATION_ERROR\n- SERVER_ERROR\n- UNSUPPORTED_OEM","operationId":"action_connect_v1_accounts_connect_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountConnectPayload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountConnect"}}}}},"security":[{"OAuth2ClientCredentialsBearer":[]}],"x-list-error-codes":["NOT_PERMITTED","DEVICE_LIMIT_REACHED","UNSUPPORTED_OEM"]}},"/v1/accounts/{account_id}:disconnect":{"post":{"tags":["Accounts"],"summary":"Action Disconnect","description":"This endpoint allows you to disconnect an account.\nUpon successful disconnection, the account's connection is terminated.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"action_disconnect_v1_accounts__account_id__disconnect_post","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"account_id","in":"path","required":true,"schema":{"type":"string","title":"Account ID","description":"ID of the account."},"description":"ID of the account."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/tags":{"post":{"tags":["Tags"],"summary":"Add Tag To Entity","description":"Create a new tag attached to the object specified inside the tag body.\nA tag is a key-value pair that can be attached to specific objects, currently vehicles or batteries.\nThis can be used to categorize those objects and link them back to objects in your system.\n\nFor example, if you wanted to add a fleet id to a vehicle, you could pass a tag\nwith key \"fleet_id\" and then the id value, set the entityType to \"DEVICE\",\nand pass, as the entityId, the ID of the vehicle you want to tag.\n\nThis would tag that vehicle with the fleet_id \"1234\", and you could query in the list vehicles endpoint for\nvehicles with that tag.\n\nThe entity types that can be currently passed are:\n- `DEVICE`\n\n**Returns:**\n- A response with an empty body and a 200 status code\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"add_tag_to_entity_v1_tags_post","security":[{"OAuth2ClientCredentialsBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicTagCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]},"delete":{"tags":["Tags"],"summary":"Remove Tag From Entity","description":"Remove a tag with the specified key and value from the specified object.\nPlease see the Add Tag endpoint for more information on tags.\n\n**Returns:**\n- A response with an empty body and a 200 status code\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"remove_tag_from_entity_v1_tags_delete","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"key","in":"query","required":true,"schema":{"type":"string","maxLength":150,"title":"Key"}},{"name":"value","in":"query","required":true,"schema":{"type":"string","maxLength":150,"title":"Value"}},{"name":"entityType","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PublicTagEntityTypes"}},{"name":"entityId","in":"query","required":true,"schema":{"type":"string","title":"Entityid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/tags/{entity_type}/{entity_id}":{"get":{"tags":["Tags"],"summary":"Get Tags","description":"Get all tags for the specified object.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_tags_v1_tags__entity_type___entity_id__get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","title":"Entity Id"}},{"name":"entity_type","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PublicTagEntityTypes"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsList"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles":{"get":{"tags":["Vehicles"],"summary":"List Vehicles","description":"Retrieve a paginated list of vehicles associated with your organization.\n\nThe endpoint lists vehicles based on the following criteria:\n- Includes only vehicles that have enabled synchronization during the account connection process.\n- Excludes disconnected vehicles or those not included in the OEM account.\n\n**Returns:**\n- A paginated response containing a list of vehicles.\n\n**Note:**\n- This endpoint provides a summary of each vehicle's basic details. For comprehensive vehicle data, please refer to the individual vehicle detail endpoints.\n\n_Find details on list filter syntax in our documentation [here](/overview/listing-filter-json)._\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- PAGE_SIZE_TOO_LARGE\n- PAGINATED_QUERY_FILTER_CHANGED\n- REQUEST_VALIDATION_ERROR\n- SERVER_ERROR","operationId":"list_vehicles_v1_vehicles_get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"maxPageSize","in":"query","required":false,"schema":{"type":"integer","title":"Max page size","description":"Max size of the returned list."},"description":"Max size of the returned list."},{"name":"pageToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page token","description":"Page token used for pagination."},"description":"Page token used for pagination."},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","contentMediaType":"application/json","contentSchema":{}},{"type":"null"}],"title":"Filter","description":"Listing filter schema."},"description":"Listing filter schema."},{"name":"tagKey","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tagkey"}},{"name":"tagValue","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tagvalue"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Vehicle_"}}}}},"x-list-error-codes":["PAGINATED_QUERY_FILTER_CHANGED","PAGE_SIZE_TOO_LARGE"]}},"/v1/vehicles/{vehicle_id}":{"get":{"tags":["Vehicles"],"summary":"Get Vehicle","description":"Retrieve detailed information about a vehicle by specifying its unique identifier (ID).\n\n**Returns:**\n- A response containing detailed information about the vehicle.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_v1_vehicles__vehicle_id__get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vehicle"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]},"delete":{"tags":["Vehicle Connection"],"summary":"Action Disconnect","description":"This endpoint allows you to disconnect a specific vehicle from your organization, ceasing the synchronization of its data.\nAfter disconnection, the vehicle will no longer be accessible through your organization's account.\nNote that it can take a few minutes for the disconnection to be processed.\n\n**Note:**\n- Disconnecting a vehicle is an irreversible action, and the vehicle's data will no longer be synchronized with your organization.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"action_disconnect_v1_vehicles__vehicle_id__delete","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"202":{"description":"Accepted"}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/options":{"get":{"tags":["Vehicles"],"summary":"Get Vehicle Options","description":"Retrieves the options data for a specific Tesla vehicle based on its unique identifier (ID).\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to retrieve the options.\n\n**Returns:**\n- A response containing options data for the vehicle.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n- UNSUPPORTED_OEM","operationId":"get_vehicle_options_v1_vehicles__vehicle_id__options_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:information"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOptions"}}}}},"x-list-error-codes":["UNSUPPORTED_OEM","RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/registration-plate":{"post":{"tags":["Vehicles"],"summary":"Update Registration Plate","description":"Update the registration plate of the specified vehicle.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to update.\n\n**Returns:**\n- A response containing the updated vehicle information.\n\n**Note:**\n- The `vehicle_id` should correspond to a valid and existing vehicle identifier.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"update_registration_plate_v1_vehicles__vehicle_id__registration_plate_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:information"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleUpdateRegistration"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Vehicle"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/specifications":{"get":{"tags":["Vehicles"],"summary":"Get Vehicle Specifications","description":"Obtain detailed specifications for a vehicle.\n\nThis endpoint allows you to retrieve more detailed specifications (if available) for a specific vehicle identified by its unique 'vehicle_id'.\n\n**Note:**\n- Detailed specifications rely on the trim of the vehicle being identified. This requires the registration country\nof the vehicle to be known and to be one we hold specification data for, currently Canada, France, Germany,\nIreland, Italy, Spain, the United Kingdom, and the United States. Vehicles registered elsewhere may not have\nspecifications available.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_specifications_v1_vehicles__vehicle_id__specifications_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:information"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleSpecifications"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/telemetry":{"get":{"tags":["Vehicle Telemetry"],"summary":"Get Vehicle Telemetry","description":"Retrieve telemetry data for the specified vehicle. The telemetry data provides essential information about the vehicle's status and performance.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to retrieve telemetry data for.\n\n**Returns:**\n- Telemetry data for the vehicle.\n\nTelemetry Information returned might include:\n- Odometer: The total distance traveled by the vehicle, recorded in kilometers. The timestamp indicates when the odometer reading was taken.\n- Location: The current latitude and longitude coordinates of the vehicle's position on Earth's surface. The timestamp indicates when the location reading was captured.\n- Elevation: The vehicle's altitude above sea level, measured in meters. The timestamp shows when the elevation reading was recorded.\n- State of Charge: The battery's state of charge, expressed as a percentage. The timestamp indicates when the charge level was last updated.\n- Charging State: Indicates whether the vehicle is actively charging or not. The timestamp reveals the time of the charging state observation.\n- Range: The estimated driving range of the vehicle on its current battery charge, provided in kilometers. The timestamp shows when the range reading was taken.\n\n**Note:**\n- The `vehicle_id` should correspond to a valid and existing vehicle identifier.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_telemetry_v1_vehicles__vehicle_id__telemetry_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:telemetry"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleTelemetry"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/command-executions":{"get":{"tags":["Vehicle Command Executions"],"summary":"List Vehicle Command Executions","description":"Retrieve a paginated list of vehicle command executions for specific vehicle based on its unique identifier (ID).\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to retrieve the command executions.\n\n**Returns:**\n- A paginated response containing a list of vehicle command executions.\n\n_Find details on list filter syntax in our documentation [here](/overview/listing-filter-json)._\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- PAGE_SIZE_TOO_LARGE\n- PAGINATED_QUERY_FILTER_CHANGED\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"list_vehicle_command_executions_v1_vehicles__vehicle_id__command_executions_get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."},{"name":"maxPageSize","in":"query","required":false,"schema":{"type":"integer","title":"Max page size","description":"Max size of the returned list."},"description":"Max size of the returned list."},{"name":"pageToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page token","description":"Page token used for pagination."},"description":"Page token used for pagination."},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","contentMediaType":"application/json","contentSchema":{}},{"type":"null"}],"title":"Filter","description":"Listing filter schema."},"description":"Listing filter schema."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_VehicleCommandExecution_"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","PAGINATED_QUERY_FILTER_CHANGED","PAGE_SIZE_TOO_LARGE"]}},"/v1/vehicles/{vehicle_id}/command-executions/{vehicle_command_execution_id}":{"get":{"tags":["Vehicle Command Executions"],"summary":"Get Vehicle Command Execution","description":"Retrieve detailed information about a vehicle command execution by specifying its unique identifier (ID).\n\n **Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle.\n- `vehicle_command_execution_id`: The unique identifier (ID) of the vehicle command execution.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_command_execution_v1_vehicles__vehicle_id__command_executions__vehicle_command_execution_id__get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"vehicle_command_execution_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle command execution ID","description":"ID of the vehicle command execution."},"description":"ID of the vehicle command execution."},{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/command-execution:actuate-front-trunk":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Actuate Front Trunk","description":"Create a `ACTUATE_FRONT_TRUNK` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `ACTUATE_FRONT_TRUNK` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_actuate_front_trunk_v1_vehicles__vehicle_id__command_execution_actuate_front_trunk_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:actuate-rear-trunk":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Actuate Rear Trunk","description":"Create a `ACTUATE_REAR_TRUNK` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `ACTUATE_REAR_TRUNK` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_actuate_rear_trunk_v1_vehicles__vehicle_id__command_execution_actuate_rear_trunk_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:climate-off":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Climate Off","description":"Create a `CLIMATE_OFF` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `CLIMATE_OFF` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_climate_off_v1_vehicles__vehicle_id__command_execution_climate_off_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:climate-on":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Climate On","description":"Create a `CLIMATE_ON` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `CLIMATE_ON` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_climate_on_v1_vehicles__vehicle_id__command_execution_climate_on_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:close-charge-port":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Close Charge Port","description":"Create a `CLOSE_CHARGE_PORT` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `CLOSE_CHARGE_PORT` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_close_charge_port_v1_vehicles__vehicle_id__command_execution_close_charge_port_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:lock-doors":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Lock Doors","description":"Create a `LOCK_DOORS` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `LOCK_DOORS` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_lock_doors_v1_vehicles__vehicle_id__command_execution_lock_doors_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:open-charge-port":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Open Charge Port","description":"Create a `OPEN_CHARGE_PORT` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `OPEN_CHARGE_PORT` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_open_charge_port_v1_vehicles__vehicle_id__command_execution_open_charge_port_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:set-charge-limit":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Set Charge Limit","description":"Create a `SET_CHARGE_LIMIT` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `SET_CHARGE_LIMIT` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_set_charge_limit_v1_vehicles__vehicle_id__command_execution_set_charge_limit_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetChargeLimitPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:set-temperature":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Set Temperature","description":"Create a `SET_TEMPERATURE` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `SET_TEMPERATURE` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_set_temperature_v1_vehicles__vehicle_id__command_execution_set_temperature_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetTemperaturePayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:start-charging":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Start Charging","description":"Create a `START_CHARGING` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `START_CHARGING` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_start_charging_v1_vehicles__vehicle_id__command_execution_start_charging_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:start-hvac-system":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Start Hvac System","description":"Create a `START_HVAC_SYSTEM` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `START_HVAC_SYSTEM` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_start_hvac_system_v1_vehicles__vehicle_id__command_execution_start_hvac_system_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:stop-charging":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Stop Charging","description":"Create a `STOP_CHARGING` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `STOP_CHARGING` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_stop_charging_v1_vehicles__vehicle_id__command_execution_stop_charging_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/command-execution:unlock-doors":{"post":{"tags":["Vehicle Command Executions"],"summary":"Action Unlock Doors","description":"Create a `UNLOCK_DOORS` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- COMMAND_ALREADY_IN_PROGRESS\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR\n\nCreate a `UNLOCK_DOORS` command execution.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to execute the command.\n\n**Returns:**\n- A response containing detailed information about the vehicle command execution.","operationId":"action_unlock_doors_v1_vehicles__vehicle_id__command_execution_unlock_doors_post","security":[{"OAuth2ClientCredentialsBearer":["vehicle:commands"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleCommandExecution"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","COMMAND_ALREADY_IN_PROGRESS"]}},"/v1/vehicles/{vehicle_id}/listening":{"post":{"tags":["Vehicle Listening"],"summary":"Set Vehicle Listening State","description":"Set the listening state for a vehicle.\n\nThe listening state controls whether a vehicle can:\n* Process incoming data stream messages\n* Accept remote commands\n* Fetch data from OEM endpoints\n\nRequirements:\n* Vehicle must belong to the authenticated organization\n* Request will update the vehicle's desired listening state\n\nIf the vehicle is already in the requested listening state, the request is a\nno-op: no new audit entry is recorded and a 200 response is returned with the\ncurrent state.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"Set_Vehicle_Listening_State_v1_vehicles__vehicle_id__listening_post","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleListeningRequest"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleListeningResponse"}}}},"200":{"description":"The vehicle is already in the requested listening state; no change was made.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleListeningResponse"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/listening-audit":{"get":{"tags":["Vehicle Listening"],"summary":"Get Vehicle Listening Audit","description":"Retrieve the listening-state history for a vehicle, ordered by the time entries were recorded.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- PAGE_SIZE_TOO_LARGE\n- PAGINATED_QUERY_FILTER_CHANGED\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_listening_audit_v1_vehicles__vehicle_id__listening_audit_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:information"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."},{"name":"startAt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Startat"}},{"name":"endAt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Endat"}},{"name":"maxPageSize","in":"query","required":false,"schema":{"type":"integer","title":"Max page size","description":"Max size of the returned list."},"description":"Max size of the returned list."},{"name":"pageToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page token","description":"Page token used for pagination."},"description":"Page token used for pagination."},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","contentMediaType":"application/json","contentSchema":{}},{"type":"null"}],"title":"Filter","description":"Listing filter schema."},"description":"Listing filter schema."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_VehicleListeningAuditEntry_"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","PAGINATED_QUERY_FILTER_CHANGED","PAGE_SIZE_TOO_LARGE"]}},"/v1/vehicles/{vehicle_id}/charging-history":{"get":{"tags":["Vehicle Charging History"],"summary":"List Vehicle Charging History","description":"Retrieve a list of charging history sessions for the provided vehicle.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to retrieve charging history for.\n\n**Returns:**\n- A paginated list of vehicle charging history sessions.\n\nThis endpoint allows you to retrieve a paginated list of charging history sessions for a specific vehicle identified by its unique `vehicle_id`.\nThe list is ordered by the starting time of each charging session, with the most recent sessions appearing first.\n\n**Note:**\n- The `vehicle_id` should correspond to a valid and existing vehicle identifier.\n\n_Find details on list filter syntax in our documentation [here](/overview/listing-filter-json)._\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- PAGE_SIZE_TOO_LARGE\n- PAGINATED_QUERY_FILTER_CHANGED\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"list_vehicle_charging_history_v1_vehicles__vehicle_id__charging_history_get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."},{"name":"maxPageSize","in":"query","required":false,"schema":{"type":"integer","title":"Max page size","description":"Max size of the returned list."},"description":"Max size of the returned list."},{"name":"pageToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page token","description":"Page token used for pagination."},"description":"Page token used for pagination."},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","contentMediaType":"application/json","contentSchema":{}},{"type":"null"}],"title":"Filter","description":"Listing filter schema."},"description":"Listing filter schema."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_VehicleChargingSession_"}}}}},"x-list-error-codes":["PAGINATED_QUERY_FILTER_CHANGED","PAGE_SIZE_TOO_LARGE","RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/charging-history/{vehicle_charging_session_id}":{"get":{"tags":["Vehicle Charging History"],"summary":"Get Vehicle Charging History","description":"Retrieve details of a vehicle charging session based on its unique ID.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle associated with the charging session.\n- `vehicle_charging_session_id`: The unique identifier (ID) of the vehicle charging session to retrieve.\n\n**Returns:**\n- Details of the vehicle charging session.\n\nThis endpoint allows you to retrieve details of a specific vehicle charging session based on its unique `vehicle_charging_session_id`.\nThe session details provide information about the charging start time, end time, energy consumption, and more.\n\n**Note:**\n- The `vehicle_id` should correspond to a valid and existing vehicle identifier.\n- The `vehicle_charging_session_id` uniquely identifies an existing charging session.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_charging_history_v1_vehicles__vehicle_id__charging_history__vehicle_charging_session_id__get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"vehicle_charging_session_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle charging history ID","description":"ID of the vehicle charging history."},"description":"ID of the vehicle charging history."},{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleChargingSession"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/range":{"get":{"tags":["Vehicle Range"],"summary":"Get Vehicle Range","description":"Retrieves both nominal and real-world maximum range information for specified vehicles. It enables accurate vehicle\nrange analysis by drawing on historical data and usage patterns for the specified vehicle.\n\n**Parameters:**\n- `vehicle_id`: A unique identifier for the vehicle, which must correspond to a vehicle registered in our system.\n\n**Returns:**\n- A vehicle range instance encapsulating detailed range information for the vehicle. The data includes both the\nstandard (nominal) range and the real (observed) maximum range based on data retrieved directly from the vehicle\nand the specifications published by the OEMs.\n\n**Raises:**\n- `APIException`: Raised when the system cannot locate the vehicle's range details, due to an invalid 'vehicle_id'\nor absence of range data. This results in a 404 Not Found status code.\n\n**Note:**\n- The first availability of `real_max_range` depends on the first instance of data retrieved from the vehicle where\nthe State of Charge is above 40%. As more data is collected, the endpoint is updated on a rolling basis, always\nproviding the most accurate information available.\n- We recommend charging the vehicle to a State of Charge greater than 40% should the endpoint not be available.\n- The inclusion of `nominal_max_range` is reliant on the availability of the trim of the vehicle. Identifying the\ntrim requires the registration country of the vehicle to be known and to be one we hold specification data for,\ncurrently Canada, France, Germany, Ireland, Italy, Spain, the United Kingdom, and the United States. For vehicles\nregistered elsewhere, `nominal_max_range` may be unavailable while `real_max_range` is still returned.\n- The endpoint's accuracy and availability depend upon the reliability of data sourced from and published by OEMs.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_range_v1_vehicles__vehicle_id__range_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:information"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/connect_models__schemas__vehicle__vehicle_range__VehicleRange"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/maintenance/services":{"get":{"tags":["Vehicle Services"],"summary":"Get Vehicle Services","description":"Retrieves the list of services currently recommended for the vehicle.\n\nThis can include services for different components (e.g. brakes) but also statutory inspections\n(such as MOT in the UK or TÜV in Germany).\n\nThe service data may include the due date for the service, or the number of kilometers the vehicle can do\nbefore that particular service is due, or both.\nIt may also include the date when the service was last performed.\n\n**Returns:**\n- The list of services for the vehicle.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_services_v1_vehicles__vehicle_id__maintenance_services_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:telemetry"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleServices"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/maintenance/tires/historic":{"get":{"tags":["Vehicle Tires"],"summary":"Get Vehicle Tires Readings Historic","description":"Retrieves the list of tire pressures for the vehicle for the specified period (default is the last 3 months),\ngrouped by hour.\n\nMaximum date range is 3 months.\n\n**Returns:**\n- The list of tire pressures for the vehicle.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_tires_readings_historic_v1_vehicles__vehicle_id__maintenance_tires_historic_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:telemetry"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."},{"name":"from_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start datetime for the tire pressure history, in ISO format. Date range must be 3 months or less.","title":"From Datetime"},"description":"Start datetime for the tire pressure history, in ISO format. Date range must be 3 months or less."},{"name":"to_datetime","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End datetime for the tire pressure history, in ISO format. Date range must be 3 months or less.","title":"To Datetime"},"description":"End datetime for the tire pressure history, in ISO format. Date range must be 3 months or less."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleTiresList"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/state-of-health":{"get":{"tags":["Vehicle State of Health"],"summary":"Get Vehicle State Of Health","description":"Retrieves state of health related information for the specified vehicle.\n- Nominal battery pack capacity refers to the total amount of energy in kWh that the battery pack of the vehicle can\nstore, as per its specifications.\n- Real battery pack capacity refers to the total amount of energy in kWh that the battery pack of the vehicle can\ncurrently store, it's reflective of the actual state of the battery rather than a specification.\n- State of health is defined as real battery pack capacity over nominal battery pack capacity, as percentage.\n\n**Parameters:**\n- `vehicle_id`: A unique identifier for the vehicle, which must correspond to a vehicle registered in our system.\n\n**Returns:**\n- A vehicle state of health instance encapsulating detailed battery pack information for the vehicle. The data\nincludes both the nominal battery pack capacity and the real (observed) maximum battery pack capacity based on data\nretrieved directly from the vehicle and the specifications published by the OEMs.\n\n**Raises:**\n- `APIException`: Raised when the system cannot locate the vehicle's state of health details, due to an invalid\n'vehicle_id' or absence of battery data. This results in a 404 Not Found status code.\n\n**Note:**\n- Endpoint is first available after observing a charging session that added at least 15% of state of charge and was\nstarted above 20% state of charge.\n- We recommend charging the vehicle overnight should the endpoint not be available immediately.\n- This endpoint is reliant on the availability of the trim of the vehicle and supports certain OEMs.\nPlease see [state of health](/overview/state-of-health#supported-oems) for a list of supported OEMs\n- Identifying the trim requires the registration country of the vehicle to be known and to be one we hold\nspecification data for, currently Canada, France, Germany, Ireland, Italy, Spain, the United Kingdom, and the\nUnited States. Vehicles registered elsewhere may not have state of health available.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_state_of_health_v1_vehicles__vehicle_id__state_of_health_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:information"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleStateOfHealth"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/alerts":{"get":{"tags":["Vehicle Alerts"],"summary":"Get Vehicle Alerts","description":"Retrieve alerts for a vehicle based on its unique ID.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- PAGE_SIZE_TOO_LARGE\n- PAGINATED_QUERY_FILTER_CHANGED\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_vehicle_alerts_v1_vehicles__vehicle_id__alerts_get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."},{"name":"maxPageSize","in":"query","required":false,"schema":{"type":"integer","title":"Max page size","description":"Max size of the returned list."},"description":"Max size of the returned list."},{"name":"pageToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page token","description":"Page token used for pagination."},"description":"Page token used for pagination."},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","contentMediaType":"application/json","contentSchema":{}},{"type":"null"}],"title":"Filter","description":"Listing filter schema."},"description":"Listing filter schema."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_VehicleAlertResponse_"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","PAGINATED_QUERY_FILTER_CHANGED","PAGE_SIZE_TOO_LARGE"]}},"/v1/vehicles/{vehicle_id}/maintenance/manufacturer-alerts/current":{"get":{"tags":["Vehicle Manufacturer Alerts"],"summary":"Get Current Vehicle Oem Alerts","description":"Retrieves the list of currently active manufacturer alerts for the vehicle, that is, alerts that have come from the vehicle itself,\nrather than our alerts. This can include alerts for low tire pressure, faulty brakes etc.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_current_vehicle_oem_alerts_v1_vehicles__vehicle_id__maintenance_manufacturer_alerts_current_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:telemetry"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OEMAlerts"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/connect":{"post":{"tags":["Vehicle Connection"],"summary":"Bulk Vin Connect","description":"Connect multiple VINs to the current organization.\nBy default this endpoint is not enabled for organizations, please contact us to get access.\nLimited to 100 VINs per request.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- DEVICE_LIMIT_REACHED\n- NOT_PERMITTED\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"Bulk_VIN_connect_v1_vehicles_connect_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkConnectVehicleRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkConnectVehicleResponse"}}}}},"security":[{"OAuth2ClientCredentialsBearer":[]}],"x-list-error-codes":["NOT_PERMITTED","RESOURCE_NOT_FOUND","DEVICE_LIMIT_REACHED","REQUEST_VALIDATION_ERROR"]}},"/v1/vehicles/connect/{id}":{"get":{"tags":["Vehicle Connection"],"summary":"Bulk Vehicle Connect Group Status","description":"This returns the overall status of the connection request for all VINs.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- NOT_PERMITTED\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"bulk_vehicle_connect_group_status_v1_vehicles_connect__id__get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkConnectStatusResponse"}}}}},"x-list-error-codes":["NOT_PERMITTED","RESOURCE_NOT_FOUND"]}},"/v1/vehicles/connect/{id}/results":{"get":{"tags":["Vehicle Connection"],"summary":"Bulk Vehicle Connect Vin Results","description":"Get details of individual VINs that were sent in the connection request.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- NOT_PERMITTED\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"bulk_vehicle_connect_vin_results_v1_vehicles_connect__id__results_get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}},{"name":"maxPageSize","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Max page size","description":"Max size of the returned list."},"description":"Max size of the returned list."},{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Current page","description":"Current page"},"description":"Current page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResults_VehicleInputResponse_"}}}}},"x-list-error-codes":["NOT_PERMITTED","RESOURCE_NOT_FOUND"]}},"/v1/vehicles/eligibility":{"post":{"tags":["Vehicle Eligibility"],"summary":"Bulk Vin Eligibility Check","description":"Check the eligibility of multiple VINs\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- NOT_PERMITTED\n- REQUEST_VALIDATION_ERROR\n- SERVER_ERROR","operationId":"Bulk_VIN_eligibility_check_v1_vehicles_eligibility_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkVinEligibilityRequest"}}},"required":true},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkVinEligibilityResponse"}}}}},"security":[{"OAuth2ClientCredentialsBearer":[]}],"x-list-error-codes":["NOT_PERMITTED"]}},"/v1/vehicles/eligibility/{id}/results":{"get":{"tags":["Vehicle Eligibility"],"summary":"Bulk Vehicle Eligibility Check Results","description":"Get the eligibility results for all VINs that were sent in a request\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- NOT_PERMITTED\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"bulk_vehicle_eligibility_check_results_v1_vehicles_eligibility__id__results_get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","title":"Id"}},{"name":"maxPageSize","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"title":"Max page size","description":"Max size of the returned list."},"description":"Max size of the returned list."},{"name":"currentPage","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Current page","description":"Current page"},"description":"Current page"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageResults_SingleEligibilityResult_"}}}}},"x-list-error-codes":["NOT_PERMITTED","RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/journeys":{"get":{"tags":["Vehicle Journeys"],"summary":"List Vehicle Journeys","description":"Retrieve a paginated list of journeys for the provided vehicle.\n\n**Parameters:**\n- `vehicle_id`: The unique identifier (ID) of the vehicle to retrieve journeys for.\n- Pagination parameters as query params.\n- Filter parameters on any of the journey fields - see https://docs.volteras.com/overview/listing-filter-json for how to construct.\n\n**Returns:**\n- A paginated list of vehicle journeys.\n\nThis endpoint allows you to retrieve a paginated list of journeys for a specific vehicle identified by its unique `vehicle_id`.\nThe list is ordered by the start timestamp of each journey, with the most recent journeys appearing first.\n\n**Note:**\n- The `vehicle_id` should correspond to a valid and existing vehicle identifier.\n- This endpoint returns the estimated total result count.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- PAGE_SIZE_TOO_LARGE\n- PAGINATED_QUERY_FILTER_CHANGED\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"list_vehicle_journeys_v1_vehicles__vehicle_id__journeys_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:telemetry"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."},{"name":"maxPageSize","in":"query","required":false,"schema":{"type":"integer","title":"Max page size","description":"Max size of the returned list."},"description":"Max size of the returned list."},{"name":"pageToken","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page token","description":"Page token used for pagination."},"description":"Page token used for pagination."},{"name":"filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","contentMediaType":"application/json","contentSchema":{}},{"type":"null"}],"title":"Filter","description":"Listing filter schema."},"description":"Listing filter schema."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageWithEstimatedTotalResults_VehicleJourneyResponse_"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND","PAGINATED_QUERY_FILTER_CHANGED","PAGE_SIZE_TOO_LARGE"]}},"/v1/rate-limits":{"get":{"tags":["Rate Limit"],"summary":"Get Rate Limits","description":"Get the rate limits for a specific entity.\nFor instance, could fetch rate limits applied to a specific vehicle.\n\nThe rate limit domain specifies the context the limit is applied to, e.g. for start / stop charge commands.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- RESOURCE_NOT_FOUND\n- SERVER_ERROR","operationId":"get_rate_limits_v1_rate_limits_get","security":[{"OAuth2ClientCredentialsBearer":[]}],"parameters":[{"name":"objectId","in":"query","required":true,"schema":{"type":"string","title":"Object ID","description":"The ID of the object to get the rate limits for"},"description":"The ID of the object to get the rate limits for"},{"name":"domain","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RateLimitDomain","title":"Domain","description":"The domain of the object to get the rate limits for"},"description":"The domain of the object to get the rate limits for"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RateLimit"},"title":"Response Get Rate Limits V1 Rate Limits Get"}}}}},"x-list-error-codes":["RESOURCE_NOT_FOUND"]}},"/v1/vehicles/{vehicle_id}/departure-times":{"get":{"tags":["Vehicle Charging Schedule"],"summary":"List Vehicle Departure Times","description":"Retrieve a list of departure times for the provided vehicle.\n\nDeparture times determine when the vehicle needs to charge by, working with the target state of charge,\nwhich determines the charging behavior. So for example, if the target state of charge is 80%,\nthe departure time is 10:00, the vehicle is at 70%, and the rate of charge is 10% per hour,\nthe vehicle might start charging at 9:00 to reach 80% by 10:00.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- SERVER_ERROR","operationId":"list_vehicle_departure_times_v1_vehicles__vehicle_id__departure_times_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:charging_history"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleDepartureTimes"}}}}}}},"/v1/vehicles/{vehicle_id}/charging-windows":{"get":{"tags":["Vehicle Charging Schedule"],"summary":"List Charging Windows","description":"Retrieve a list of charging windows for the provided vehicle.\n\nCharging windows determine the start and stop times for the vehicle to charge, for example so that\nthe vehicle can be set to charge during electricity off-peak times.\n\n\nPossible Codes in Error Response (see [Errors](https://docs.volteras.com/api-reference/errors) for error response schema and meaning of codes):\n\n- AUTHENTICATION_ERROR\n- REQUEST_VALIDATION_ERROR\n- SERVER_ERROR","operationId":"list_charging_windows_v1_vehicles__vehicle_id__charging_windows_get","security":[{"OAuth2ClientCredentialsBearer":["vehicle:charging_history"]}],"parameters":[{"name":"vehicle_id","in":"path","required":true,"schema":{"type":"string","title":"Vehicle ID","description":"Unique internal identifier for the vehicle."},"description":"Unique internal identifier for the vehicle."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleChargingWindows"}}}}}}}},"components":{"schemas":{"APIAccess":{"properties":{"clientId":{"type":"string","title":"Client ID","description":"Your client ID."},"organizationId":{"type":"string","title":"Organization ID","description":"ID of your organization."}},"type":"object","required":["clientId","organizationId"],"title":"APIAccess","description":"Schema of APIAccess. Contains info about the authenticated APIAccess."},"APIAccessToken":{"properties":{"access_token":{"type":"string","title":"Access token","description":"The access token used for authenticated requests."},"token_type":{"type":"string","title":"Token type","description":"Type of the token."},"expires_in":{"type":"integer","title":"Expires in","description":"Integer with the seconds that the access token will be expired in."},"refresh_token":{"type":"string","title":"Refresh token","description":"The token used to refresh the authentication and retrieve a new access token."}},"type":"object","required":["access_token","token_type","expires_in","refresh_token"],"title":"APIAccessToken","description":"Schema of the APIAccessToken, returned by the authentication or refresh token"},"APIVehicleUploadStatus":{"type":"string","enum":["CONNECTED","PROCESSING","PENDING","CONNECTION_REQUIRED","INCOMPATIBLE","ERROR"],"title":"APIVehicleUploadStatus","description":"Status of a vehicle connection attempt."},"AccountConnect":{"properties":{"authenticationUrl":{"type":"string","title":"Authenticationurl","description":"The URL to redirect the user to for authentication through the connect flow."}},"type":"object","required":["authenticationUrl"],"title":"AccountConnect"},"AccountConnectPayload":{"properties":{"returnUrl":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"null"}],"title":"Redirect URI","description":"The url the user is redirected to at the end of the consent flow"},"scopes":{"items":{"$ref":"#/components/schemas/ScopeEnum"},"type":"array","minItems":1,"title":"Scopes","description":"List of scopes that the application requires access to"},"locale":{"anyOf":[{"$ref":"#/components/schemas/ConsentFlowLocales"},{"type":"null"}],"description":"Set the language used in the the consent flow. The default is English."},"integrationMethod":{"anyOf":[{"$ref":"#/components/schemas/ConsentFlowIntegration"},{"type":"null"}],"description":"This is for when a make can be connected via multiple methods. For example, if the make is BMW, the user can connect via the BMW Energy API (for smart charging) or via BMW Cardata (for other vehicle data)."},"chargerLocationLatitude":{"anyOf":[{"type":"number"},{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Chargerlocationlatitude","description":"The latitude of the charger location that the vehicle will be charging at. This is passed in specific cases to the OEM's Portal when the consent flow runs (currently only for BMW), to make it easier for the user to select their charger location, which in turn is needed (currently only for BMW) to restrict when start / stop charge commands can be sent."},"chargerLocationLongitude":{"anyOf":[{"type":"number"},{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Chargerlocationlongitude","description":"The longitude of the charger location that the vehicle will be charging at. This is passed in specific cases to the OEM's Portal when the consent flow runs (currently only for BMW), to make it easier for the user to select their charger location, which in turn is needed (currently only for BMW) to restrict when start / stop charge commands can be sent."},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Countrycode","description":"The ISO 3166-1 alpha-2 country code (e.g. DE, GB, US etc.) of the account's country. This is required when it is necessary to fetch the key specifications (model, model year, trim, battery capacity etc.) for vehicles in the account."},"makes":{"anyOf":[{"items":{"$ref":"#/components/schemas/MakeEnum"},"type":"array"},{"type":"null"}],"title":"Makes","description":"Only show these makes of device in the consent flow"},"deviceTypes":{"items":{"$ref":"#/components/schemas/DeviceTypeEnum"},"type":"array","minItems":1,"title":"Device types","description":"Only show these device types in the consent flow. If only one device is selected, the device selection page is skipped."},"urlExpiration":{"anyOf":[{"type":"integer","maximum":1209600.0,"minimum":3600.0},{"type":"null"}],"title":"Urlexpiration","description":"Defines the validity period of the authentication URL in seconds. Defaults to `3600`, with a range between `3600` seconds (1 hour) and `1209600` seconds (2 weeks). Once expired, the URL becomes invalid and cannot be used.","default":3600},"region":{"anyOf":[{"$ref":"#/components/schemas/OEMRegion"},{"type":"null"}],"description":"Defines the geographic region for the account connection, directly influencing which OEM-specific API endpoint will be used for the connection. For OEMs with distinct APIs across regions, this setting ensures the correct regional API is utilized. The default is Europe."},"vin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin","description":"The VIN to connect, if connecting via the VIN upload flow."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"The model to connect, if connecting via the VIN upload flow."},"modelYear":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Modelyear","description":"The model year to connect, if connecting via the VIN upload flow."}},"type":"object","required":["scopes","deviceTypes"],"title":"AccountConnectPayload"},"AffectedComponent":{"type":"string","enum":["VEHICLE","ENGINE","TRANSMISSION","DRIVE_TRAIN","MOTOR","BRAKES","BRAKE_FRONT","BRAKE_REAR","BRAKE_FLUID","STEERING","SUSPENSION","ELECTRIC_POWER_STEERING","BATTERY","AUXILIARY_BATTERY","ELECTRICAL_SYSTEM","HYBRID_SYSTEM","ENGINE_OIL","COOLING","FUEL","EXHAUST_SYSTEM","EMISSIONS_SYSTEM","TIRES","TIRE_PRESSURE_MONITORING_SYSTEM","AIRBAGS","AIRBAG","SEATBELTS","CRASH_DETECTION_SYSTEM","CRASH_SAFETY_SYSTEM","AUTOMATIC_BRAKING_SYSTEM","EMERGENCY_BRAKING_SYSTEM","PEDESTRIAN_PROTECTION_SYSTEM","LANE_DEPARTURE_WARNING_SYSTEM","HILL_START_SYSTEM","AUTOPILOT","CRUISE_CONTROL","PARKING_SENSORS","CAMERAS","SENSORS","TRACTION_SYSTEM","ELECTRONIC_STABILITY_CONTROL","HEADLIGHTS","SIDE_LIGHTS","BRAKE_LIGHTS","REAR_LIGHTS","REVERSE_LIGHTS","SIGNAL_LIGHTS","NUMBER_PLATE_LIGHTS","TRAILER_LIGHTS","ADAPTIVE_LIGHTING_SYSTEM","LIGHTS","BODY","DOORS","TRUNK","ROOF","WINDOWS","LOCKS","KEYS","SECURITY_SYSTEM","WASHER_LIQUID","WIPERS","CLOCK","ODOMETER","EXTERNAL_CHARGING_EQUIPMENT","VEHICLE_CHARGING_PORT","CHARGING_COUPLER","TRAILER"],"title":"AffectedComponent"},"AlertCategory":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["id","name","description"],"title":"AlertCategory"},"AlertDefinitionBase":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"message":{"type":"string","title":"Message"},"category":{"$ref":"#/components/schemas/AlertCategory"}},"type":"object","required":["id","name","description","message","category"],"title":"AlertDefinitionBase"},"AlertMetadata":{"properties":{"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat"}},"type":"object","required":["createdAt","updatedAt"],"title":"AlertMetadata"},"AlertResolutionDefinition":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["id","name","description"],"title":"AlertResolutionDefinition"},"AlertResolutionInstanceSchema":{"properties":{"id":{"type":"string","title":"Id"},"definition":{"$ref":"#/components/schemas/AlertResolutionDefinition"},"status":{"$ref":"#/components/schemas/AlertResolutionStatus"},"steps":{"items":{"$ref":"#/components/schemas/AlertStepInstance"},"type":"array","title":"Steps"}},"type":"object","required":["id","definition","status","steps"],"title":"AlertResolutionInstanceSchema"},"AlertResolutionStatus":{"type":"string","enum":["PENDING","COMPLETED"],"title":"AlertResolutionStatus"},"AlertSeverity":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"],"title":"AlertSeverity"},"AlertStatus":{"type":"string","enum":["ACTIVE","RESOLVED"],"title":"AlertStatus"},"AlertStepDefinition":{"properties":{"id":{"type":"string","title":"Id"},"description":{"type":"string","title":"Description"},"order":{"type":"integer","title":"Order"}},"type":"object","required":["id","description","order"],"title":"AlertStepDefinition"},"AlertStepInstance":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/AlertStepStatus"},"definition":{"$ref":"#/components/schemas/AlertStepDefinition"}},"type":"object","required":["id","status","definition"],"title":"AlertStepInstance"},"AlertStepStatus":{"type":"string","enum":["PENDING","COMPLETED"],"title":"AlertStepStatus"},"BatteryCapacity":{"properties":{"nominal":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Nominal"},"real":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Real"}},"type":"object","required":["nominal","real"],"title":"BatteryCapacity"},"Body_auth_token_v1_oauth2_token_post":{"properties":{"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id","description":"Your client ID."},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Secret","description":"Your client secret."},"refresh_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Refresh Token","description":"The refresh token acquired during authentication with the `client_credentials` `grant_type`."},"grant_type":{"type":"string","title":"Grant Type","description":"OAuth 2.0 grant type."}},"type":"object","title":"Body_auth_token_v1_oauth2_token_post"},"BulkConnectStatusResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/VehicleInputGroupStatusEnum"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"}},"type":"object","required":["id","status","createdAt"],"title":"BulkConnectStatusResponse","description":"Response for /connect/results/{id} endpoint"},"BulkConnectVehicleRequest":{"properties":{"vehicles":{"items":{"$ref":"#/components/schemas/ConnectVehicleRequest"},"type":"array","maxItems":100,"title":"Vehicles","description":"The vehicles to connect"}},"type":"object","required":["vehicles"],"title":"BulkConnectVehicleRequest","description":"Request model to connect multiple VINs"},"BulkConnectVehicleResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/VehicleInputGroupStatusEnum"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"}},"type":"object","required":["id","status","createdAt"],"title":"BulkConnectVehicleResponse","description":"Response for async bulk vehicle upload endpoint on connect-api"},"BulkVinEligibilityRequest":{"properties":{"vins":{"items":{"$ref":"#/components/schemas/SingleEligibilityEntry"},"type":"array","maxItems":500,"minItems":1,"title":"Vins","description":"List of vehicle identification numbers. Each VIN must be a 17-character alphanumeric string."}},"type":"object","required":["vins"],"title":"BulkVinEligibilityRequest"},"BulkVinEligibilityResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/EligibilityUploadStatusEnum"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"}},"type":"object","required":["id","status","createdAt"],"title":"BulkVinEligibilityResponse","description":"Response for async bulk eligibility request on connect-api"},"ChargingWindow":{"properties":{"startHour":{"type":"integer","title":"Starthour"},"startMinute":{"type":"integer","title":"Startminute"},"endHour":{"type":"integer","title":"Endhour"},"endMinute":{"type":"integer","title":"Endminute"},"daysOfWeek":{"items":{"$ref":"#/components/schemas/Weekdays"},"type":"array","title":"Daysofweek","description":"The days of the week that the charging window is valid for. If no values in the array, the charging window is valid for all days of the week."},"localTimeOffset":{"type":"integer","title":"Localtimeoffset","description":"The local time offset (vs. UTC) of the start and end times, in minutes. For example, if the vehicle was in UTC+1, this would be 60."},"windowLocation":{"anyOf":[{"$ref":"#/components/schemas/LatLngValue"},{"type":"null"}]}},"type":"object","required":["startHour","startMinute","endHour","endMinute","daysOfWeek","localTimeOffset"],"title":"ChargingWindow"},"ConnectVehicleRequest":{"properties":{"vin":{"type":"string","title":"Vin","description":"Vehicle identification number. Unique identifier for the vehicle."},"make":{"type":"string","enum":["ABARTH","ALFA ROMEO","AUDI","BMW","CHRYSLER","CITROEN","CUPRA","DODGE","DS AUTOMOBILES","FIAT","FORD","HYUNDAI","JEEP","KIA","LANCIA","LEXUS","MASERATI","MERCEDES BENZ","MINI","NISSAN","OPEL","PEUGEOT","POLESTAR","RAM","RENAULT","SEAT","SKODA","TESLA","TOYOTA","VAUXHALL","VOLKSWAGEN","VOLVO"],"title":"MakeEnum","description":"Manufacturer of the vehicle"},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Countrycode","description":"ISO two-character country code (ISO 3166-1 alpha-2, e.g. 'US', 'GB', 'FR') of the vehicle, used for retrieving vehicle specifications data. If not populated, will use the default setting (if set)."},"registrationPlate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrationplate","description":"Vehicle registration plate"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Vehicle model"},"modelYear":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Modelyear","description":"Vehicle model year (the year the model was released, not the year of manufacture)"},"batteryCapacity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batterycapacity","description":"Nominal (IE when manufactured) battery capacity in kWh of the vehicle"},"horsepower":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Horsepower","description":"Vehicle horsepower"},"generation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generation","description":"Vehicle generation"},"wltpRange":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Wltprange","description":"WLTP range of the vehicle in km"},"registrationDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Registrationdate","description":"Vehicle registration date (ISO 8601, day granularity). Must be on or before today. Used as the date-axis baseline for the service-interval cycle when the `DERIVED_SERVICING_REMINDER` setting is enabled for the organization."},"tags":{"anyOf":[{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},{"type":"null"}],"title":"Tags","description":"Tags to associate with the vehicle, for example IDs you want to associate with it, that will then be returned when you fetch the vehicle and can be used to filter vehicles in the list vehicle endpoint."}},"type":"object","required":["countryCode","vin","make"],"title":"ConnectVehicleRequest","description":"Request model to connect a single VIN"},"ConsentFlowIntegration":{"type":"string","enum":["BMW_ENERGY_API"],"title":"ConsentFlowIntegration"},"ConsentFlowLocales":{"type":"string","enum":["en-GB","de-DE","fr-FR","nl-NL"],"title":"ConsentFlowLocales"},"DepartureTime":{"properties":{"hour":{"type":"integer","title":"Hour"},"minute":{"type":"integer","title":"Minute"},"daysOfWeek":{"items":{"$ref":"#/components/schemas/Weekdays"},"type":"array","title":"Daysofweek","description":"The days of the week that the departure time is valid for. If no values in the array, the departure time is valid for all days of the week."},"localTimeOffset":{"type":"integer","title":"Localtimeoffset","description":"The local time offset (vs. UTC) of the start and end times, in minutes. For example, if the vehicle was in UTC+1, this would be 60."}},"type":"object","required":["hour","minute","daysOfWeek","localTimeOffset"],"title":"DepartureTime"},"DeviceTypeEnum":{"type":"string","enum":["VEHICLE","BATTERY","CHARGER","INVERTER","HEAT_PUMP"],"title":"DeviceTypeEnum","description":"All supported device types"},"EligibilityUploadStatusEnum":{"type":"string","enum":["CREATED","PROCESSING","COMPLETED","FAILED"],"title":"EligibilityUploadStatusEnum"},"EligibilityVinEntryStatusEnum":{"type":"string","enum":["NOT_SUPPORTED","VALIDATION_ERROR","PENDING","SUBMITTED","INELIGIBLE_PENDING_FAILURE_REASON","ELIGIBLE","INELIGIBLE","FAILED"],"title":"EligibilityVinEntryStatusEnum"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InvestigationOemSubState":{"type":"string","enum":["NEEDED","REQUESTED","ONGOING"],"title":"InvestigationOemSubState","description":"CONTACT_OEM progression, driven by the linked oem_outreach lifecycle."},"InvestigationState":{"type":"string","enum":["UNDER_REVIEW","CONTACT_OEM","CUSTOMER_ACTION","RETRY","ESCALATED_INTERNALLY","CONFIRMED_INCOMPATIBLE","SELF_RECOVERED"],"title":"InvestigationState","description":"Customer-facing bucket for a vehicle under Bolt investigation.\n\nMachine-readable contract shared by the portal payload and the public API.\nDisplay titles/copy are derived server-side and shipped alongside, so\nfrontends never need to map these to text themselves."},"LatLngValue":{"properties":{"longitude":{"type":"number","title":"Longitude"},"latitude":{"type":"number","title":"Latitude"}},"type":"object","required":["longitude","latitude"],"title":"LatLngValue"},"MakeEnum":{"type":"string","enum":["ABARTH","ALFA ROMEO","AUDI","BMW","CHRYSLER","CITROEN","CUPRA","DODGE","DS AUTOMOBILES","FIAT","FORD","HYUNDAI","JEEP","KIA","LANCIA","LEXUS","MASERATI","MERCEDES BENZ","MINI","NISSAN","OPEL","PEUGEOT","POLESTAR","RAM","RENAULT","SEAT","SKODA","TESLA","TOYOTA","VAUXHALL","VOLKSWAGEN","VOLVO"],"title":"MakeEnum","description":"Implemented makes enum.\n\nInput normalization and aliases are handled via `from_input` / `_missing_`, so values like\n\"Mercedes\", \"MERCEDES-BENZ\", or \"MERCEDES_BENZ\" resolve to the canonical enum.\n\nOpenAPI exposure is filtered/normalized in `__get_pydantic_json_schema__`.\n\nWhen updating this enum you should also consider updating the public docs:\n    docs/public/connect-api/tools/mintlify/overview/supported-oems.mdx"},"MappedCode":{"type":"string","enum":["TIRE_DEFLATING_ALERT","TIRE_PRESSURE_ALERT","TIRE_PUNCTURE","TIRE_PRESSURE_MISMATCH","TIRE_PRESSURE_SYSTEM_FAULT","TIRE_PRESSURE_MONITORING_DEACTIVATED","AUXILIARY_BATTERY_FAULT","AUXILIARY_BATTERY_LOW_VOLTAGE","ELECTRICAL_CHARGING_FAULT","BATTERY_OVERHEATING","BATTERY_INSULATION_FAULT","BATTERY_CELL_FAULT","BATTERY_STORAGE_FAULT","BATTERY_CHARGE_HIGH","BATTERY_CHARGE_LOW","BATTERY_CELL_OVERVOLTAGE","BATTERY_CELL_UNDERVOLTAGE","BATTERY_CHARGE_FLUCTUATION","BATTERY_TEMP_IMBALANCE","BATTERY_OVERCHARGE","BATTERY_DISCHARGE_RATE_HIGH","BATTERY_MONITORING_FAILED","BATTERY_CHARGING","CHARGING_ABORTED","BATTERY_OUTPUT_RESTRICTED","BATTERY_REGENERATION_REQUIRED","CHARGING_COUPLER_FAULT","INVERTER_FAULT","ENGINE_OVERHEATING","ENGINE_FAULT","ENGINE_INCREASED_EMISSIONS","ENGINE_REDUCE_LOAD","OIL_PRESSURE_LOW","OIL_LEVEL_SENSOR_MALFUNCTION","ENGINE_OIL_LEVEL_ALERT","POWERTRAIN_FAULT","CHECK_ENGINE","TRANSMISSION_MALFUNCTION","TRANSMISSION_RESTRICTED_POSITION","TRANSMISSION_POSITION_N","TRANSMISSION_POSITION_D_ONLY","TRANSMISSION_POSITION_P_ONLY","TRANSMISSION_FAILSAFE_ACTIVE","TRANSMISSION_NEUTRAL_PARKING_BRAKE","GEARBOX_OVERHEATING","GEARBOX_OVERHEATED","GEAR_INDICATOR_FAILED","BRAKE_SYSTEM_FAULT","ABS_FAULT","BRAKE_PAD_WEAR","BRAKE_FLUID_LOW","BRAKE_DRIVING_CONTROL_FAILURE","DBC_BRAKE_ASSIST_FAILED","PARKING_BRAKE_ACTIVE","PARKING_BRAKE_OVERHEATED","PARKING_BRAKE_MALFUNCTION","PARKING_BRAKE_RELEASE","AUTOMATIC_HOLD_MALFUNCTION","PRESS_BRAKE_TO_START","POWER_STEERING_FAULT","POWER_STEERING_SERVICE_REQUIRED","SUSPENSION_FAULT","DYNAMIC_DAMPER_CONTROL_FAILED","LEVEL_CONTROL_SYSTEM_FAILURE","SERVOTRONIC_FAILED","EPS_INOPERATIVE","ELV_STEERING_LOCK_FAULT","ELV_STEERING_LOCK_ACTIVE","CRASH_DETECTED","CRASH_SAFETY_MODULE","SEATBELT_UNFASTENED","SEATBELT_FAULT","SEATBELT_PRETENSIONER_FAULT","MULTIPLE_RESTRAINT_SYSTEM_FAULT","AIRBAG_SYSTEM_FAULT","DRIVERS_AIRBAG_FAULT","PASSENGER_AIRBAG_FAULT","SIDE_AIRBAG_FAULT","FORWARD_COLLISION_ALERT","FORWARD_COLLISION_SYSTEM_FAULT","LOW_SPEED_COLLISION_ALERT","LOW_SPEED_COLLISION_SYSTEM_FAULT","ANTI_THEFT_ALERT","SECURITY_SYSTEM_FAULT","CRUISE_CONTROL_FAULT","CRUISE_CONTROL_DEACTIVATED_SENSOR_ERROR","ACTIVE_CRUISE_CONTROL_DISABLED","LANE_ASSIST_FAULT","BLIND_SPOT_SYSTEM_FAULT","PARK_ASSIST_FAULT","REAR_CROSS_TRAFFIC_FAULT","HILL_DESCENT_FAULT","HILL_START_FAULT","ESC_FAULT","DSC_FAILED","DSC_DEACTIVATED","TRACTION_CONTROL_OFF","TRACTION_CONTROL_ACTIVE","DYNAMIC_TRACTION_CONTROL_ACTIVE","AWD_DISABLED","LIGHTING_SYSTEM_FAULT","HEADLIGHT_FAULT","LIGHT_FAULT","INDICATOR_LIGHT_FAULT","BRAKE_LIGHT_FAULT","REVERSE_LIGHT_FAULT","FOG_LIGHT_FAULT","SIDE_LIGHT_FAULT","NUMBER_PLATE_LIGHT_FAULT","ADAPTIVE_LIGHTING_FAULT","SIDELIGHTS_ON","PARKING_LIGHTS_ON","TRAILER_LIGHT_FAULT","FUEL_LEVEL_LOW","FUEL_CAP_ISSUE","FUEL_INLET_ISSUE","FUEL_DOOR_OPEN","FUEL_FILTER_MAINTENANCE","WATER_IN_FUEL","DIESEL_IDLE_SHUTDOWN","DIESEL_ENGINE_FAULT","DIESEL_PREHEAT","DEF_LOW","DEF_SYSTEM_FAULT","DEF_WARNING","DEF_QUALITY_ISSUE","EXHAUST_OVERTEMP","DPF_MAINTENANCE","DPF_REGENERATION_ACTIVE","PARTICULATE_FILTER_MALFUNCTION","ANTI_POLLUTION_SYSTEM_FAULT","HYBRID_SYSTEM_FAULT","HV_INTERLOCK_FAULT","DC_CONVERTER_OVERHEATING","DC_CONVERTER_FAULT","MOTOR_CONTROLLER_OVERHEATING","TRACTION_MOTOR_OVERHEATING","KEYLESS_ENTRY_FAULT","WRONG_REMOTE_KEY","KEY_BATTERY_LOW","REMOTE_CONTROL_KEY_FAULT","REMOTE_KEY_BATTERY_DISCHARGED","REMOTE_KEY_STATIONARY_BATTERY_LOW","DOOR_OPEN","BONNET_OPEN","BOOT_OPEN","SERVICE_DUE","AIR_FILTER_MAINTENANCE","AUTO_START_STOP_FAULT","WASHER_FLUID_LOW","WINDSHIELD_WASHER_FLUID_LOW","WINDSHIELD_WIPER_MALFUNCTION","ENGINE_COOLANT_LEVEL_LOW","LOW_EXTERNAL_TEMPERATURE","RESET_CLOCK","SYSTEM_CHECK_FAILED","TRAILER_BRAKE_CONNECTION_ISSUE","TRAILER_ELECTRICS_FAILED","IGNITION_PROBLEM","STARTER_PROBLEM","PREHEATING_ACTIVE","VEHICLE_SPEED_LIMIT_EXCEEDED","ODOMETER_FAILURE","GENERAL_MALFUNCTION"],"title":"MappedCode"},"OEMAccount":{"properties":{"id":{"type":"string","title":"Id"},"username":{"type":"string","title":"Username"}},"type":"object","required":["id","username"],"title":"OEMAccount"},"OEMAlert":{"properties":{"status":{"$ref":"#/components/schemas/OEMAlertStatus"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"oemCode":{"type":"string","title":"Oemcode"},"oemMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Oemmessage"},"mappedMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mappedmessage"},"oemMetadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Oemmetadata"},"affectedComponent":{"anyOf":[{"$ref":"#/components/schemas/AffectedComponent"},{"type":"string"},{"type":"null"}],"title":"Affectedcomponent"},"recommendedAction":{"anyOf":[{"$ref":"#/components/schemas/OEMAlertAction"},{"type":"string"},{"type":"null"}],"title":"Recommendedaction"},"type":{"anyOf":[{"$ref":"#/components/schemas/OEMAlertType"},{"type":"string"},{"type":"null"}],"title":"Type"},"mappedCode":{"anyOf":[{"$ref":"#/components/schemas/MappedCode"},{"type":"string"},{"type":"null"}],"title":"Mappedcode"},"severity":{"anyOf":[{"$ref":"#/components/schemas/OEMAlertSeverity"},{"type":"null"}]}},"type":"object","required":["status","timestamp","oemCode"],"title":"OEMAlert"},"OEMAlertAction":{"type":"string","enum":["DO_NOT_DRIVE","SERVICE_REQUIRED","COMPLETE_ROUTINE_MAINTENANCE","SERVICE_IF_ALERT_PERSISTS","SHUT_DOORS","SHUT_TRUNK","CHECK_VEHICLE_SECURE","COORDINATE_RETRIEVAL","CHARGE_CAR","REFUEL","FASTEN_SEATBELTS","SET_CLOCK","SWITCH_IGNITION_ON","SWITCH_ENGINE_ON","DEPRESS_BRAKE","DEPRESS_CLUTCH","TURN_STEERING_WHEEL","REPLACE_KEY_BATTERY","REPLACE_BULB","CHECK_BATTERY_TERMINALS","CHECK_BATTERY_CONDITION"],"title":"OEMAlertAction"},"OEMAlertSeverity":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"],"title":"OEMAlertSeverity"},"OEMAlertStatus":{"type":"string","enum":["ACTIVE","RESOLVED","UNKNOWN"],"title":"OEMAlertStatus"},"OEMAlertType":{"type":"string","enum":["FAULT","WARNING","INFO","ROUTINE_MAINTENANCE","TEMPORARY_FAULT"],"title":"OEMAlertType"},"OEMAlerts":{"properties":{"alerts":{"items":{"$ref":"#/components/schemas/OEMAlert"},"type":"array","title":"Alerts","default":[]}},"type":"object","title":"OEMAlerts"},"OEMDeviceCommandExecutionStatus":{"type":"string","enum":["PENDING","EXECUTED","FAILED"],"title":"OEMDeviceCommandExecutionStatus","description":"Enum for command execution status."},"OEMRegion":{"type":"string","enum":["NORTH_AMERICA","EUROPE"],"title":"OEMRegion"},"Option":{"properties":{"code":{"type":"string","title":"Code"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["code"],"title":"Option"},"PageResults_SingleEligibilityResult_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/SingleEligibilityResult"},"type":"array","title":"Results","default":[]},"totalResults":{"type":"integer","title":"Totalresults","default":0}},"type":"object","title":"PageResults[SingleEligibilityResult]"},"PageResults_VehicleInputResponse_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/VehicleInputResponse"},"type":"array","title":"Results","default":[]},"totalResults":{"type":"integer","title":"Totalresults","default":0}},"type":"object","title":"PageResults[VehicleInputResponse]"},"PageWithEstimatedTotalResults_VehicleJourneyResponse_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/VehicleJourneyResponse"},"type":"array","title":"Results","description":"Returned data from the listing query."},"nextPageToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next page token","description":"Next page token used for pagination."},"estimatedTotalResults":{"type":"integer","title":"Estimated total results","description":"Estimated total result count."}},"type":"object","required":["results","nextPageToken","estimatedTotalResults"],"title":"PageWithEstimatedTotalResults[VehicleJourneyResponse]"},"Page_OEMAccount_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/OEMAccount"},"type":"array","title":"Results","description":"Returned data from the listing query."},"nextPageToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next page token","description":"Next page token used for pagination."},"totalResults":{"type":"integer","title":"Total results","description":"Total result count."}},"type":"object","required":["results","nextPageToken","totalResults"],"title":"Page[OEMAccount]"},"Page_VehicleAlertResponse_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/VehicleAlertResponse"},"type":"array","title":"Results","description":"Returned data from the listing query."},"nextPageToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next page token","description":"Next page token used for pagination."},"totalResults":{"type":"integer","title":"Total results","description":"Total result count."}},"type":"object","required":["results","nextPageToken","totalResults"],"title":"Page[VehicleAlertResponse]"},"Page_VehicleChargingSession_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/VehicleChargingSession"},"type":"array","title":"Results","description":"Returned data from the listing query."},"nextPageToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next page token","description":"Next page token used for pagination."},"totalResults":{"type":"integer","title":"Total results","description":"Total result count."}},"type":"object","required":["results","nextPageToken","totalResults"],"title":"Page[VehicleChargingSession]"},"Page_VehicleCommandExecution_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/VehicleCommandExecution"},"type":"array","title":"Results","description":"Returned data from the listing query."},"nextPageToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next page token","description":"Next page token used for pagination."},"totalResults":{"type":"integer","title":"Total results","description":"Total result count."}},"type":"object","required":["results","nextPageToken","totalResults"],"title":"Page[VehicleCommandExecution]"},"Page_VehicleListeningAuditEntry_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/VehicleListeningAuditEntry"},"type":"array","title":"Results","description":"Returned data from the listing query."},"nextPageToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next page token","description":"Next page token used for pagination."},"totalResults":{"type":"integer","title":"Total results","description":"Total result count."}},"type":"object","required":["results","nextPageToken","totalResults"],"title":"Page[VehicleListeningAuditEntry]"},"Page_Vehicle_":{"properties":{"results":{"items":{"$ref":"#/components/schemas/Vehicle"},"type":"array","title":"Results","description":"Returned data from the listing query."},"nextPageToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next page token","description":"Next page token used for pagination."},"totalResults":{"type":"integer","title":"Total results","description":"Total result count."}},"type":"object","required":["results","nextPageToken","totalResults"],"title":"Page[Vehicle]"},"PublicTagCreate":{"properties":{"key":{"type":"string","maxLength":150,"title":"Key"},"value":{"type":"string","maxLength":150,"title":"Value"},"objectType":{"$ref":"#/components/schemas/PublicTagEntityTypes","description":"What type of object is being tagged, such as 'VEHICLE'. *IMPORTANT*: If the account is tagged, all devices underneath the account will also be tagged."},"objectId":{"type":"string","title":"Objectid","description":"ID of the object being tagged"}},"type":"object","required":["key","value","objectType","objectId"],"title":"PublicTagCreate"},"PublicTagEntityTypes":{"type":"string","enum":["DEVICE"],"title":"PublicTagEntityTypes"},"RangeDetail":{"properties":{"real":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Real"},"realWarmerRange":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Realwarmerrange"},"realColderRange":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Realcolderrange"},"nominal":{"additionalProperties":{"anyOf":[{"type":"integer"},{"type":"null"}]},"propertyNames":{"$ref":"#/components/schemas/VehicleRangeStandardEnum"},"type":"object","title":"Nominal"},"score":{"additionalProperties":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}]},"propertyNames":{"$ref":"#/components/schemas/VehicleRangeStandardEnum"},"type":"object","title":"Score"}},"type":"object","required":["nominal","score"],"title":"RangeDetail"},"RateLimit":{"properties":{"remainingRequests":{"type":"integer","title":"Remainingrequests","description":"The count of remaining requests before the rate limit is breached"},"maxRequests":{"type":"integer","title":"Maxrequests","description":"The maximum count of requests on the rate limit over the window period"},"domain":{"$ref":"#/components/schemas/RateLimitDomain","description":"The domain of the object on which the rate limit is applied (for example, if the rate limit is applied to a specific vehicle, the domain is VEHICLE)"},"windowSizeSeconds":{"type":"integer","title":"Windowsizeseconds","description":"The window size in seconds over which the rate limit is calculated"},"objectId":{"type":"string","title":"Objectid","description":"The ID of the object on which the rate limit is applied"},"key":{"$ref":"#/components/schemas/RateLimitKey","description":"The key of the rate limit, which can be used to uniquely identify the kind of rate limit applied"}},"type":"object","required":["remainingRequests","maxRequests","domain","windowSizeSeconds","objectId","key"],"title":"RateLimit"},"RateLimitDomain":{"type":"string","enum":["VEHICLE"],"title":"RateLimitDomain"},"RateLimitKey":{"type":"string","enum":["BMW_ENERGY_API_COMMANDS","BMW_ENERGY_API_STOP_COMMANDS","BMW_ENERGY_API_COMMANDS_AND_FETCH_STATE"],"title":"RateLimitKey"},"ScopeEnum":{"type":"string","enum":["vehicle:all","vehicle:charging_history","vehicle:driving_behavior","vehicle:location_history","vehicle:telemetry","vehicle:information","vehicle:commands","battery:all","battery:telemetry","geofences:all","geofences:read","geofences:write"],"title":"ScopeEnum"},"ServiceStatus":{"type":"string","enum":["PENDING","NO_SERVICE_DUE","IN_SERVICE","NOT_IN_SERVICE_UNKNOWN_IF_DUE"],"title":"ServiceStatus"},"ServiceType":{"type":"string","enum":["FULL_SERVICE","HEALTH_CHECK","STATUTORY","OIL_CHANGE"],"title":"ServiceType"},"SetChargeLimitPayload":{"properties":{"limit":{"type":"integer","title":"Limit"}},"type":"object","required":["limit"],"title":"SetChargeLimitPayload"},"SetTemperaturePayload":{"properties":{"driverTemperature":{"type":"number","title":"Drivertemperature"},"passengerTemperature":{"type":"number","title":"Passengertemperature"}},"type":"object","required":["driverTemperature","passengerTemperature"],"title":"SetTemperaturePayload"},"SingleEligibilityEntry":{"properties":{"vin":{"type":"string","maxLength":17,"minLength":17,"pattern":"^[A-Z0-9]*$","title":"Vin","description":"Vehicle identification number (VIN)."},"make":{"type":"string","enum":["ABARTH","ALFA ROMEO","AUDI","BMW","CHRYSLER","CITROEN","CUPRA","DODGE","DS AUTOMOBILES","FIAT","FORD","HYUNDAI","JEEP","KIA","LANCIA","LEXUS","MASERATI","MERCEDES BENZ","MINI","NISSAN","OPEL","PEUGEOT","POLESTAR","RAM","RENAULT","SEAT","SKODA","TESLA","TOYOTA","VAUXHALL","VOLKSWAGEN","VOLVO"],"title":"MakeEnum","description":"Manufacturer of the vehicle"},"countryCode":{"anyOf":[{"type":"string","maxLength":2,"minLength":2},{"type":"null"}],"title":"Countrycode","description":"ISO two-character country code for the VIN being checked."}},"type":"object","required":["countryCode"],"title":"SingleEligibilityEntry"},"SingleEligibilityResult":{"properties":{"rowId":{"type":"integer","title":"Rowid"},"vin":{"type":"string","maxLength":17,"minLength":17,"pattern":"^[A-Z0-9]*$","title":"Vin","description":"Vehicle identification number (VIN)."},"make":{"anyOf":[{"type":"string","enum":["ABARTH","ALFA ROMEO","AUDI","BMW","CHRYSLER","CITROEN","CUPRA","DODGE","DS AUTOMOBILES","FIAT","FORD","HYUNDAI","JEEP","KIA","LANCIA","LEXUS","MASERATI","MERCEDES BENZ","MINI","NISSAN","OPEL","PEUGEOT","POLESTAR","RAM","RENAULT","SEAT","SKODA","TESLA","TOYOTA","VAUXHALL","VOLKSWAGEN","VOLVO"],"title":"MakeEnum","description":"Implemented makes enum.\n\nInput normalization and aliases are handled via `from_input` / `_missing_`, so values like\n\"Mercedes\", \"MERCEDES-BENZ\", or \"MERCEDES_BENZ\" resolve to the canonical enum.\n\nOpenAPI exposure is filtered/normalized in `__get_pydantic_json_schema__`.\n\nWhen updating this enum you should also consider updating the public docs:\n    docs/public/connect-api/tools/mintlify/overview/supported-oems.mdx"},{"type":"null"}],"description":"Manufacturer of the vehicle"},"status":{"$ref":"#/components/schemas/EligibilityVinEntryStatusEnum","description":"The current status of the eligibility check"},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Errormessage","description":"If there was an error with the check, this will have more information"}},"type":"object","required":["rowId","vin","status"],"title":"SingleEligibilityResult","description":"Results for a single vin sent in the bulk eligibility request"},"Tag":{"properties":{"key":{"type":"string","maxLength":150,"title":"Key"},"value":{"type":"string","maxLength":150,"title":"Value"}},"type":"object","required":["key","value"],"title":"Tag"},"TagsList":{"properties":{"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags","description":"List of tags"}},"type":"object","required":["tags"],"title":"TagsList"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Vehicle":{"properties":{"make":{"type":"string","title":"Make","description":"Manufacturer of the vehicle."},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Subcategory of the make, used to differentiate between different variations of a vehicle within the same make."},"trim":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trim","description":"Subcategory of the model, used to differentiate between different variations of a vehicle within the same model. Also referred to as version or generation."},"modelYear":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Modelyear","description":"Year the vehicle model was released. Could be different than the year the vehicle was manufactured."},"vin":{"type":"string","title":"Vin","description":"Vehicle identification number. Unique identifier for the vehicle."},"registrationPlate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrationplate","description":"Plate that is attached to a vehicle and displays a unique combination of letters and numbers assigned to the vehicle by a government agency. Also referred to as license plate or registration number."},"isRegNoValidated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isregnovalidated","description":"Indicates whether the registration plate has been validated"},"regNoValidatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Regnovalidatedat","description":"Timestamp of when the registration plate was last validated"},"id":{"type":"string","title":"Id","description":"Unique internal identifier for the vehicle."},"metadata":{"$ref":"#/components/schemas/VehicleMetaData","description":"Additional information about the vehicle."},"isListening":{"type":"boolean","title":"Islistening","description":"Indicates whether the vehicle is currently accepting data ingestion and commands. Defaults to True when no listening state entries have been recorded.","default":true},"listeningLastUpdated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Listeninglastupdated","description":"UTC timestamp for the most recent listening-state update, or null when no entries exist."},"connectionStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connectionstatus","description":"Connection status of the vehicle (e.g. CONNECTED, PENDING_CONNECTION, DISCONNECTED)."},"connectionErrorCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connectionerrorcode","description":"Error code if the vehicle has a connection issue."},"connectionErrorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connectionerrormessage","description":"Human-readable error message for connection issues."},"actionCategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actioncategory","description":"Who must act on the connection error: CUSTOMER_ACTION, CONTACT_SUPPORT, or UNDER_REVIEW."},"investigationState":{"anyOf":[{"$ref":"#/components/schemas/InvestigationState"},{"type":"null"}],"description":"Customer-facing status of an active Volteras investigation into this vehicle's connection (UNDER_REVIEW, CONTACT_OEM, CUSTOMER_ACTION, RETRY, ESCALATED_INTERNALLY). Null when there is no active investigation or the investigation status feature is not enabled for your organization."},"investigationSubState":{"anyOf":[{"$ref":"#/components/schemas/InvestigationOemSubState"},{"type":"null"}],"description":"CONTACT_OEM progression (NEEDED, REQUESTED, ONGOING); null for other investigation states."},"investigationTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Investigationtitle","description":"Display title for the current investigation status."},"investigationMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Investigationmessage","description":"Customer-appropriate explanation of the current investigation state."},"investigationUpdatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Investigationupdatedat","description":"UTC timestamp of the most recent investigation progression."}},"type":"object","required":["make","vin","id","metadata"],"title":"Vehicle"},"VehicleAlertResponse":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/AlertStatus"},"alertDefinitionId":{"type":"string","title":"Alertdefinitionid"},"vehicleId":{"type":"string","title":"Vehicleid"},"muted":{"type":"boolean","title":"Muted"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"currentSeverity":{"anyOf":[{"$ref":"#/components/schemas/AlertSeverity"},{"type":"null"}]},"vin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin"},"resolutions":{"items":{"$ref":"#/components/schemas/AlertResolutionInstanceSchema"},"type":"array","title":"Resolutions"},"definition":{"$ref":"#/components/schemas/AlertDefinitionBase"},"metadata":{"$ref":"#/components/schemas/AlertMetadata"},"triggerName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Triggername"},"triggerDescription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Triggerdescription"}},"type":"object","required":["id","status","alertDefinitionId","vehicleId","muted","createdAt","currentSeverity","resolutions","definition","metadata"],"title":"VehicleAlertResponse"},"VehicleChargeCurrentLimit":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Current limit of the charger in amps."},"unit":{"type":"string","const":"amps","title":"Unit","default":"amps"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","timestamp"],"title":"VehicleChargeCurrentLimit"},"VehicleChargeMaxStateOfCharge":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Target state of charge (as a percentage) set in the vehicle."},"unit":{"type":"string","const":"percent","title":"Unit","default":"percent"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","timestamp"],"title":"VehicleChargeMaxStateOfCharge"},"VehicleChargeMinStateOfCharge":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Minimum state of charge set in the vehicle. If this is present, the vehicle will always charge immediately when plugged in until the minimum state of charge is reached."},"unit":{"type":"string","const":"percent","title":"Unit","default":"percent"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","timestamp"],"title":"VehicleChargeMinStateOfCharge"},"VehicleChargePortLatchStateEnum":{"type":"string","enum":["ENGAGED","DISENGAGED","BLOCKING","INVALID"],"title":"VehicleChargePortLatchStateEnum","description":"Enum for charge port latch status."},"VehicleChargePowerLevel":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Power level of the charger in kW."},"unit":{"type":"string","const":"kw","title":"Unit","default":"kw"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","timestamp"],"title":"VehicleChargePowerLevel"},"VehicleChargeRemainingTime":{"properties":{"value":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Value","description":"Remaining time to full charge in minutes."},"unit":{"type":"string","const":"minutes","title":"Unit","default":"minutes"},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","timestamp"],"title":"VehicleChargeRemainingTime"},"VehicleChargeStateEnum":{"type":"string","enum":["STARTING","STOPPED","CHARGING","COMPLETE","DISCONNECTED","NO_POWER","CONNECTED","INVALID"],"title":"VehicleChargeStateEnum","description":"Enum for charging status."},"VehicleChargingSession":{"properties":{"id":{"type":"string","title":"Id"},"vehicleId":{"type":"string","title":"Vehicleid"},"startedAt":{"type":"string","format":"date-time","title":"Startedat"},"endedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Endedat"},"chargeDuration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Chargeduration"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude"},"kwhFromGrid":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Kwhfromgrid"},"kwhInHvb":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Kwhinhvb"},"startStateOfCharge":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Startstateofcharge"},"endStateOfCharge":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Endstateofcharge"},"externalTemperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Externaltemperature"},"kwMedian":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Kwmedian"}},"type":"object","required":["id","vehicleId","startedAt","endedAt","chargeDuration","latitude","longitude","kwhFromGrid","kwhInHvb","startStateOfCharge","endStateOfCharge","externalTemperature","kwMedian"],"title":"VehicleChargingSession"},"VehicleChargingState":{"properties":{"chargingState":{"anyOf":[{"$ref":"#/components/schemas/VehicleChargeStateEnum"},{"type":"null"}],"description":"Charging state reading."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."},"chargePortDoorOpen":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Chargeportdooropen","description":"Whether the charge port door is open."},"chargePortLatch":{"anyOf":[{"$ref":"#/components/schemas/VehicleChargePortLatchStateEnum"},{"type":"null"}],"description":"Whether the charge port latch is closed."}},"type":"object","required":["chargingState","timestamp","chargePortDoorOpen","chargePortLatch"],"title":"VehicleChargingState"},"VehicleChargingWindows":{"properties":{"chargingWindows":{"items":{"$ref":"#/components/schemas/ChargingWindow"},"type":"array","title":"Chargingwindows"}},"type":"object","required":["chargingWindows"],"title":"VehicleChargingWindows"},"VehicleCommandEnum":{"type":"string","enum":["WAKE_UP","UNLOCK_DOORS","LOCK_DOORS","HONK_HORN","FLASH_LIGHTS","START_HVAC_SYSTEM","CLIMATE_ON","CLIMATE_OFF","SET_TEMPERATURE","SET_CHARGE_LIMIT","ACTUATE_FRONT_TRUNK","ACTUATE_REAR_TRUNK","OPEN_CHARGE_PORT","CLOSE_CHARGE_PORT","START_CHARGING","STOP_CHARGING","SET_VEHICLE_NAME","SCHEDULE_SOFTWARE_UPDATE","CANCEL_SOFTWARE_UPDATE","WINDOW_HEATING_ON","WINDOW_HEATING_OFF"],"title":"VehicleCommandEnum","description":"Enum for available commands."},"VehicleCommandExecution":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"commandArguments":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Commandarguments"},"timeout":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timeout"},"executedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Executedat"},"status":{"anyOf":[{"$ref":"#/components/schemas/OEMDeviceCommandExecutionStatus"},{"type":"null"}]},"failedReason":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["OEM_UNKNOWN_ERROR","OEM_TIMEOUT","OEM_UNAVAILABLE","OEM_NETWORK_ERROR","OEM_INCORRECT_REGION","OEM_APP_REQUIRED_UPDATE","OEM_USER_ACCOUNT_LOCKED","OEM_OAUTH_TOKEN_EXPIRED","OEM_VEHICLE_OFFLINE","OEM_VEHICLE_REMOTE_ACCESS_DISABLED","OEM_VEHICLE_LOCATION_SHARING_DISABLED","OEM_AUTH_DRIVER_IS_NOT_PRIMARY_USER","OEM_DEVICE_NOT_FOUND","OEM_COMMAND_TIMEOUT","OEM_COMMAND_FAILED","OEM_RATE_LIMITED","OEM_ACCOUNT_RATE_LIMITED","OEM_DEVICE_RATE_LIMITED","OEM_STOP_CHARGE_RATE_LIMITED","OEM_COMMANDS_RATE_LIMITED","OEM_VEHICLE_LOCATION_UNKNOWN","OEM_VEHICLE_NOT_IN_AUTHORIZED_LOCATION","OEM_VEHICLE_CHARGING_NOT_FINISHED","OEM_VEHICLE_CHARGING_NOT_STOPPED","OEM_VEHICLE_CHARGING_NOT_STARTED","OEM_VEHICLE_CHARGING_NOT_PAUSED","OEM_VEHICLE_CHARGING_REFUSED_PLAY_PROTECTION","OEM_COMMAND_REFUSED_OTHER_SERVICE_RUNNING","OEM_COMMAND_REFUSED_VEHICLE_AWAKE_IN_STAND_STILL_AND_RESTING_STATE","OEM_COMMAND_REFUSED_VEHICLE_AWAKE_IN_STAND_STILL_AND_ACTIVE_STATE","OEM_COMMAND_REFUSED_VEHICLE_AWAKE_IN_DRIVING_OR_READY_TO_DRIVE","OEM_COMMAND_REFUSED_VEHICLE_AWAKE_IN_DIAGNOSTICS_MODE","SERVER_ERROR","INTERNAL_RATE_LIMITED","AUTHENTICATION_ERROR","NOT_PERMITTED"],"title":"Failedreason","description":"The reason the command failed to execute. Should be one of the codes listed in the enum, but may in some cases be a plain string."},"vehicleId":{"type":"string","title":"Vehicleid"},"command":{"$ref":"#/components/schemas/VehicleCommandEnum"}},"type":"object","required":["vehicleId","command"],"title":"VehicleCommandExecution"},"VehicleConfig":{"properties":{"exteriorColor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exteriorcolor"},"chargePortType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chargeporttype"},"driverAssist":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Driverassist"},"efficiencyPackage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Efficiencypackage"},"hasAirSuspension":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasairsuspension"},"hasLudicrousMode":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasludicrousmode"},"hasSeatCooling":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasseatcooling"},"headlampType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Headlamptype"},"interiorTrimType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Interiortrimtype"},"motorizedChargePort":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Motorizedchargeport"},"rearDriveUnit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reardriveunit"},"rhd":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rhd"},"spoilerType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spoilertype"},"wheelType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Wheeltype"}},"type":"object","title":"VehicleConfig"},"VehicleDepartureTimes":{"properties":{"departureTimes":{"items":{"$ref":"#/components/schemas/DepartureTime"},"type":"array","title":"Departuretimes"}},"type":"object","required":["departureTimes"],"title":"VehicleDepartureTimes"},"VehicleElevation":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Elevation reading."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of length. Defaults to SI unit 'm'."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","unit","timestamp"],"title":"VehicleElevation"},"VehicleEnergyRemainingKwh":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Energy remaining reading."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"No unit. Energy remaining of the battery pack in kWh."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","unit","timestamp"],"title":"VehicleEnergyRemainingKwh"},"VehicleHeading":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Heading reading in degrees."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of angle. Defaults to 'degree'."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","unit","timestamp"],"title":"VehicleHeading"},"VehicleInputGroupStatusEnum":{"type":"string","enum":["CREATED","PROCESSING","COMPLETED","FAILED"],"title":"VehicleInputGroupStatusEnum"},"VehicleInputResponse":{"properties":{"vehicleId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vehicleid","description":"Vehicle ID of the connected vehicle. This will only be set if the vehicle was connected successfully"},"vehicleInputId":{"type":"string","title":"Vehicleinputid","description":"ID of the vehicle input (IE this specific attempt for the VIN upload)."},"status":{"$ref":"#/components/schemas/APIVehicleUploadStatus","description":"Status of the vehicle connection attempt.\n- `CONNECTED`: The vehicle was successfully connected.\n- `PROCESSING`: The VIN is queued and waiting to be processed by the platform.\n- `PENDING`: The VIN has been ingested and is being connected. Check the message field for any required actions (e.g. vehicle must be driven to complete connection).\n- `CONNECTION_REQUIRED`: The vehicle owner needs to authenticate via our consent flow to complete the connection.\n- `INCOMPATIBLE`: The VIN is not compatible with the OEM's connected vehicle platform.\n- `ERROR`: The connection failed — check the errors field for details."},"message":{"type":"string","title":"Message","description":"Message for the response."},"errors":{"items":{"$ref":"#/components/schemas/VehicleInputResponseError"},"type":"array","title":"Errors","description":"Errors for the response, if any were raised","default":[]},"canRetry":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Canretry","description":"Whether the client can retry the upload on error."},"vin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vin","description":"The VIN"},"make":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Make","description":"The vehicle make"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"The vehicle model"},"countryCode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Countrycode","description":"ISO two-character country code of the vehicle captured during upload, if provided."},"registrationPlate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registrationplate","description":"Vehicle registration plate captured during upload, if provided."},"modelYear":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Modelyear","description":"Vehicle model year captured during upload, if provided."},"registrationDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Registrationdate","description":"Vehicle registration date captured during upload, if provided."},"owners":{"items":{"type":"string"},"type":"array","title":"Owners","description":"Owner identifiers (emails or group names) captured during upload."},"tags":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array","title":"Tags","description":"Tags provided during the upload."},"wasAlreadyConnected":{"type":"boolean","title":"Wasalreadyconnected","description":"True when this row landed on a vehicle that was already enrolled — i.e. a re-upload that updated existing tags/owners/etc. False for a fresh enrolment. Always false unless the row completed successfully on an existing vehicle.","default":false},"investigationState":{"anyOf":[{"$ref":"#/components/schemas/InvestigationState"},{"type":"null"}],"description":"Customer-facing status of an active Volteras investigation into this VIN's connection (UNDER_REVIEW, CONTACT_OEM, CUSTOMER_ACTION, RETRY, ESCALATED_INTERNALLY). Null when there is no active investigation or the investigation status feature is not enabled for your organization."},"investigationSubState":{"anyOf":[{"$ref":"#/components/schemas/InvestigationOemSubState"},{"type":"null"}],"description":"CONTACT_OEM progression (NEEDED, REQUESTED, ONGOING); null for other investigation states."},"investigationTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Investigationtitle","description":"Display title for the current investigation status."},"investigationMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Investigationmessage","description":"Customer-appropriate explanation of the current investigation state."},"investigationUpdatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Investigationupdatedat","description":"UTC timestamp of the most recent investigation progression."}},"type":"object","required":["vehicleInputId","status","message"],"title":"VehicleInputResponse"},"VehicleInputResponseError":{"properties":{"code":{"type":"string","enum":["OEM_INCORRECT_REGION","OEM_VEHICLE_OFFLINE","OEM_VEHICLE_REMOTE_ACCESS_DISABLED","OEM_VEHICLE_DATA_SHARING_DISABLED","FLEET_CONSENT_MISSING","OEM_AUTH_DRIVER_IS_NOT_PRIMARY_USER","OEM_DEVICE_NOT_FOUND","OEM_VEHICLE_NOT_COMPATIBLE","OEM_VEHICLE_UPDATE_REQUIRED","OEM_VEHICLE_ENROLLED_WITH_ANOTHER_PROVIDER","DEVICE_LIMIT_REACHED","NOT_PERMITTED","VIN_UPLOAD_INVALID_FORMAT","INVALID_VIN","VIN_CHECK_NOT_SUPPORTED","VEHICLE_ALREADY_ADDED_TO_ORGANIZATION","VEHICLE_ALREADY_ADDED_CONNECTION_REQUIRED","VEHICLE_ALREADY_ADDED_INCOMPATIBLE","VEHICLE_ALREADY_ADDED_PENDING_CONNECTION","VIN_UPLOAD_NOT_SUPPORTED","VIN_BLACKLISTED","SUBJECTS_NOT_ASSIGNABLE"],"title":"Code","description":"Error code"},"message":{"type":"string","title":"Message","description":"Error message"},"actionCategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Actioncategory","description":"Category indicating who must act on this error: CUSTOMER_ACTION, CONTACT_SUPPORT, or UNDER_REVIEW"}},"type":"object","required":["code","message"],"title":"VehicleInputResponseError"},"VehicleJourneyResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier for the journey"},"vehicleId":{"type":"string","title":"Vehicleid","description":"Unique identifier for the vehicle"},"distanceTravelledKm":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Distancetravelledkm","description":"Distance travelled in kilometers"},"odometerStart":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Odometerstart","description":"Odometer reading at journey start in kilometers"},"odometerEnd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Odometerend","description":"Odometer reading at journey end in kilometers"},"energyUsedKwh":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energyusedkwh","description":"Energy used during journey in kWh"},"energyStartKwh":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energystartkwh","description":"Energy remaining at journey start in kWh"},"energyEndKwh":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energyendkwh","description":"Energy remaining at journey end in kWh"},"socUsed":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Socused","description":"State of charge used during journey in percent"},"socStart":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Socstart","description":"State of charge at journey start in percent"},"socEnd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Socend","description":"State of charge at journey end in percent"},"startTimestamp":{"type":"string","format":"date-time","title":"Starttimestamp","description":"Journey start timestamp"},"stopTimestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Stoptimestamp","description":"Journey stop timestamp"},"startLatitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Startlatitude","description":"Latitude at journey start"},"startLongitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Startlongitude","description":"Longitude at journey start"},"stopLatitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Stoplatitude","description":"Latitude at journey stop"},"stopLongitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Stoplongitude","description":"Longitude at journey stop"},"vin":{"type":"string","title":"Vin","description":"Vehicle identification number"}},"type":"object","required":["id","vehicleId","startTimestamp","vin"],"title":"VehicleJourneyResponse","description":"Journey response schema for API"},"VehicleListeningAuditEntry":{"properties":{"vehicleId":{"type":"string","title":"Vehicleid","description":"Unique identifier of the vehicle."},"isListening":{"type":"boolean","title":"Islistening","description":"Listening state at the recorded time."},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"When this listening state entry was recorded (UTC)."}},"type":"object","required":["vehicleId","isListening","timestamp"],"title":"VehicleListeningAuditEntry"},"VehicleListeningRequest":{"properties":{"isListening":{"type":"boolean","title":"Islistening","description":"Indicates whether the vehicle should be marked as listening for data."}},"type":"object","required":["isListening"],"title":"VehicleListeningRequest"},"VehicleListeningResponse":{"properties":{"vehicleId":{"type":"string","title":"Vehicleid","description":"Unique identifier of the vehicle."},"isListening":{"type":"boolean","title":"Islistening","description":"Reflects the requested listening state."},"lastUpdated":{"type":"string","format":"date-time","title":"Lastupdated","description":"Timestamp (UTC) representing when the listening state was last updated."}},"type":"object","required":["vehicleId","isListening","lastUpdated"],"title":"VehicleListeningResponse"},"VehicleLockStateEnum":{"type":"string","enum":["OPEN","CLOSED"],"title":"VehicleLockStateEnum","description":"Enum for lock status."},"VehicleMetaData":{"properties":{"lastSeenAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Lastseenat","description":"The last recorded interaction with the vehicle endpoints. This is a timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."},"consentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consentid","description":"Unique identifier for the consent that was used to retrieve the vehicle data."},"accountId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accountid","description":"Unique identifier for the account that was used to retrieve the vehicle data."},"registrationDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Registrationdate","description":"Vehicle registration date (ISO 8601, day granularity). Captured at vehicle upload; used as the date-axis baseline for service-interval alerts."}},"type":"object","required":["lastSeenAt","consentId","accountId"],"title":"VehicleMetaData"},"VehicleOdometer":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Odometer reading."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of length. Defaults to SI unit 'km'."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","unit","timestamp"],"title":"VehicleOdometer"},"VehicleOptions":{"properties":{"vehicleId":{"type":"string","title":"Vehicleid"},"vehicleConfig":{"$ref":"#/components/schemas/VehicleConfig"},"options":{"items":{"$ref":"#/components/schemas/Option"},"type":"array","title":"Options"}},"type":"object","required":["vehicleId","vehicleConfig","options"],"title":"VehicleOptions"},"VehicleRangeStandardEnum":{"type":"string","enum":["WLTP","NEDC","EPA","UNKNOWN"],"title":"VehicleRangeStandardEnum","description":"Enum for standards applied to vehicle"},"VehicleRealRange":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Range reading."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of length."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","title":"VehicleRealRange"},"VehicleSecurity":{"properties":{"locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Locked","description":"Vehicle lock status."},"frontRightDoor":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Front right door lock status."},"frontLeftDoor":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Front left door lock status."},"rearRightDoor":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Rear right door lock status."},"rearLeftDoor":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Rear left door lock status."},"frontRightWindow":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Front right window lock status."},"frontLeftWindow":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Front left window lock status."},"rearLeftWindow":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Rear left window lock status."},"rearRightWindow":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Rear right window lock status."},"frontTrunk":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Front trunk lock status."},"rearTrunk":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Rear trunk lock status."},"sunRoof":{"anyOf":[{"$ref":"#/components/schemas/VehicleLockStateEnum"},{"type":"null"}],"description":"Sun roof lock status."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["locked","frontRightDoor","frontLeftDoor","rearRightDoor","rearLeftDoor","frontRightWindow","frontLeftWindow","rearLeftWindow","rearRightWindow","frontTrunk","rearTrunk","sunRoof","timestamp"],"title":"VehicleSecurity"},"VehicleService":{"properties":{"component":{"$ref":"#/components/schemas/AffectedComponent","description":"Component of the vehicle that requires service, for example BRAKE_FLUID. One of the options is VEHICLE, which means it is a full vehicle service."},"type":{"$ref":"#/components/schemas/ServiceType","description":"Type of service, for example FULL_SERVICE (a full, thorough check is required for the component) or HEALTH_CHECK (a quick check is required for the component)"},"kmToNextService":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Kmtonextservice","description":"Vehicle kilometers until this service is due"},"dateOfNextServiceAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Dateofnextserviceat","description":"Date when this service is next due"},"dateOfLastServiceAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Dateoflastserviceat","description":"Date when this service was last performed"},"odometerKmAtLastService":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Odometerkmatlastservice","description":"Odometer reading when this service was last performed"},"status":{"anyOf":[{"$ref":"#/components/schemas/ServiceStatus"},{"type":"null"}],"description":"Status of the service. Currently can only be PENDING (IE service is upcoming) or NO_SERVICE_DUE, but in future may be expanded to include when the service is in progress"}},"type":"object","required":["component","type"],"title":"VehicleService","description":"Service data for a vehicle and its components"},"VehicleServices":{"properties":{"services":{"items":{"$ref":"#/components/schemas/VehicleService"},"type":"array","title":"Services"}},"type":"object","required":["services"],"title":"VehicleServices","description":"Service data for a vehicle and its components"},"VehicleSpecifications":{"properties":{"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model"},"make":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Make"},"modelYear":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Modelyear"},"batteryCapacity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batterycapacity"},"batteryCapacityNet":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batterycapacitynet"},"standardEvr":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Standardevr"},"allElectricRange":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Allelectricrange"},"allElectricRangeMin":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Allelectricrangemin"}},"type":"object","title":"VehicleSpecifications","description":"Vehicle specifications schema"},"VehicleSpeed":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Speed reading."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of length. Defaults to SI unit 'm/s'."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","unit","timestamp"],"title":"VehicleSpeed"},"VehicleStateOfCharge":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"State of charge reading."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"No unit. Percentage indicating the state of charge of the battery pack."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","unit","timestamp"],"title":"VehicleStateOfCharge"},"VehicleStateOfHealth":{"properties":{"vehicleId":{"type":"string","title":"Vehicleid"},"calculationDate":{"type":"string","format":"date","title":"Calculationdate"},"stateOfHealth":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Stateofhealth"},"batteryCapacity":{"$ref":"#/components/schemas/BatteryCapacity"}},"type":"object","required":["vehicleId","calculationDate","stateOfHealth","batteryCapacity"],"title":"VehicleStateOfHealth"},"VehicleTelemetry":{"properties":{"id":{"type":"string","title":"Id"},"odometer":{"$ref":"#/components/schemas/VehicleOdometer"},"location":{"$ref":"#/components/schemas/VehicleTelemetryLocation"},"elevation":{"$ref":"#/components/schemas/VehicleElevation"},"speed":{"$ref":"#/components/schemas/VehicleSpeed"},"heading":{"$ref":"#/components/schemas/VehicleHeading"},"stateOfCharge":{"$ref":"#/components/schemas/VehicleStateOfCharge"},"chargingState":{"$ref":"#/components/schemas/VehicleChargingState"},"range":{"$ref":"#/components/schemas/connect_models__schemas__vehicle__vehicle_telemetry__VehicleRange"},"tirePressure":{"$ref":"#/components/schemas/VehicleTirePressure"},"security":{"$ref":"#/components/schemas/VehicleSecurity"},"metadata":{"$ref":"#/components/schemas/VehicleMetaData"},"realRange":{"$ref":"#/components/schemas/VehicleRealRange"},"maxStateOfCharge":{"$ref":"#/components/schemas/VehicleChargeMaxStateOfCharge"},"chargeRemainingTime":{"$ref":"#/components/schemas/VehicleChargeRemainingTime"},"chargePowerLevel":{"$ref":"#/components/schemas/VehicleChargePowerLevel"},"chargeCurrentLimit":{"$ref":"#/components/schemas/VehicleChargeCurrentLimit"},"energyRemaining":{"$ref":"#/components/schemas/VehicleEnergyRemainingKwh"},"minStateOfCharge":{"$ref":"#/components/schemas/VehicleChargeMinStateOfCharge"}},"type":"object","required":["id","odometer","location","elevation","speed","heading","stateOfCharge","chargingState","range","tirePressure","security","metadata","realRange","maxStateOfCharge","chargeRemainingTime","chargePowerLevel","chargeCurrentLimit","energyRemaining","minStateOfCharge"],"title":"VehicleTelemetry"},"VehicleTelemetryLocation":{"properties":{"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Latitude ranges between -90 and 90 degrees, inclusive. Coordinate reference system is WGS84."},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Longitude ranges between -180 and 180 degrees, inclusive. Coordinate reference system is WGS84."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Location timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["latitude","longitude","timestamp"],"title":"VehicleTelemetryLocation"},"VehicleTirePressure":{"properties":{"frontRightTire":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Frontrighttire","description":"Front right tire pressure reading."},"frontLeftTire":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Frontlefttire","description":"Front left tire pressure reading."},"rearRightTire":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rearrighttire","description":"Rear right tire pressure reading."},"rearLeftTire":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rearlefttire","description":"Rear left tire pressure reading."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of pressure. Defaults to SI unit 'kPa'."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["frontRightTire","frontLeftTire","rearRightTire","rearLeftTire","unit","timestamp"],"title":"VehicleTirePressure"},"VehicleTiresFormatted":{"properties":{"frontLeft":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Frontleft"},"frontRight":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Frontright"},"rearLeft":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Rearleft"},"rearRight":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Rearright"},"bucket":{"type":"string","format":"date-time","title":"Bucket"}},"type":"object","required":["frontLeft","frontRight","rearLeft","rearRight","bucket"],"title":"VehicleTiresFormatted"},"VehicleTiresList":{"properties":{"tires":{"items":{"$ref":"#/components/schemas/VehicleTiresFormatted"},"type":"array","title":"Tires","default":[]}},"type":"object","title":"VehicleTiresList"},"VehicleUpdateRegistration":{"properties":{"registrationPlate":{"anyOf":[{"type":"string","maxLength":50,"minLength":1},{"type":"null"}],"title":"Registrationplate"}},"type":"object","required":["registrationPlate"],"title":"VehicleUpdateRegistration"},"Weekdays":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"title":"Weekdays"},"connect_models__schemas__vehicle__vehicle_range__VehicleRange":{"properties":{"vehicleId":{"type":"string","title":"Vehicleid"},"unit":{"type":"string","title":"Unit"},"calculationDate":{"type":"string","format":"date","title":"Calculationdate"},"range":{"$ref":"#/components/schemas/RangeDetail"}},"type":"object","required":["vehicleId","unit","calculationDate","range"],"title":"VehicleRange"},"connect_models__schemas__vehicle__vehicle_telemetry__VehicleRange":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value","description":"Range reading."},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Unit of length. Defaults to SI unit 'km'."},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","description":"Timestamp in ISO 8601 format: YYYY-MM-DDThh:mm:ssTZD."}},"type":"object","required":["value","unit","timestamp"],"title":"VehicleRange"}},"securitySchemes":{"HTTPBasic":{"type":"http","scheme":"basic"},"OAuth2ClientCredentialsBearer":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"/v1/oauth2/token"}}}}}}