{"openapi":"3.1.0","info":{"title":" ","description":"\nThis is the LinkByCar API v1. 🚗\n\nThe documentation is based on OPEN API V3 format.\nOur REST API lets your applications fetch data from the Platform of LinkByCar.\n\n\n## Documentations:\n- [Swagger UI](./documentation) - Interactive API documentation\n- [ReDoc](./redoc) - Alternative API documentation\n- [Scalar UI](./scalar) - Explore API schema\n    \n\n\n## Data Catalog\n<a href=\"/data_catalog/html\" target=\"_blank\">View our data catalog 📖</a>\n<br>\n<a href=\"/v1/data_catalog/details/html\" target=\"_blank\">View our detailed data catalog (authentication needed) 📚</a>\n    \n\n\n<details> \n  <summary>How to: <b>New Authentication</b></summary>\n  <h1>Authentication</h2>\n\n  This API uses **OpenID Connect (OIDC)** for authentication and authorization.\n\n  <h3>Interactive Login (OAuth2)</h3>\n\n  For browser-based applications and testing in Swagger:\n  1. Click the **Authorize** button at the top right\n  2. Login with your account credentials\n  3. Your account must have at least one of these roles:\n     - **USER** - Standard user access\n     - **FLEET_MANAGER** - Fleet management access\n     - **ADMIN** - Administrative access\n\n  <h3>Machine-to-Machine (M2M) Authentication</h3>\n\n  For service-to-service authentication using client credentials flow:\n\n  **Required Token Scopes:**\n  - `read` - Read access to resources\n  - `write` - Write access to resources\n\n  **Token Format:** JWT Bearer token\n\n  **Authentication Flow:**\n  1. Obtain an access token from the OAuth2 token endpoint using your client credentials\n  2. Include the token in the `Authorization` header: `Bearer <access_token>`\n  3. Make API requests with the token\n\n  **OpenID Configuration:**\n  - Discovery document: <a href=\"https://idp.linkbycar.com/realms/prod  /.well-known/openid-configuration\" target=\"_blank\">OpenID Configuration</a>\n\n  <h3>OIDC Libraries & Resources</h3>\n\n  **Python:**\n  - [requests-oauthlib](https://requests-oauthlib.readthedocs.io/) - OAuth2 for requests\n  - [authlib](https://docs.authlib.org/) - Comprehensive OAuth/OIDC library\n\n  **JavaScript/TypeScript:**\n  - [oidc-client-ts](https://authts.github.io/oidc-client-ts/) - OIDC client for browser/Node.js\n  - [openid-client](https://github.com/panva/node-openid-client) - OpenID Connect client for Node.js\n  - [axios](https://axios-http.com/) - HTTP client with interceptors for token management\n\n  **Java:**\n  - [Spring Security OAuth2](https://spring.io/projects/spring-security-oauth) -   Spring framework integration\n\n  **C# / .NET:**\n  - [IdentityModel](https://identitymodel.readthedocs.io/) - .NET library for OAuth2/OIDC\n  - [Microsoft.Identity.Web](https://learn.microsoft.com/en-us/azure/active-directory  /develop/microsoft-identity-web) - ASP.NET Core authentication\n\n  **Go:**\n  - [oauth2](https://pkg.go.dev/golang.org/x/oauth2) - OAuth2 client library\n  - [coreos/go-oidc](https://github.com/coreos/go-oidc) - OpenID Connect client\n\n  **PHP:**\n  - [league/oauth2-client](https://oauth2-client.thephpleague.com/) - OAuth2 client library\n  - [jumbojett/OpenID-Connect-PHP](https://github.com/jumbojett/OpenID-Connect-PHP) - OIDC client\n\n  **Standard Documentation:**\n  - [OpenID Connect Core](https://openid.net/specs/openid-connect-core-1_0.html) - OIDC specification\n  - [OAuth 2.0 RFC 6749](https://tools.ietf.org/html/rfc6749) - OAuth 2.0 authorization framework\n  - [RFC 7519 - JWT](https://tools.ietf.org/html/rfc7519) - JSON Web Token specification\n</details>\n    \n\n\n## Supported brands\n<div id=\"brands\">\n<a href='https://www.abarth.fr/' target='_blank' data-tooltip='Abarth'><img src='/images/brand/Abarth' alt='Abarth'/></a><a href='https://www.alfaromeo.fr/' target='_blank' data-tooltip='Alfa Roméo'><img src='/images/brand/Alfa Roméo' alt='Alfa Roméo'/></a><a href='https://www.audi.fr/fr/web/fr.html' target='_blank' data-tooltip='Audi'><img src='/images/brand/Audi' alt='Audi'/></a><a href='https://www.bmw.fr/fr/accueil.html' target='_blank' data-tooltip='BMW'><img src='/images/brand/BMW' alt='BMW'/></a><a href='https://www.chrysler.com/' target='_blank' data-tooltip='Chrysler'><img src='/images/brand/Chrysler' alt='Chrysler'/></a><a href='https://www.citroen.fr/' target='_blank' data-tooltip='Citroën'><img src='/images/brand/Citroën' alt='Citroën'/></a><a href='https://www.cupraofficial.fr/' target='_blank' data-tooltip='Cupra'><img src='/images/brand/Cupra' alt='Cupra'/></a><a href='https://www.dsautomobiles.fr/' target='_blank' data-tooltip='DS Automobiles'><img src='/images/brand/DS Automobiles' alt='DS Automobiles'/></a><a href='https://www.dacia.fr/' target='_blank' data-tooltip='Dacia'><img src='/images/brand/Dacia' alt='Dacia'/></a><a href='https://www.dodge.com/' target='_blank' data-tooltip='Dodge'><img src='/images/brand/Dodge' alt='Dodge'/></a><a href='https://www.fiat.fr/' target='_blank' data-tooltip='Fiat'><img src='/images/brand/Fiat' alt='Fiat'/></a><a href='https://www.ford.fr/' target='_blank' data-tooltip='Ford'><img src='/images/brand/Ford' alt='Ford'/></a><a href='https://www.jeep.fr/' target='_blank' data-tooltip='Jeep'><img src='/images/brand/Jeep' alt='Jeep'/></a><a href='https://www.kia.com/fr/' target='_blank' data-tooltip='Kia'><img src='/images/brand/Kia' alt='Kia'/></a><a href='https://www.lancia.fr/' target='_blank' data-tooltip='Lancia'><img src='/images/brand/Lancia' alt='Lancia'/></a><a href='https://www.lexus.fr/' target='_blank' data-tooltip='Lexus'><img src='/images/brand/Lexus' alt='Lexus'/></a><a href='https://www.maserati.com/fr' target='_blank' data-tooltip='Maserati'><img src='/images/brand/Maserati' alt='Maserati'/></a><a href='https://www.mercedes-benz.fr/' target='_blank' data-tooltip='Mercedes-Benz'><img src='/images/brand/Mercedes-Benz' alt='Mercedes-Benz'/></a><a href='https://www.mini.fr/fr_FR/home.html' target='_blank' data-tooltip='Mini'><img src='/images/brand/Mini' alt='Mini'/></a><a href='https://www.opel.fr/' target='_blank' data-tooltip='Opel'><img src='/images/brand/Opel' alt='Opel'/></a><a href='https://www.peugeot.fr/' target='_blank' data-tooltip='Peugeot'><img src='/images/brand/Peugeot' alt='Peugeot'/></a><a href='https://www.ram.com/fr/' target='_blank' data-tooltip='Ram'><img src='/images/brand/Ram' alt='Ram'/></a><a href='https://www.renault.fr/' target='_blank' data-tooltip='Renault'><img src='/images/brand/Renault' alt='Renault'/></a><a href='https://www.seat.fr/' target='_blank' data-tooltip='Seat'><img src='/images/brand/Seat' alt='Seat'/></a><a href='https://www.skoda.fr/' target='_blank' data-tooltip='Skoda'><img src='/images/brand/Skoda' alt='Skoda'/></a><a href='https://www.tesla.com/fr_fr' target='_blank' data-tooltip='Tesla'><img src='/images/brand/Tesla' alt='Tesla'/></a><a href='https://www.toyota.fr' target='_blank' data-tooltip='Toyota'><img src='/images/brand/Toyota' alt='Toyota'/></a><a href='https://www.vauxhall.co.uk/' target='_blank' data-tooltip='Vauxhall'><img src='/images/brand/Vauxhall' alt='Vauxhall'/></a><a href='https://www.volkswagen.fr/fr.html' target='_blank' data-tooltip='Volkswagen'><img src='/images/brand/Volkswagen' alt='Volkswagen'/></a><a href='https://www.volvocars.com/fr/' target='_blank' data-tooltip='Volvo'><img src='/images/brand/Volvo' alt='Volvo'/></a>\n</div>\n\n    \n    ","contact":{"name":"Linkbycar","url":"https://linkbycar.com/"},"version":"0.53.5"},"servers":[{"url":"/v1","description":"LinkByCar API v1 server"}],"paths":{"/data_catalog/json":{"get":{"tags":["DataCatalog"],"summary":"Get the list of available datapoints","description":"Retrieve the list of available datapoints in JSON format.\n\nRequires a valid data-catalog session (`dc_session` cookie).","operationId":"get_data_catalog_json_data_catalog_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataCatalogOutput"}}}}}}},"/packages":{"get":{"tags":["Package"],"summary":"Get the list of available packages","description":"**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_packages_packages_get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read","manage_vehicle"]}],"parameters":[{"name":"id","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Ids of the packages you want to retrieve. If not provided, all packages will be returned.","examples":["67bf41b2d028764b9822d51f","67c09fe141c30015389e3a55"],"title":"Id"},"description":"Ids of the packages you want to retrieve. If not provided, all packages will be returned."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackagesOutput"}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Input validation error","content":{"application/json":{"example":{"error":{"code":"InputValidationError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Input validation error"}}}}}}}},"/eligibility/vin/{vin}":{"get":{"tags":["Eligibility"],"summary":"Check if a vehicle is eligible for the service","description":"Check if a vehicle is eligible for the service.\n\n**Required Permissions:**\n\n- M2M Scope(s): `write`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"get_eligibility_eligibility_vin__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EligibilityOutput"}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/eligibility/history":{"get":{"tags":["Eligibility"],"summary":"Retrieve eligible vehicles that have been checked but are not yet active","description":"Retrieve eligible vehicles that have been checked but are not yet active.\n\n**Required Permissions:**\n\n- M2M Scope(s): `write`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"get_history_eligibility_history_get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The page size. Sorted latest to oldest.","default":10,"title":"Page Size"},"description":"The page size. Sorted latest to oldest."},{"name":"compute_total","in":"query","required":false,"schema":{"type":"boolean","description":"Compute the total number of records","default":false,"title":"Compute Total"},"description":"Compute the total number of records"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EligibilityHistoryListOutput"}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/eligibility/file":{"post":{"tags":["Eligibility"],"summary":"Check the vehicles eligibilities status and available data","description":"Check the vehicles eligibilities status and available data.\n\n**Required Permissions:**\n\n- M2M Scope(s): `write`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"get_eligibility_by_file_eligibility_file_post","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"separator","in":"query","required":false,"schema":{"type":"string","description":"The separator used in the file","default":",","title":"Separator"},"description":"The separator used in the file"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_get_eligibility_by_file_eligibility_file_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EligibilityOutput"},"title":"Response Get Eligibility By File Eligibility File Post"}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/eligibility/vins":{"post":{"tags":["Eligibility"],"summary":"Check the vehicles eligibilities status and available data","description":"Check the vehicles eligibilities status and available data.\n\n**Required Permissions:**\n\n- M2M Scope(s): `write`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"get_eligibility_by_vins_eligibility_vins_post","requestBody":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","maxItems":500,"title":"Vins","description":"The list of VINs to check","examples":[["VF1AAAAA123456788","VF1AAAAA123456789"]]}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EligibilityOutput"},"type":"array","title":"Response Get Eligibility By Vins Eligibility Vins Post"}}}},"400":{"description":"The number of VINs should be less than 500","content":{"application/json":{"example":{"error":{"code":"TooManyVinsError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The number of VINs should be less than 500"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}]}},"/vehicles":{"get":{"tags":["Vehicles"],"summary":"Get the the details of all vehicles","description":"Get the details of all vehicles.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_all_vehicles_vehicles_get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read","manage_vehicle"]}],"parameters":[{"name":"tags","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"The tags list to filter the vehicles.","title":"Tags"},"description":"The tags list to filter the vehicles."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of vehicles per page. Sorted latest to oldest.","default":10,"title":"Page Size"},"description":"The number of vehicles per page. Sorted latest to oldest."},{"name":"compute_total_count","in":"query","required":false,"schema":{"type":"boolean","description":"Compute the total count of vehicles","default":false,"title":"Compute Total Count"},"description":"Compute the total count of vehicles"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleListOutput"}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Vehicles"],"summary":"Add a new vehicle","description":"Add a new vehicle.\n\n**Required Permissions:**\n\n- M2M Scope(s): `write`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"post_vehicle_vehicles_post","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleRegisterInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOutput"}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"400":{"description":"The given package 'bad-package' is not available, available packages are: ['PAYD'].","content":{"application/json":{"example":{"error":{"code":"BadPackageError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The given package 'bad-package' is not available, available packages are: ['PAYD']."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/vehicles/vin/{vin}":{"get":{"tags":["Vehicles"],"summary":"Get the details of one vehicle for a given vin","description":"Get the details of one vehicle for a given vin.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_vehicles_by_vin_vehicles_vin__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read","manage_vehicle"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Vehicles"],"summary":"Update the details of a vehicle","description":"Update the details of a vehicle. To update the packages of vehicles belonging to the Volkswagen group, please delete\nthem and add them again after a five minutes delay.\"\n\n**Required Permissions:**\n\n- M2M Scope(s): `update`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"patch_vehicle_vehicles_vin__vin__patch","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read","manage_vehicle"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehiclePatchInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"409":{"description":"No data to update","content":{"application/json":{"example":{"error":{"code":"VehicleUpdateError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"No data to update"}}}}},"400":{"description":"No data to update","content":{"application/json":{"example":{"error":{"code":"VehicleUpdateError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"No data to update"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Vehicles"],"summary":"Delete a vehicle","description":"Delete a vehicle.\n\n**Required Permissions:**\n\n- M2M Scope(s): `delete`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"delete_vehicle_vehicles_vin__vin__delete","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/vehicles/{flag}":{"put":{"tags":["Vehicles"],"summary":"Declare a vehicle as stolen or tracking","description":"Declare a vehicle as stolen or tracking. If the vehicle is already registered, a tag will be added to the vehicle.\nIf the vehicle is not registered, it will be registered with the flag.\n\n**Required Permissions:**\n\n- M2M Scope(s): `write`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"put_vehicles_vehicles__flag__put","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"flag","in":"path","required":true,"schema":{"$ref":"#/components/schemas/VehicleFlag","description":"The flag to declare to categorize the vehicle"},"description":"The flag to declare to categorize the vehicle"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleRegisterInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOutput"}}}},"400":{"description":"The given package 'bad-package' is not available, available packages are: ['PAYD'].","content":{"application/json":{"example":{"error":{"code":"BadPackageError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The given package 'bad-package' is not available, available packages are: ['PAYD']."}}}}},"422":{"description":"Input validation failed","content":{"application/json":{"example":{"error":{"code":"VehicleDecodeError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Input validation failed"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}}}}},"/vehicles/vin/{vin}/tags":{"patch":{"tags":["Vehicles"],"summary":"Add tags to a vehicle","description":"Add tags to a vehicle.\n\n**Required Permissions:**\n\n- M2M Scope(s): `update`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"patch_tags_vehicles_vin__vin__tags_patch","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleTags"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"409":{"description":"You can not manage tags to a disabled vehicle.","content":{"application/json":{"example":{"error":{"code":"ManageTagsOnDisabledVehicleError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"You can not manage tags to a disabled vehicle."}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Vehicles"],"summary":"Replace tags to a vehicle","description":"Replace tags to a vehicle.\n\n**Required Permissions:**\n\n- M2M Scope(s): `update`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"put_tags_vehicles_vin__vin__tags_put","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleTags"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"409":{"description":"You can not manage tags to a disabled vehicle.","content":{"application/json":{"example":{"error":{"code":"ManageTagsOnDisabledVehicleError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"You can not manage tags to a disabled vehicle."}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Vehicles"],"summary":"Delete tags to a vehicle","description":"Delete tags to a vehicle.\n\n**Required Permissions:**\n\n- M2M Scope(s): `update`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"delete_tags_vehicles_vin__vin__tags_delete","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleTags"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VehicleOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"409":{"description":"You can not manage tags to a disabled vehicle.","content":{"application/json":{"example":{"error":{"code":"ManageTagsOnDisabledVehicleError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"You can not manage tags to a disabled vehicle."}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/fleets":{"get":{"tags":["Fleets"],"summary":"Get the list of fleets","description":"Get the list of fleets\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_fleets_fleets_get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of fleets per page. Sorted latest to oldest.","default":10,"title":"Page Size"},"description":"The number of fleets per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetsOutput"}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Fleets"],"summary":"Create a fleet","description":"Create a fleet\n\n**Required Permissions:**\n\n- M2M Scope(s): `write`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"create_fleet_fleets_post","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetCreation"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetOutput"}}}},"409":{"description":"The fleet 'my super fleet' is already registered","content":{"application/json":{"example":{"error":{"code":"FleetAlreadyExists","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The fleet 'my super fleet' is already registered"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/fleets/{fleetId}":{"get":{"tags":["Fleets"],"summary":"Get the fleet details","description":"Get the fleet details\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_fleet_fleets__fleetId__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"fleetId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The id of the fleet","title":"Fleetid"},"description":"The id of the fleet"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetOutput"}}}},"404":{"description":"Fleet not found","content":{"application/json":{"example":{"error":{"code":"FleetNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Fleet not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Fleets"],"summary":"Update a fleet","description":"Update a fleet\n\n**Required Permissions:**\n\n- M2M Scope(s): `update`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"update_fleet_fleets__fleetId__patch","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"fleetId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The id of the fleet","title":"Fleetid"},"description":"The id of the fleet"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetUpdating"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetOutput"}}}},"409":{"description":"The fleet 'my super fleet' is already registered","content":{"application/json":{"example":{"error":{"code":"FleetAlreadyExists","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The fleet 'my super fleet' is already registered"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Fleets"],"summary":"Delete a fleet","description":"Delete a fleet\n\n**Required Permissions:**\n\n- M2M Scope(s): `delete`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"delete_fleet_fleets__fleetId__delete","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"fleetId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The id of the fleet","title":"Fleetid"},"description":"The id of the fleet"}],"responses":{"204":{"description":"Successful Response"},"404":{"description":"Fleet not found","content":{"application/json":{"example":{"error":{"code":"FleetNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Fleet not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/fleets/{fleetId}/vins":{"patch":{"tags":["Fleets"],"summary":"Add vins to a fleet","description":"Add vins to a fleet\n\n**Required Permissions:**\n\n- M2M Scope(s): `update`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"add_vins_to_fleet_fleets__fleetId__vins_patch","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"fleetId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The id of the fleet","title":"Fleetid"},"description":"The id of the fleet"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VinsInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetOutput"}}}},"404":{"description":"Fleet not found","content":{"application/json":{"example":{"error":{"code":"FleetNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Fleet not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Fleets"],"summary":"Replace vins in a fleet","description":"Replace vins in a fleet\n\n**Required Permissions:**\n\n- M2M Scope(s): `update`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"replace_vins_to_fleet_fleets__fleetId__vins_put","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"fleetId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The id of the fleet","title":"Fleetid"},"description":"The id of the fleet"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VinsInput"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetOutput"}}}},"404":{"description":"Fleet not found","content":{"application/json":{"example":{"error":{"code":"FleetNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Fleet not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Fleets"],"summary":"Remove vins from a fleet","description":"Remove vins from a fleet\n\n**Required Permissions:**\n\n- M2M Scope(s): `update`\n\n- User Role(s): `FLEET_MANAGER` / `ADMIN`","operationId":"remove_vins_from_fleet_fleets__fleetId__vins_delete","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["manage_vehicle"]}],"parameters":[{"name":"fleetId","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The id of the fleet","title":"Fleetid"},"description":"The id of the fleet"},{"name":"vins","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"The list of vins to remove","title":"Vins"},"description":"The list of vins to remove"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetOutput"}}}},"404":{"description":"Fleet not found","content":{"application/json":{"example":{"error":{"code":"FleetNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Fleet not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/data_points/vin/{vin}":{"get":{"tags":["DataPoints"],"summary":"Get data points for a given vin","description":"Get data points for a given vin.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_data_points_by_vin_data_points_vin__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"},{"name":"fields","in":"query","required":false,"schema":{"type":"array","items":{"enum":["alert","charging","driving","dtc","electricEngine","electricity","engine","fuel","gps","indoor","light","maintenance","odometer","seatbelt","setting","tire","tracker","typeOfRoad"],"type":"string"},"description":"The fields to retrieve","title":"Fields"},"description":"The fields to retrieve"},{"name":"values","in":"query","required":false,"schema":{"type":"array","items":{"enum":["abs","absFailure","accRegulator","acceleration","accelerationLat","accelerationLatOutlierNegative","accelerationLatOutlierPositive","accelerationLatRegular","accelerationLonOutlierNegative","accelerationLonOutlierPositive","accelerationLonRegular","accelerationVertical","adBlueLevelWarning","advancedEbs","altitude","amperage","autonomy","autonomyChargingRate","autonomyMax","averageConsumption","avgElectricRangeConsumption","batteryCapacity","batteryLevel","batteryResistance","batteryStatus","batteryVoltage","blindSpotMonitoring","brakeFluidDate","brakeFluidDueDate","brakeFluidWarning","brakesPadsPreWarning","brakesPadsWarning","code","contact","coolantTemperature","cruiseControlRegulator","date","dateNext","dateRemaining","driver","drivingBehaviorMode","ecoScoreAcceleration","ecoScoreBonusRange","ecoScoreConstancy","ecoScoreFreewheel","electricEngineTemperature","electricalConsumptionSinceReset","electricalConsumptionSinceStart","endDate","endOfCharging","energyBatteryRemaining","engineBatteryWarning","engineLock","engineOilDate","engineTemperature","esp","externalTemperature","fastChargerType","fogFront","fogRear","frontLeftPressure","frontLeftWarning","frontLeftWarningStatus","frontRightPressure","frontRightWarning","frontRightWarningStatus","fse","fuelLevel","fuelLevelPercentage","fuelWarning","heading","idealBatteryRange","ignition","instantConsumption","interVehicleDistanceRegulator","internalCombustionEngineCoolantLevelWarning","internalTemperature","isCharging","laneDeparture","laneKeepAssist","laneKeepAssistLeft","laneKeepAssistRight","latitude","lightsFailure","limitSocMax","limitSocMin","limitSocStd","longitude","maxRangeChargeCounter","maxSpeed","mode","moving","name","odometer","odometerRemaining","oilLevel","oilLevelWarning","oilLowPressureWarning","oilPressure","oilTemperature","oilTemperatureWarning","parkAssistFrontAlarm","parkAssistFrontMuted","parkAssistRearAlarm","parkAssistRearMuted","passengerAirbagStatus","passengerFront","passengerRearCentral","passengerRearLeft","passengerRearRight","plugged","power","privacyMode","rate","rearLeftPressure","rearLeftWarning","rearLeftWarningStatus","rearRightPressure","rearRightWarning","rearRightWarningStatus","remainingTime","roadType","sli","sliSpeed","speed","speedLimitor","startDate","status","tankFuelLevelWarning","tankWashWaterLevelWarning","timeToComplete","tirePressureWarning","totalConsumption","transmissionGear","turn","usableBatteryLevel","value","voltage","warning","warnings"],"type":"string"},"description":"The mandatory values. The returned data points will contain at least one of these values","title":"Values"},"description":"The mandatory values. The returned data points will contain at least one of these values"},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The minimum date of the data points you want to get<p>example: 2026-11-05T19:53:17</p><p><strong>If not provided, the default value is the current date minus 7 days</strong></p>","title":"From"},"description":"The minimum date of the data points you want to get<p>example: 2026-11-05T19:53:17</p><p><strong>If not provided, the default value is the current date minus 7 days</strong></p>"},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The maximum date of the data points you want to get (example: 2026-11-05T19:53:17)","title":"To"},"description":"The maximum date of the data points you want to get (example: 2026-11-05T19:53:17)"},{"name":"latest_only","in":"query","required":false,"schema":{"type":"boolean","description":"Get all latest data points only.","default":false,"title":"Latest Only"},"description":"Get all latest data points only."},{"name":"processed_from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Return only the data that have been processed since the given date(example: 2026-11-05T19:53:17)","title":"Processed From"},"description":"Return only the data that have been processed since the given date(example: 2026-11-05T19:53:17)"},{"name":"processed_to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Return only the data that have been processed before the given date(example: 2026-11-05T19:53:17)","title":"Processed To"},"description":"Return only the data that have been processed before the given date(example: 2026-11-05T19:53:17)"},{"name":"compute_total_count","in":"query","required":false,"schema":{"type":"boolean","description":"Compute the total count of the data points<p><strong>Can highly increase request duration.</strong></p>","default":true,"title":"Compute Total Count"},"description":"Compute the total count of the data points<p><strong>Can highly increase request duration.</strong></p>"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of datapoints per page. Sorted latest to oldest.","default":10,"title":"Page Size"},"description":"The number of datapoints per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataPointsOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"504":{"description":"The data points query exceeded the server time limit. Narrow the date range, reduce page_size or set compute_total_count=false.","content":{"application/json":{"example":{"error":{"code":"DataPointQueryTimeoutError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The data points query exceeded the server time limit. Narrow the date range, reduce page_size or set compute_total_count=false."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/data_points":{"get":{"tags":["DataPoints"],"summary":"Get all data points","description":"Get all data points.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_all_data_points_data_points_get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"fields","in":"query","required":false,"schema":{"type":"array","items":{"enum":["alert","charging","driving","dtc","electricEngine","electricity","engine","fuel","gps","indoor","light","maintenance","odometer","seatbelt","setting","tire","tracker","typeOfRoad"],"type":"string"},"description":"The fields to retrieve","title":"Fields"},"description":"The fields to retrieve"},{"name":"values","in":"query","required":false,"schema":{"type":"array","items":{"enum":["abs","absFailure","accRegulator","acceleration","accelerationLat","accelerationLatOutlierNegative","accelerationLatOutlierPositive","accelerationLatRegular","accelerationLonOutlierNegative","accelerationLonOutlierPositive","accelerationLonRegular","accelerationVertical","adBlueLevelWarning","advancedEbs","altitude","amperage","autonomy","autonomyChargingRate","autonomyMax","averageConsumption","avgElectricRangeConsumption","batteryCapacity","batteryLevel","batteryResistance","batteryStatus","batteryVoltage","blindSpotMonitoring","brakeFluidDate","brakeFluidDueDate","brakeFluidWarning","brakesPadsPreWarning","brakesPadsWarning","code","contact","coolantTemperature","cruiseControlRegulator","date","dateNext","dateRemaining","driver","drivingBehaviorMode","ecoScoreAcceleration","ecoScoreBonusRange","ecoScoreConstancy","ecoScoreFreewheel","electricEngineTemperature","electricalConsumptionSinceReset","electricalConsumptionSinceStart","endDate","endOfCharging","energyBatteryRemaining","engineBatteryWarning","engineLock","engineOilDate","engineTemperature","esp","externalTemperature","fastChargerType","fogFront","fogRear","frontLeftPressure","frontLeftWarning","frontLeftWarningStatus","frontRightPressure","frontRightWarning","frontRightWarningStatus","fse","fuelLevel","fuelLevelPercentage","fuelWarning","heading","idealBatteryRange","ignition","instantConsumption","interVehicleDistanceRegulator","internalCombustionEngineCoolantLevelWarning","internalTemperature","isCharging","laneDeparture","laneKeepAssist","laneKeepAssistLeft","laneKeepAssistRight","latitude","lightsFailure","limitSocMax","limitSocMin","limitSocStd","longitude","maxRangeChargeCounter","maxSpeed","mode","moving","name","odometer","odometerRemaining","oilLevel","oilLevelWarning","oilLowPressureWarning","oilPressure","oilTemperature","oilTemperatureWarning","parkAssistFrontAlarm","parkAssistFrontMuted","parkAssistRearAlarm","parkAssistRearMuted","passengerAirbagStatus","passengerFront","passengerRearCentral","passengerRearLeft","passengerRearRight","plugged","power","privacyMode","rate","rearLeftPressure","rearLeftWarning","rearLeftWarningStatus","rearRightPressure","rearRightWarning","rearRightWarningStatus","remainingTime","roadType","sli","sliSpeed","speed","speedLimitor","startDate","status","tankFuelLevelWarning","tankWashWaterLevelWarning","timeToComplete","tirePressureWarning","totalConsumption","transmissionGear","turn","usableBatteryLevel","value","voltage","warning","warnings"],"type":"string"},"description":"The mandatory values. The returned data points will contain at least one of these values","title":"Values"},"description":"The mandatory values. The returned data points will contain at least one of these values"},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The minimum date of the data points you want to get<p>example: 2026-11-05T19:53:17</p><p><strong>If not provided, the default value is the current date minus 7 days</strong></p>","title":"From"},"description":"The minimum date of the data points you want to get<p>example: 2026-11-05T19:53:17</p><p><strong>If not provided, the default value is the current date minus 7 days</strong></p>"},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The maximum date of the data points you want to get (example: 2026-11-05T19:53:17)","title":"To"},"description":"The maximum date of the data points you want to get (example: 2026-11-05T19:53:17)"},{"name":"uuids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"The uuids of the data points you want to get<p>example: 6aecdead972ab38ce493d86b</p><p><strong>Ignored if latest_only is True</strong></p>","title":"Uuids"},"description":"The uuids of the data points you want to get<p>example: 6aecdead972ab38ce493d86b</p><p><strong>Ignored if latest_only is True</strong></p>"},{"name":"vehicle_tags","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"The tags list to filter the vehicles.","title":"Vehicle Tags"},"description":"The tags list to filter the vehicles."},{"name":"latest_only","in":"query","required":false,"schema":{"type":"boolean","description":"Get all latest data points only.","default":false,"title":"Latest Only"},"description":"Get all latest data points only."},{"name":"processed_from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Return only the data that have been processed since the given date(example: 2026-11-05T19:53:17)","title":"Processed From"},"description":"Return only the data that have been processed since the given date(example: 2026-11-05T19:53:17)"},{"name":"processed_to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"Return only the data that have been processed before the given date(example: 2026-11-05T19:53:17)","title":"Processed To"},"description":"Return only the data that have been processed before the given date(example: 2026-11-05T19:53:17)"},{"name":"compute_total_count","in":"query","required":false,"schema":{"type":"boolean","description":"Compute the total count of the data points<p><strong>Can highly increase request duration.</strong></p>","default":true,"title":"Compute Total Count"},"description":"Compute the total count of the data points<p><strong>Can highly increase request duration.</strong></p>"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of datapoints per page. Sorted latest to oldest.","default":10,"title":"Page Size"},"description":"The number of datapoints per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataPointsOutput"}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"504":{"description":"The data points query exceeded the server time limit. Narrow the date range, reduce page_size or set compute_total_count=false.","content":{"application/json":{"example":{"error":{"code":"DataPointQueryTimeoutError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The data points query exceeded the server time limit. Narrow the date range, reduce page_size or set compute_total_count=false."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/data_points/{uuid}":{"get":{"tags":["DataPoints"],"summary":"Get the data point for a given uuid","description":"Get the data point for a given uuid.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_data_points_by_uuid_data_points__uuid__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-f0-9]{24}$","description":"The uuid of the data point to get","title":"Uuid"},"description":"The uuid of the data point to get"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataPointOutput"}}}},"404":{"description":"Data point not found","content":{"application/json":{"example":{"error":{"code":"DataPointNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Data point not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"504":{"description":"The data points query exceeded the server time limit. Narrow the date range, reduce page_size or set compute_total_count=false.","content":{"application/json":{"example":{"error":{"code":"DataPointQueryTimeoutError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The data points query exceeded the server time limit. Narrow the date range, reduce page_size or set compute_total_count=false."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/soh/vin/{vin}":{"get":{"tags":["SOH"],"summary":"Get the State Of Health (SOH) of a vehicle","description":"The **State of Health** (SoH) is quantified as a percentage, indicating the battery's condition relative to its original\nstate. A value of 100% signifies a battery in its original condition, while a decline in this percentage reflects\ndeterioration influenced by factors such as charging practices and environmental temperature.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_soh_soh_vin__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SohOutput"}}}},"400":{"description":"The vehicle 'VFFFFFFFFFFFFFFFF' seems not to be electrical","content":{"application/json":{"example":{"error":{"code":"VehicleNotElectrical","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The vehicle 'VFFFFFFFFFFFFFFFF' seems not to be electrical"}}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/battery_care_score/{vin}":{"get":{"tags":["BatteryCareScore"],"summary":"Get battery care score","description":"<span class=\"badge bg-orange\">Beta</span> <b>This endpoint is in beta version and may be subject to changes.</b>\n<br><br>\n<br><br>\nThe Battery Care Score is a comprehensive measure that integrates crucial metrics such as charging habits,\nbattery temperature management, and overall battery health. This score ranges from 0 to 100, reflecting the\ndriver's ability to maintain the battery's health and extend its lifespan. A higher score indicates more\neffective and responsible battery care practices, underscoring the driver’s commitment to maintaining\noptimal battery performance and longevity.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_battery_care_score_by_vin_battery_care_score__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"},{"name":"from_date","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The date from which you want to get the vehicle battery-care data","examples":["2026-11-05T19:53:17"],"title":"From Date"},"description":"The date from which you want to get the vehicle battery-care data"},{"name":"to_date","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The date to which you want to get the vehicle battery-care data","examples":["2026-11-05T19:53:17"],"title":"To Date"},"description":"The date to which you want to get the vehicle battery-care data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatteryCareScoreOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/eco_driving/{vin}":{"get":{"tags":["EcoDriving"],"summary":"Get eco driving score","description":"<span class=\"badge bg-orange\">Beta</span> <b>This endpoint is in beta version and may be subject to changes.</b>\n<br><br>\n<br><br>\nThe ecodriving score integrates crucial metrics like driving smoothness, adherence to speed limits, and energy\nefficiency, all while considering the type of road traveled. Spanning from 0 to 100, this score mirrors the\ndriver's ability to lower energy consumption and mitigate environmental effects across diverse roadway\nenvironments. A higher score denotes superior eco-friendly driving practices, spotlighting the driver's commitment\nto conserving energy and protecting the environment.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_eco_driving_by_vin_eco_driving__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read","manage_vehicle"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin you want to decode","title":"Vin"},"description":"The vin you want to decode"},{"name":"from_date","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The date from which you want to get the vehicle eco-driving data","examples":["2026-11-05T19:53:17"],"title":"From Date"},"description":"The date from which you want to get the vehicle eco-driving data"},{"name":"to_date","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The date to which you want to get the vehicle eco-driving data","examples":["2026-11-05T19:53:17"],"title":"To Date"},"description":"The date to which you want to get the vehicle eco-driving data"},{"name":"details","in":"query","required":false,"schema":{"type":"boolean","description":"Whether to return detailed eco-driving data","default":false,"title":"Details"},"description":"Whether to return detailed eco-driving data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcoDrivingOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/trips/vin/{vin}":{"get":{"tags":["Trips"],"summary":"Get the trips for a given vin","description":"Get the trips for a given vin.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_trips_by_vin_trips_vin__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"},{"name":"load_data_points","in":"query","required":false,"schema":{"type":"boolean","description":"Load the data points","default":false,"title":"Load Data Points"},"description":"Load the data points"},{"name":"load_speed_and_direction","in":"query","required":false,"schema":{"type":"boolean","description":"Load the speed and direction","default":false,"title":"Load Speed And Direction"},"description":"Load the speed and direction"},{"name":"load_location","in":"query","required":false,"schema":{"type":"boolean","description":"Load the location","default":false,"title":"Load Location"},"description":"Load the location"},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The minimum start date of the trip you want to get (example: 2026-11-05T19:53:17)","title":"From"},"description":"The minimum start date of the trip you want to get (example: 2026-11-05T19:53:17)"},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The maximum start date of the trip you want to get (example: 2026-11-05T19:53:17)","title":"To"},"description":"The maximum start date of the trip you want to get (example: 2026-11-05T19:53:17)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of trips per page. Sorted latest to oldest.","default":1,"title":"Page Size"},"description":"The number of trips per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripsOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/trips/uuid/{uuid}":{"get":{"tags":["Trips"],"summary":"Get the trip for a given uuid","description":"Get the trip for a given uuid.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_trips_by_uuid_trips_uuid__uuid__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The uuid of the trip","title":"Uuid"},"description":"The uuid of the trip"},{"name":"load_data_points","in":"query","required":false,"schema":{"type":"boolean","description":"Load the data points","default":false,"title":"Load Data Points"},"description":"Load the data points"},{"name":"load_speed_and_direction","in":"query","required":false,"schema":{"type":"boolean","description":"Load the speed and direction","default":false,"title":"Load Speed And Direction"},"description":"Load the speed and direction"},{"name":"load_location","in":"query","required":false,"schema":{"type":"boolean","description":"Load the location","default":false,"title":"Load Location"},"description":"Load the location"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trip"}}}},"404":{"description":"Trip not found","content":{"application/json":{"example":{"error":{"code":"TripNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Trip not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/trips/uuid/{uuid}/locations":{"get":{"tags":["Trips"],"summary":"Get the locations for a given trip","description":"Get the locations for a given trip.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_locations_by_uuid_trips_uuid__uuid__locations_get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"uuid","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The uuid of the trip","title":"Uuid"},"description":"The uuid of the trip"},{"name":"interval","in":"query","required":false,"schema":{"type":"integer","minimum":0,"description":"The interval between two points (in meter)","default":0,"title":"Interval"},"description":"The interval between two points (in meter)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of trips per page. Sorted latest to oldest.","title":"Page Size"},"description":"The number of trips per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationsOutput"}}}},"404":{"description":"Trip not found","content":{"application/json":{"example":{"error":{"code":"TripNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Trip not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/battery_cycles/vin/{vin}":{"get":{"tags":["BatteryCycles"],"summary":"Get the battery_cycles for a given vin","description":"Get the battery_cycles for a given vin.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_battery_cycles_by_vin_battery_cycles_vin__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"},{"name":"load_data_points","in":"query","required":false,"schema":{"type":"boolean","description":"Load the data points","default":false,"title":"Load Data Points"},"description":"Load the data points"},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The minimum start date of the battery cycle you want to get (example: 2026-11-05T19:53:17)","title":"From"},"description":"The minimum start date of the battery cycle you want to get (example: 2026-11-05T19:53:17)"},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The maximum start date of the battery cycle you want to get (example: 2026-11-05T19:53:17)","title":"To"},"description":"The maximum start date of the battery cycle you want to get (example: 2026-11-05T19:53:17)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of battery cyles per page. Sorted latest to oldest.","default":1,"title":"Page Size"},"description":"The number of battery cyles per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatteryCyclesOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/battery_cycles/{id}":{"get":{"tags":["BatteryCycles"],"summary":"Get the battery_cycle for a given id","description":"Get the battery_cycle for a given id.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_battery_cycles_by_id_battery_cycles__id__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The id of the battery_cycle","title":"Id"},"description":"The id of the battery_cycle"},{"name":"load_data_points","in":"query","required":false,"schema":{"type":"boolean","description":"Load the data points","default":false,"title":"Load Data Points"},"description":"Load the data points"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatteryCycle"}}}},"404":{"description":"Battery cycle not found","content":{"application/json":{"example":{"error":{"code":"BatteryCycleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Battery cycle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/battery_cycles/{id}/battery_levels":{"get":{"tags":["BatteryCycles"],"summary":"Get the battery levels for a given battery cycle id","description":"Get the battery levels for a given battery cycle id.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_battery_levels_by_id_battery_cycles__id__battery_levels_get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-f]{24}$","description":"The id of the battery_cycle","title":"Id"},"description":"The id of the battery_cycle"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get Battery Levels By Id Battery Cycles  Id  Battery Levels Get"}}}},"404":{"description":"Battery cycle not found","content":{"application/json":{"example":{"error":{"code":"BatteryCycleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Battery cycle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/safety_score/{vin}":{"get":{"tags":["SafetyScore"],"summary":"Get safety score","description":"<span class=\"badge bg-orange\">Beta</span> <b>This endpoint is in beta version and may be subject to changes.</b>\n<br><br>\n<br><br>\nThe Safety Score is a comprehensive measure that integrates crucial metrics such as driving smoothness,\nadherence to speed limits, and the peak hour score, all tailored to the type of road traveled.\nThis score ranges from 0 to 100, reflecting the driver's ability to maintain safety and reduce the risk\nof accidents across various driving environments. A higher score indicates more effective and safer\ndriving practices, underscoring the driver’s commitment to road safety and responsible driving behaviors.\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_safety_score_by_vin_safety_score__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin you want to decode","title":"Vin"},"description":"The vin you want to decode"},{"name":"from_date","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The date from which you want to get the vehicle safety-score data","examples":["2026-11-05T19:53:17"],"title":"From Date"},"description":"The date from which you want to get the vehicle safety-score data"},{"name":"to_date","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The date to which you want to get the vehicle safety-score data","examples":["2026-11-05T19:53:17"],"title":"To Date"},"description":"The date to which you want to get the vehicle safety-score data"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SafetyScoreOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"401":{"description":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature","content":{"application/json":{"example":{"error":{"code":"FeatureNotAvailableInPlanException","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"This feature is not part of your plan. Please contact LinkByCar at contact@linkbycar.com if you want access to this feature"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/aggregation/interval/{vin}":{"get":{"tags":["Aggregation"],"summary":"Get list of aggregation data for a given interval","description":"<span class=\"badge bg-orange\">Beta</span> <b>This endpoint is in beta version and may be subject to changes.</b>\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_interval_by_vin_aggregation_interval__vin__get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"},{"name":"fromDate","in":"query","required":true,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"The start date of the interval you want to get (example: 2026-11-05, 2026-11-05T19:53:16)","title":"Fromdate"},"description":"The start date of the interval you want to get (example: 2026-11-05, 2026-11-05T19:53:16)"},{"name":"toDate","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"The end date of the interval you want to get (example: 2026-11-05, 2026-11-05T19:53:16)","title":"Todate"},"description":"The end date of the interval you want to get (example: 2026-11-05, 2026-11-05T19:53:16)"},{"name":"granularity","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Granularity","description":"The granularity of the interval","default":"day"},"description":"The granularity of the interval"},{"name":"data","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AggregationData"},"description":"The data to compute. If no data given, compute all.","title":"Data"},"description":"The data to compute. If no data given, compute all."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"description":"The numbers of aggregations per page. Sorted latest to oldest.","default":5,"title":"Pagesize"},"description":"The numbers of aggregations per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationIntervalListOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/aggregation/interval":{"get":{"tags":["Aggregation"],"summary":"Get list of aggregation data for a given interval","description":"<span class=\"badge bg-orange\">Beta</span> <b>This endpoint is in beta version and may be subject to changes.</b>\n\n**Required Permissions:**\n\n- M2M Scope(s): `read`\n\n- User Role(s): `USER`","operationId":"get_interval_by_vins_aggregation_interval_get","security":[{"OAuth2AuthorizationCodeBearer":[]},{"OAuth2ClientCredentials":[]},{"BearerAuth":[]},{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"vins","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"The vins of the vehicles","title":"Vins"},"description":"The vins of the vehicles"},{"name":"fromDate","in":"query","required":true,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"The start date of the interval you want to get (example: 2026-11-05, 2026-11-05T19:53:16)","title":"Fromdate"},"description":"The start date of the interval you want to get (example: 2026-11-05, 2026-11-05T19:53:16)"},{"name":"toDate","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"The end date of the interval you want to get (example: 2026-11-05, 2026-11-05T19:53:16)","title":"Todate"},"description":"The end date of the interval you want to get (example: 2026-11-05, 2026-11-05T19:53:16)"},{"name":"granularity","in":"query","required":false,"schema":{"$ref":"#/components/schemas/Granularity","description":"The granularity of the interval","default":"day"},"description":"The granularity of the interval"},{"name":"data","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AggregationData"},"description":"The data to compute. If no data given, compute all.","title":"Data"},"description":"The data to compute. If no data given, compute all."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"description":"The numbers of aggregations per page. Sorted latest to oldest.","default":5,"title":"Pagesize"},"description":"The numbers of aggregations per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationIntervalListOutput"}}}},"404":{"description":"Vehicle not found","content":{"application/json":{"example":{"error":{"code":"VehicleNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"Vehicle not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/health":{"get":{"tags":["Health"],"summary":"Get the health status of our services","description":"Get the detailed statuses of our services.","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthOutput"}}}}}}},"/status/ping":{"get":{"tags":["Status (DEPRECATED)"],"summary":"Ping the API to get the state","description":"DEPRECATED: Please use the new /health endpoint.","operationId":"ping_status_ping_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"deprecated":true}},"/users":{"post":{"tags":["Users (DEPRECATED)"],"summary":"Create a user for your company (DEPRECATED)","description":"⚠️ **DEPRECATED**: User management is now handled through our authentication service. This endpoint will be removed.","operationId":"create_user_users_post","deprecated":true,"security":[{"OAuth2PasswordBearer":["manage_company"]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUser"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOutput"}}}},"409":{"description":"The username 'my super user' is already registered","content":{"application/json":{"example":{"error":{"code":"UserAlreadyExists","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The username 'my super user' is already registered"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Users (DEPRECATED)"],"summary":"Get the users of your company (DEPRECATED)","description":"⚠️ **DEPRECATED**: User management is now handled through our authentication service. This endpoint will be removed.","operationId":"get_users_users_get","deprecated":true,"security":[{"OAuth2PasswordBearer":["manage_company"]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The number of users per page. Sorted latest to oldest.","default":10,"title":"Page Size"},"description":"The number of users per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersOutput"}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/me":{"get":{"tags":["Users (DEPRECATED)"],"summary":"Get the current user's details (DEPRECATED)","description":"⚠️ **DEPRECATED**: This endpoint is deprecated and will be removed in 6 months.\nUser management is now handled through our authentication service. Please use Keycloak account management for\nuser details.","operationId":"current_user_details_users_me_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOutput"}}}}},"deprecated":true,"security":[{"OAuth2PasswordBearer":["read","manage_vehicle","manage_company"]}]}},"/users/me/password":{"patch":{"tags":["Users (DEPRECATED)"],"summary":"Update the current user's password (DEPRECATED)","description":"⚠️ **DEPRECATED**: User management is now handled through our authentication service. This endpoint will be removed.","operationId":"update_my_password_users_me_password_patch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUser"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOutput"}}}},"404":{"description":"User not found","content":{"application/json":{"example":{"error":{"code":"UserNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"User not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true,"security":[{"OAuth2PasswordBearer":["read","manage_vehicle","manage_company"]}]}},"/users/{username}/details":{"get":{"tags":["Users (DEPRECATED)"],"summary":"Get the user details by username (DEPRECATED)","description":"⚠️ **DEPRECATED**: User management is now handled through our authentication service. This endpoint will be removed.","operationId":"get_user_users__username__details_get","deprecated":true,"security":[{"OAuth2PasswordBearer":["manage_company"]}],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","description":"The username of the user","title":"Username"},"description":"The username of the user"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOutput"}}}},"404":{"description":"User not found","content":{"application/json":{"example":{"error":{"code":"UserNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"User not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/{username}":{"delete":{"tags":["Users (DEPRECATED)"],"summary":"Delete a user by username (DEPRECATED)","description":"⚠️ **DEPRECATED**: User management is now handled through our authentication service. This endpoint will be removed.","operationId":"delete_user_users__username__delete","deprecated":true,"security":[{"OAuth2PasswordBearer":["manage_company"]}],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","description":"The username of the user","title":"Username"},"description":"The username of the user"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOutput"}}}},"404":{"description":"User not found","content":{"application/json":{"example":{"error":{"code":"UserNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"User not found"}}}}},"409":{"description":"You can't delete your own user","content":{"application/json":{"example":{"error":{"code":"CannotDeleteOwnUserError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"You can't delete your own user"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/{username}/password":{"patch":{"tags":["Users (DEPRECATED)"],"summary":"Update a user (DEPRECATED)","description":"⚠️ **DEPRECATED**: User management is now handled through our authentication service. This endpoint will be removed.","operationId":"update_password_users__username__password_patch","deprecated":true,"security":[{"OAuth2PasswordBearer":["manage_company"]}],"parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string","description":"The username of the user","title":"Username"},"description":"The username of the user"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUser"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserOutput"}}}},"404":{"description":"User not found","content":{"application/json":{"example":{"error":{"code":"UserNotFoundError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"User not found"}}}}},"500":{"description":"The application encountered an unexpected exception.","content":{"application/json":{"example":{"error":{"code":"LinkByCarApiInternalError","contact":{"team":"LinkByCar","mail":"support@linkbycar.com"},"details":[],"message":"The application encountered an unexpected exception."}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/users/company":{"get":{"tags":["Users (DEPRECATED)"],"summary":"Get the company's details (DEPRECATED)","description":"⚠️ **DEPRECATED**: This endpoint is deprecated and will be removed in 6 months.\nCompany management is now handled through our authentication service organizations or client attributes.","operationId":"current_company_details_users_company_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyOutput"}}}}},"deprecated":true,"security":[{"OAuth2PasswordBearer":["manage_company"]}]}},"/token":{"post":{"tags":["Token (DEPRECATED)"],"summary":"Create a bearer token (DEPRECATED)","description":"⚠️ **DEPRECATED**","operationId":"create_token_token_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_create_token_token_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"deprecated":true}},"/token/refresh":{"post":{"tags":["Token (DEPRECATED)"],"summary":"Refresh a bearer token using refresh token (DEPRECATED)","description":"⚠️ **DEPRECATED**","operationId":"refresh_token_refresh_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Token"}}}}},"deprecated":true,"security":[{"BearerAuth":[]}]}},"/token/.well-known/jwks.json":{"get":{"tags":["Token (DEPRECATED)"],"summary":"Get JSON Web Key Set (DEPRECATED)","description":"⚠️ **DEPRECATED**","operationId":"get_jwks_token__well_known_jwks_json_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JwksOutput"}}}}},"deprecated":true}},"/alerts/vin/{vin}":{"get":{"tags":["Alerts (DEPRECATED)"],"summary":"Get list of alerts of one vehicle for a given vin","description":"!!! This endpoint is deprecated, please use /data_points/vin/{vin} instead !!!","operationId":"get_alerts_by_vin_alerts_vin__vin__get","deprecated":true,"security":[{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"vin","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","description":"The vin of the vehicle","title":"Vin"},"description":"The vin of the vehicle"},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The minimum date of the alerts you want to get (example: 2026-11-05T19:53:16)","title":"From"},"description":"The minimum date of the alerts you want to get (example: 2026-11-05T19:53:16)"},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The maximum date of the alerts you want to get (example: 2026-11-05T19:53:16)","title":"To"},"description":"The maximum date of the alerts you want to get (example: 2026-11-05T19:53:16)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The numbers of alerts per page. Sorted latest to oldest.","default":50,"title":"Page Size"},"description":"The numbers of alerts per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertListOutput"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/alerts":{"get":{"tags":["Alerts (DEPRECATED)"],"summary":"Get list of alerts of all known vehicles","description":"!!! This endpoint is deprecated, please use /data_points instead !!!","operationId":"get_alerts_alerts_get","deprecated":true,"security":[{"OAuth2PasswordBearer":["read"]}],"parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The minimum date of the alerts you want to get (example: 2026-11-05T19:53:16)","title":"From"},"description":"The minimum date of the alerts you want to get (example: 2026-11-05T19:53:16)"},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time","description":"The maximum date of the alerts you want to get (example: 2026-11-05T19:53:16)","title":"To"},"description":"The maximum date of the alerts you want to get (example: 2026-11-05T19:53:16)"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The page number","default":1,"title":"Page"},"description":"The page number"},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"description":"The numbers of alerts per page. Sorted latest to oldest.","default":50,"title":"Page Size"},"description":"The numbers of alerts per page. Sorted latest to oldest."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertListOutput"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/version":{"get":{"tags":["Version"],"summary":"Get Version","operationId":"get_version_version_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"AggregationData":{"type":"string","enum":["distance","fuelConsumed","fuelPercentageConsumed","fuelConsumedPerHundred","fuelPercentageConsumedPerHundred","batteryConsumed","batteryPercentageConsumed","batteryConsumedPerHundred","batteryPercentageConsumedPerHundred","tripNumber","maxChargeEvBattery"],"title":"AggregationData"},"AggregationIntervalListOutput":{"properties":{"pageSize":{"type":"integer","title":"Pagesize","description":"Current data number result","default":0},"previousPage":{"type":"string","title":"Previouspage","description":"The previous page URL","default":""},"nextPage":{"type":"string","title":"Nextpage","description":"The next page URL","default":""},"totalCount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Totalcount","description":"Data result total number","default":0},"data":{"items":{"$ref":"#/components/schemas/AggregationIntervalOutput"},"type":"array","title":"Data"}},"type":"object","required":["data"],"title":"AggregationIntervalListOutput"},"AggregationIntervalOutput":{"properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","title":"Vin","description":"The vin","default":""},"fromDate":{"type":"string","format":"date-time","title":"Fromdate","description":"The start date of the interval","default":""},"toDate":{"type":"string","format":"date-time","title":"Todate","description":"The end date of the interval","default":""},"distance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Distance","description":"The distance traveled during the interval (km)"},"fuelConsumed":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fuelconsumed","description":"The fuel consumed during the interval (L)"},"fuelPercentageConsumed":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fuelpercentageconsumed","description":"The fuel percentage consumed during the interval (%)"},"fuelConsumedPerHundred":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fuelconsumedperhundred","description":"The average fuel consumed per 100 km during the interval (L)"},"fuelPercentageConsumedPerHundred":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fuelpercentageconsumedperhundred","description":"The average fuel percentage consumed during the interval (%)"},"batteryConsumed":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batteryconsumed","description":"The battery consumed during the interval (kWh)"},"batteryPercentageConsumed":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batterypercentageconsumed","description":"The battery percentage consumed during the interval (%)"},"batteryConsumedPerHundred":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batteryconsumedperhundred","description":"The average battery consumed during the interval (kWh)"},"batteryPercentageConsumedPerHundred":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batterypercentageconsumedperhundred","description":"The average battery percentage consumed during the interval (%)"},"tripNumber":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tripnumber","description":"The trip number"},"maxChargeEvBattery":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Maxchargeevbattery","description":"The max charge reached of the EV battery during the interval (%)"}},"type":"object","title":"AggregationIntervalOutput"},"AlertListOutput":{"properties":{"page_size":{"type":"integer","title":"Page Size","description":"Current alerts number result","default":""},"total_count":{"type":"integer","title":"Total Count","description":"Alerts total number","default":""},"previous_page":{"type":"string","title":"Previous Page","description":"The previous page URL","default":""},"next_page":{"type":"string","title":"Next Page","description":"The next page URL","default":""},"alerts":{"items":{"$ref":"#/components/schemas/AlertOutput"},"type":"array","title":"Alerts"}},"type":"object","required":["alerts"],"title":"AlertListOutput"},"AlertOutput":{"properties":{"name":{"type":"string","title":"Name","description":"The alert code name","default":"Alert code"},"begin":{"additionalProperties":true,"type":"object","title":"Begin","description":"The alert start informations","default":"Alert start information"},"end":{"additionalProperties":true,"type":"object","title":"End","description":"The alert end informations","default":"Alert end information"},"vin":{"type":"string","title":"Vin","description":"The vin","default":"VFFFFFFFFFFFFFFFF"}},"type":"object","title":"AlertOutput"},"BatteryCareScoreDetails":{"properties":{"totalDistanceKm":{"type":"number","minimum":0.0,"title":"Totaldistancekm","description":"Total distance driven in km","example":12299.1},"nbDeepDischarges":{"type":"integer","minimum":0.0,"title":"Nbdeepdischarges","description":"Number of deep discharges","example":19},"nbFastCharges":{"type":"integer","minimum":0.0,"title":"Nbfastcharges","description":"Number of fast charges","example":32},"nbFullCharges":{"type":"integer","minimum":0.0,"title":"Nbfullcharges","description":"Number of full charges","example":56},"nbFastChargesFull":{"type":"integer","minimum":0.0,"title":"Nbfastchargesfull","description":"Number of fast full charges","example":12},"proportionTimeAbove80PerHour":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Proportiontimeabove80Perhour","description":"Proportion of time above 80% SOC per hour","example":0.48},"proportionTimeBelow20PerHour":{"type":"number","maximum":1.0,"minimum":0.0,"title":"Proportiontimebelow20Perhour","description":"Proportion of time below 20% SOC per hour","example":0.06},"temperatureImpactScore":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Temperatureimpactscore","description":"Temperature impact score","example":93.35},"fastChargingScore":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Fastchargingscore","description":"Fast charging score","example":75.87},"deepDischargeScore":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Deepdischargescore","description":"Deep discharge score","example":33.15},"fullChargeScore":{"type":"number","maximum":100.0,"minimum":0.0,"title":"Fullchargescore","description":"Full charge score","example":30.71},"temperatureImpactMark":{"type":"string","title":"Temperatureimpactmark","description":"Temperature impact mark","example":"high"},"fastChargingMark":{"type":"string","title":"Fastchargingmark","description":"Fast charging mark","example":"high"},"deepDischargeMark":{"type":"string","title":"Deepdischargemark","description":"Deep discharge mark","example":"low"},"fullChargeMark":{"type":"string","title":"Fullchargemark","description":"Full charge mark","example":"low"},"finalScoreMark":{"type":"string","title":"Finalscoremark","description":"Final score mark","example":"low"}},"type":"object","required":["totalDistanceKm","nbDeepDischarges","nbFastCharges","nbFullCharges","nbFastChargesFull","proportionTimeAbove80PerHour","proportionTimeBelow20PerHour","temperatureImpactScore","fastChargingScore","deepDischargeScore","fullChargeScore","temperatureImpactMark","fastChargingMark","deepDischargeMark","fullChargeMark","finalScoreMark"],"title":"BatteryCareScoreDetails"},"BatteryCareScoreOutput":{"properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","title":"Vin","description":"VIN of the vehicle"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"Message to the user","example":"Vehicle not found"},"finalScore":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Finalscore","description":"Battery Care Score of the vehicle","example":80.0},"scoreDetails":{"$ref":"#/components/schemas/BatteryCareScoreDetails","description":"Details of the Battery Care Score"},"fromDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Fromdate","description":"Start date of the data","example":"2023-08-12T14:26:16.051780"},"toDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Todate","description":"End date of the data","example":"2023-09-12T14:26:16.051780"}},"type":"object","required":["vin","message"],"title":"BatteryCareScoreOutput","description":"BatteryCareScoreOutput represents the score details of a vehicle."},"BatteryCycle":{"properties":{"id":{"type":"string","title":"Id","description":"The id of the battery cycle","examples":["6aecdead972ab38ce493d866"]},"vin":{"type":"string","title":"Vin","description":"The vin of the vehicle","examples":["VFFFFFFFFFFFFFFFF"]},"startCycle":{"type":"string","format":"date-time","title":"Startcycle","description":"The battery cycle start time","examples":["2026-11-05T19:53:17"]},"endCycle":{"type":"string","format":"date-time","title":"Endcycle","description":"The battery cycle end time","examples":["2026-11-05T19:53:17"]},"previousBatteryCycle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previousbatterycycle","description":"The previous battery cycle id","examples":["6aecdead972ab38ce493d867"]},"nextBatteryCycle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nextbatterycycle","description":"The next battery cycle id","examples":["6aecdead972ab38ce493d868"]},"startCharging":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Startcharging","description":"The battery cycle start charging time","examples":["2026-11-05T19:53:17"]},"endCharging":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Endcharging","description":"The battery cycle end charging time","examples":["2026-11-05T19:53:17"]},"chargingType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chargingtype","description":"The battery cycle charging type"},"chargingDuration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Chargingduration","description":"The battery cycle charging duration (s)","examples":[180]},"numberOfUnplugging":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numberofunplugging","description":"The battery cycle number of unplugging during duration","examples":[2]},"startCycleLevel":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Startcyclelevel","description":"The battery cycle start level","examples":[80.0]},"startChargingLevel":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Startcharginglevel","description":"The battery cycle start charging level","examples":[50.0]},"endCycleLevel":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Endcyclelevel","description":"The battery cycle end level","examples":[90.0]},"batteryGainPerMinute":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batterygainperminute","description":"The battery cycle gain per minute","examples":[10.0]},"avgTempExtCharge":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avgtempextcharge","description":"The battery cycle average temperature during charging","examples":[20.0]},"avgTempExtUsage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avgtempextusage","description":"The battery cycle average temperature during usage","examples":[25.0]},"dischargingDuration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dischargingduration","description":"The battery cycle discharging duration (min)","examples":[180]},"dischargeRate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Dischargerate","description":"The battery cycle discharging rate","examples":[0.5]},"autonomyVariation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Autonomyvariation","description":"The battery cycle autonomy variation","examples":[10.0]},"autonomyAvg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Autonomyavg","description":"The battery cycle average autonomy","examples":[100.0]},"realAutonomyFull":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Realautonomyfull","description":"The battery cycle real autonomy full","examples":[500]},"consumptionAvg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Consumptionavg","description":"The battery cycle average consumption","examples":[10.0]},"lastConsumption":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lastconsumption","description":"The battery cycle last consumption","examples":[10.0]},"distance":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Distance","description":"The battery cycle distance (km)","examples":[15]},"capacity_variation":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Capacity Variation","description":"The battery cycle capacity variation","examples":[-200]},"last_capacity":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Last Capacity","description":"The battery cycle last capacity","examples":[100]},"chargingRateAvg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Chargingrateavg","description":"The battery cycle average charging rate","examples":[10.0]},"chargingPowerAvg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Chargingpoweravg","description":"The battery cycle average charging power","examples":[10.0]},"chargingVoltageAvg":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Chargingvoltageavg","description":"The battery cycle average charging voltage","examples":[10.0]},"idealBatteryRangeVariation":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Idealbatteryrangevariation","description":"The battery cycle ideal battery range variation","examples":[0.7]},"proportionTimeBelow20":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Proportiontimebelow20","description":"The battery cycle time below 20%","examples":[0.2]},"proportionTimeAbove80":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Proportiontimeabove80","description":"The battery cycle time above 80%","examples":[0.1]},"dataPoints":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Datapoints","description":"The battery cycle data points","examples":[["6aecdead972ab38ce493d869"]]}},"type":"object","required":["id","vin","startCycle","endCycle"],"title":"BatteryCycle"},"BatteryCyclesOutput":{"properties":{"pageSize":{"type":"integer","title":"Pagesize","description":"Current data number result","default":0},"previousPage":{"type":"string","title":"Previouspage","description":"The previous page URL","default":""},"nextPage":{"type":"string","title":"Nextpage","description":"The next page URL","default":""},"total_count":{"type":"integer","title":"Total Count","description":"Parameters total number","default":0},"battery_cycles":{"items":{"$ref":"#/components/schemas/BatteryCycle"},"type":"array","title":"Battery Cycles","description":"The battery cycles"}},"type":"object","required":["battery_cycles"],"title":"BatteryCyclesOutput"},"Body_create_token_token_post":{"properties":{"username":{"type":"string","title":"Username","description":"The username"},"password":{"type":"string","format":"password","title":"Password","description":"The password","writeOnly":true},"scope":{"type":"string","title":"Scope","description":"The scope"},"refresh_token":{"type":"string","title":"Refresh Token","description":"The refresh token if you want to refresh the token"}},"type":"object","title":"Body_create_token_token_post"},"Body_get_eligibility_by_file_eligibility_file_post":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File","description":"A file containing the list of VINs to check"}},"type":"object","required":["file"],"title":"Body_get_eligibility_by_file_eligibility_file_post"},"CompanyOutput":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the company","default":"Company name"},"adminEmail":{"type":"string","pattern":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","title":"Adminemail","description":"The email of the admin user","examples":["admin_email@linkbycar.com"]},"activeVehicles":{"type":"integer","title":"Activevehicles","description":"The active vehicles number registered in the company","default":0},"maximumVehicles":{"type":"integer","title":"Maximumvehicles","description":"The maximum number of vehicles that can be registered in the company","default":0}},"type":"object","required":["adminEmail"],"title":"CompanyOutput"},"CreateUser":{"properties":{"username":{"type":"string","title":"Username","description":"The id of the user","examples":["username"]},"password":{"type":"string","maxLength":128,"minLength":16,"title":"Password","description":"The password of the user","examples":["O7BfKrkGhIDVDVM8ZArtJtKWa70"]},"firstName":{"type":"string","title":"Firstname","description":"The first name of the user","examples":["first_name"]},"name":{"type":"string","title":"Name","description":"The name of the user","examples":["name"]},"email":{"type":"string","pattern":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","title":"Email","description":"The email address of the user","examples":["user@linkbycar.com"]},"userType":{"type":"string","enum":["USER","ADMIN"],"title":"Usertype","description":"The privilege of the user","examples":["USER"]}},"type":"object","required":["username","password","firstName","name","email","userType"],"title":"CreateUser"},"DataCatalogItemOutput":{"properties":{"dataPoint":{"type":"string","title":"Datapoint","description":"The data point name"},"description":{"type":"string","title":"Description","description":"The data point description"},"data":{"items":{"$ref":"#/components/schemas/DataCatalogKeyOutput"},"type":"array","title":"Data","description":"The data point details"}},"type":"object","required":["dataPoint","description","data"],"title":"DataCatalogItemOutput"},"DataCatalogKeyOutput":{"properties":{"dataName":{"type":"string","title":"Dataname","description":"The data point key"},"description":{"type":"string","title":"Description","description":"The data point description"},"unit":{"type":"string","title":"Unit","description":"The data point unit"},"type":{"type":"string","title":"Type","description":"The data point type"}},"type":"object","required":["dataName","description","unit","type"],"title":"DataCatalogKeyOutput"},"DataCatalogOutput":{"properties":{"dataPoints":{"items":{"$ref":"#/components/schemas/DataCatalogItemOutput"},"type":"array","title":"Datapoints","description":"The data points details"}},"type":"object","required":["dataPoints"],"title":"DataCatalogOutput"},"DataPointOutput":{"properties":{"uuid":{"type":"string","title":"Uuid","description":"The uuid","examples":["6aecdead972ab38ce493d86a"]},"vin":{"type":"string","title":"Vin","description":"The vin","examples":["VFFFFFFFFFFFFFFFF"]},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","description":"The timestamp of the data point","examples":["2026-11-05T19:53:17.361754"]},"field":{"type":"string","enum":["alert","charging","driving","dtc","electricEngine","electricity","engine","fuel","gps","indoor","light","maintenance","odometer","seatbelt","setting","tire","tracker","typeOfRoad"],"title":"Field","description":"The field of the data point"},"value":{"$ref":"#/components/schemas/ModelWithFields"}},"type":"object","required":["uuid","vin","timestamp","field","value"],"title":"DataPointOutput"},"DataPointsOutput":{"properties":{"page_size":{"type":"integer","title":"Page Size","description":"Current data points number result","default":0},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"Data points total number"},"previous_page":{"type":"string","title":"Previous Page","description":"The previous page URL","default":""},"next_page":{"type":"string","title":"Next Page","description":"The next page URL","default":""},"dataPoints":{"items":{"$ref":"#/components/schemas/DataPointOutput"},"type":"array","title":"Datapoints","description":"The data points"}},"type":"object","required":["dataPoints"],"title":"DataPointsOutput"},"EcoDrivingOutput":{"properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","title":"Vin","description":"VIN of the vehicle"},"score":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Score","description":"Eco-driving score of the vehicle"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"Message if no eco-driving data found","examples":["Eco-driving data not found"]},"score_smoothness":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Score Smoothness","description":"This metric evaluates the smoothness of a vehicle's operation, focusing on how accelerates, brakes, and turns. A high smoothness score would indicate a ride that's gentle and free from jarring movements, contributing to a more comfortable driving experience."},"score_sup_speed":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Score Sup Speed","description":"Assesses frequency of speeds exceeding road limits. A high score signifies speeds consistently below the limit, while a low score indicates frequent surpassing of speed limits."},"score_parking":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Score Parking","description":"Measures how often the vehicle is parked with the engine running but stationary. This metric gauges efficiency and environmental impact during idle periods."},"proportion_city":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Proportion City","description":"The percentage of driving time spent in urban or city settings, characterized by lower speeds and frequent stops."},"proportion_road":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Proportion Road","description":"The percentage of driving time on rural or suburban roads, featuring a mix of speeds and occasional stops."},"proportion_highway":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Proportion Highway","description":"The percentage of driving time on highways or freeways, with vehicles operating at high speeds and minimal stops."},"proportion_unknown":{"anyOf":[{"type":"number","maximum":1.0,"minimum":0.0},{"type":"null"}],"title":"Proportion Unknown","description":"Utilized when the driving environment does not align with the specified categories, or when driving context data is missing or indeterminate."}},"type":"object","required":["vin"],"title":"EcoDrivingOutput"},"EligibilityHistoryListOutput":{"properties":{"pageSize":{"type":"integer","title":"Pagesize","description":"Current data number result","default":0},"previousPage":{"type":"string","title":"Previouspage","description":"The previous page URL","default":""},"nextPage":{"type":"string","title":"Nextpage","description":"The next page URL","default":""},"totalCount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Totalcount","description":"The total count of histories"},"history":{"items":{"$ref":"#/components/schemas/EligibilityHistoryOutput"},"type":"array","title":"History"}},"type":"object","required":["history"],"title":"EligibilityHistoryListOutput"},"EligibilityHistoryOutput":{"properties":{"vin":{"type":"string","title":"Vin","description":"The vin of the vehicle","default":"VFFFFFFFFFFFFFFFF"},"manufacturer":{"type":"string","title":"Manufacturer","description":"The manufacturer of the vehicle","default":""},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"The creation date of the vehicle"}},"type":"object","required":["createdAt"],"title":"EligibilityHistoryOutput"},"EligibilityOutput":{"properties":{"vin":{"type":"string","title":"Vin","description":"The vin of the vehicle","examples":["VFXXXXXXXXXXXXX"]},"manufacturer":{"type":"string","title":"Manufacturer","description":"The manufacturer of the vehicle","default":""},"eligible":{"type":"boolean","title":"Eligible","description":"The eligibility status","default":true},"comment":{"type":"string","title":"Comment","default":""},"oemComment":{"type":"string","title":"Oemcomment","description":"Comment returned by the OEM","default":""},"availablePackages":{"items":{"type":"string"},"type":"array","title":"Availablepackages","description":"The available packages","default":[]},"needManualCheck":{"type":"boolean","title":"Needmanualcheck","description":"Whether the eligibility requires a manual check (e.g. Volkswagen group)","default":false}},"type":"object","required":["vin"],"title":"EligibilityOutput"},"FleetCreation":{"properties":{"vins":{"items":{"type":"string"},"type":"array","title":"Vins","description":"The list of vins","default":[]},"name":{"type":"string","title":"Name","description":"The name of the fleet","examples":["My fleet"]}},"type":"object","required":["name"],"title":"FleetCreation"},"FleetOutput":{"properties":{"id":{"type":"string","title":"Id","description":"The id of the fleet","examples":["6aecdead972ab38ce493d86c"]},"name":{"type":"string","title":"Name","description":"The name of the fleet","examples":["My super fleet"]},"vins":{"items":{"type":"string"},"type":"array","title":"Vins","description":"The list of vins","examples":["VFFFFFFFFFFFFFFFF"]}},"type":"object","required":["id","name","vins"],"title":"FleetOutput"},"FleetUpdating":{"properties":{"name":{"type":"string","title":"Name","description":"The new name of the fleet","examples":["My new fleet"]}},"type":"object","required":["name"],"title":"FleetUpdating"},"FleetsOutput":{"properties":{"pageSize":{"type":"integer","title":"Pagesize","description":"Current data number result","default":0},"previousPage":{"type":"string","title":"Previouspage","description":"The previous page URL","default":""},"nextPage":{"type":"string","title":"Nextpage","description":"The next page URL","default":""},"totalCount":{"type":"integer","title":"Totalcount","description":"Fleets total number","default":0},"fleets":{"items":{"$ref":"#/components/schemas/FleetOutput"},"type":"array","title":"Fleets","description":"The list of fleets"}},"type":"object","required":["fleets"],"title":"FleetsOutput"},"Granularity":{"type":"string","enum":["day","week","month"],"title":"Granularity"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthComponent":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the component","examples":["Database","Authentication Service"]},"status":{"$ref":"#/components/schemas/HealthComponentStatus","description":"The status of the component"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment","description":"An optional comment about the component status"}},"type":"object","required":["name","status"],"title":"HealthComponent"},"HealthComponentStatus":{"type":"string","enum":["HEALTHY","DEGRADED","DOWN"],"title":"HealthComponentStatus"},"HealthOutput":{"properties":{"status":{"$ref":"#/components/schemas/HealthStatus","description":"The overall health status"},"comment":{"type":"string","title":"Comment","description":"A comment about the overall health status","default":"All systems operational"},"components":{"items":{"$ref":"#/components/schemas/HealthComponent"},"type":"array","title":"Components","description":"The detailed statuses of the components"}},"type":"object","required":["status","components"],"title":"HealthOutput"},"HealthStatus":{"type":"string","enum":["HEALTHY","DEGRADED"],"title":"HealthStatus"},"JwksOutput":{"properties":{"keys":{"items":{"$ref":"#/components/schemas/JwtOutput"},"type":"array","title":"Keys"}},"type":"object","required":["keys"],"title":"JwksOutput"},"JwtOutput":{"properties":{"kty":{"type":"string","title":"Kty","examples":["RSA"]},"use":{"type":"string","title":"Use","examples":["sig"]},"alg":{"type":"string","title":"Alg","examples":["RS256"]},"kid":{"type":"string","title":"Kid","examples":["key-id"]},"n":{"type":"string","title":"N","examples":["n"]},"e":{"type":"string","title":"E","examples":["e"]}},"type":"object","required":["kty","use","alg","kid","n","e"],"title":"JwtOutput"},"Location":{"$ref":"#/components/schemas/LocationDetails","title":"Location"},"LocationDetails":{"properties":{"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"The latitude value","examples":[15.5]},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"The longitude value","examples":[8.31]},"altitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Altitude","description":"The altitude value","examples":[10.0]},"timestamp":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Timestamp","examples":["2026-11-05T19:53:17"]}},"type":"object","title":"LocationDetails"},"LocationsOutput":{"properties":{"pageSize":{"type":"integer","title":"Pagesize","description":"Current data number result","default":0},"previousPage":{"type":"string","title":"Previouspage","description":"The previous page URL","default":""},"nextPage":{"type":"string","title":"Nextpage","description":"The next page URL","default":""},"locations":{"items":{"$ref":"#/components/schemas/Location"},"type":"array","title":"Locations","description":"The locations"}},"type":"object","required":["locations"],"title":"LocationsOutput"},"ModelWithFields":{"properties":{"speed":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Speed","description":"Current speed of the engine in rotations per minute (RPM)"},"oilTemperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Oiltemperature","description":"Temperature of the engine oil"},"endDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Enddate","description":"Date when the alert was firstly resolved"},"ignition":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ignition","description":"Operational state of the engine's ignition system - whether the engine is running or stopped (true/false)"},"oilLevel":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Oillevel","description":"Current level of engine oil"},"oilPressure":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Oilpressure","description":"Pressure of the engine oil within the engine's lubrication system"},"contact":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Contact","description":"Status of the vehicle's electrical system, indicating whether the ignition is in the 'on' position"},"rearRightWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rearrightwarning","description":"Warning related to the rear right tire of a vehicle (true/false)"},"driver":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Driver","description":"Whether the driver's seatbelt is fastened (true/false)"},"passengerRearLeft":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Passengerrearleft","description":"Whether the rear left passenger seatbelt is securely fastened"},"altitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Altitude","description":"Vehicle's height above sea level at its last known position"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the alert such as:\r\nturnSignalFailureRearRight\r\ntrunkHoodOpen\r\nrearLeftDoorOpenLowSpeed\r\nfrontLeftDoorOpenLowSpeed\r\ntrunkHoodOpenLowSpeed\r\nstopLightFailureRight\r\nfrontRightDoorOpenLowSpeed\r\nrearRightDoorOpenLowSpeed\r\nshiftToPark\r\nlowFuelLevel\r\nfrontLeftDoorOpen\r\nrearRightDoorOpen\r\nfrontRightDoorOpen\r\nparkingAssistanceSystemFailure\r\nelectricTractionSystemFault\r\nlowEngineOilLevel\r\nturnSignalFailureFrontRight\r\nbrakePadsExcessiveWear\r\nparkingBrakeOrHillHolderFailure\r\ncollisionDetectionSystemFault\r\nengineControlSystemFailure"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Indicates the current operational state of the engine, such as: off, start-and-stop, starting, running"},"rate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rate","description":"The speed at which the battery is being charged or discharged"},"accelerationLat":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accelerationlat","description":"Lateral acceleration: side-to-side movement or turning forces"},"batteryCapacity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batterycapacity","description":"Total electrical charge storage capacity of the 12V battery"},"longitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Longitude","description":"Vehicle's last known east-west position on the Earth's surface, also expressed in WGS84 coordinates"},"odometer":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Odometer","description":"Estimated odometer when the next maintenance should be done"},"roadType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Roadtype","description":"Type of road: city, road, highway"},"acceleration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Acceleration","description":"Longitudinal acceleration: rate at which the vehicle's speed increases or decreases"},"autonomy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Autonomy","description":"Estimated distance the vehicle can travel with the remaining fuel, based on current fuel level and average consumption rates"},"frontLeftWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Frontleftwarning","description":"Warning related to the front left tire of a vehicle (true/false)"},"voltage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Voltage","description":"Tracker's battery voltage"},"batteryResistance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batteryresistance","description":"Internal resistance of the 12V battery"},"rearRightPressure":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rearrightpressure","description":"Tire pressure of the vehicle's rear right wheel"},"heading":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Heading","description":"Moving direction, represented in degrees from true north"},"startDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Startdate","description":"Date when the alert was firstly initiated"},"coolantTemperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Coolanttemperature","description":"Temperature of the engine coolant"},"frontLeftPressure":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Frontleftpressure","description":"Tire pressure of the vehicle's front left wheel"},"warning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Warning","description":"A general alert related to the seatbelt system, possibly indicating that one or more passengers have not fastened their seatbelts (true/false)"},"endOfCharging":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Endofcharging","description":"The date when the last charging session concluded"},"externalTemperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Externaltemperature","description":"Temperature outside the vehicle at its last known position"},"latitude":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Latitude","description":"Vehicle's last known north-south position on the Earth's surface, expressed in WGS84 coordinates"},"remainingTime":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Remainingtime","description":"Estimated time left to fully charge the battery from its current state"},"passengerRearRight":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Passengerrearright","description":"Whether the rear right passenger seatbelt is securely fastened"},"fuelLevelPercentage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fuellevelpercentage","description":"Current fuel level as a percentage of the tank's total capacity"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Diagnostic Trouble Code"},"frontRightWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Frontrightwarning","description":"Warning related to the front right tire of a vehicle (true/false)"},"mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mode","description":"Charging mode of the EV's battery: quick/slow"},"plugged":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Plugged","description":"Whether the vehicle is connected to a charging station or power source (true/false)"},"power":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Power","description":" Rate at which energy is transferred to or from the vehicle's battery during charging or operation"},"fuelLevel":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fuellevel","description":"Absolute quantity of fuel in the vehicle's tank"},"rearLeftWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rearleftwarning","description":"Warning related to the rear left tire of a vehicle (true/false)"},"passengerFront":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Passengerfront","description":"Whether the front passenger seatbelt is securely fastened"},"frontRightPressure":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Frontrightpressure","description":"Tire pressure of the vehicle's front right wheel"},"instantConsumption":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Instantconsumption","description":"Vehicle's fuel consumption in real-time"},"totalConsumption":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Totalconsumption","description":"The total amount of fuel consumed by the vehicle over its lifetime"},"odometerRemaining":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Odometerremaining","description":"Estimated distance that can be traveled before the next maintenance\r\n"},"maxSpeed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxspeed","description":"Speed limit of the road "},"averageConsumption":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Averageconsumption","description":"Average fuel consumption"},"avgElectricRangeConsumption":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avgelectricrangeconsumption","description":"Average energy consumption of the EV"},"value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value","description":""},"batteryLevel":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batterylevel","description":"Current state of charge (SOC) of the EV's battery"},"batteryVoltage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Batteryvoltage","description":"Current voltage of the 12V battery"},"rearLeftPressure":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Rearleftpressure","description":"Tire pressure of the vehicle's rear left wheel"},"passengerRearCentral":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Passengerrearcentral","description":"Whether the rear central passenger seatbelt is securely fastened"},"limitSocStd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Limitsocstd","description":"Standard State of Charge (SOC) limit recommended for regular use"},"limitSocMax":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Limitsocmax","description":"Maximum State of Charge (SOC) limit set for the battery to prevent overcharging"},"maxRangeChargeCounter":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Maxrangechargecounter","description":""},"brakesPadsPreWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Brakespadsprewarning","description":"Indicates whether a Prewarning for the Brakepads is triggered"},"internalCombustionEngineCoolantLevelWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Internalcombustionenginecoolantlevelwarning","description":"Indicates whether a warning for the coolant level is triggered"},"parkAssistFrontMuted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Parkassistfrontmuted","description":"The system notifies if the front Park Assist is enabled."},"abs":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Abs","description":"Inform if the ABS system is active. ABS (Anti-lock Braking System) prevents the wheels from locking up during sudden braking by automatically modulating brake pressure. This helps maintain vehicle stability and steering control, reducing the risk of skidding."},"frontRightWarningStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Frontrightwarningstatus","description":"Provides status of present warning for front right tire."},"tankWashWaterLevelWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tankwashwaterlevelwarning","description":"Indicates whether a warning for the washwater level is triggered"},"brakeFluidDueDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Brakefluidduedate","description":"Date when the brake fluid should be replaced"},"electricalConsumptionSinceStart":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Electricalconsumptionsincestart","description":"Electric energy consumption from start in kiloWatthours per 100 kilometer (kWh/100km). Only available for Electric Vehicles.\r\nThe SinceStart time refers to time the ignition is turned. Ignition-on starts a new trip session, unless the last ignition off event took place within the last 4 hours."},"brakeFluidWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Brakefluidwarning","description":"Indicates whether a Brakefluid Warning is triggered"},"brakesPadsWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Brakespadswarning","description":"Indicates whether a Warning for the Brakepads is triggered"},"electricalConsumptionSinceReset":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Electricalconsumptionsincereset","description":"Electric energy consumption since reset in kiloWatthours per 100 kilometer (kWh/100km). Only available for Electric Vehicles. The SinceReset time refers to the time a trip session was reset using in the vehicles board computer."},"fogFront":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fogfront","description":"Indicates the operational status (true/false) of the vehicle's front fog lights"},"batteryStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Batterystatus","description":"Provides the supply battery health status of the 12 V Battery. GREEN = ok, YELLOW = recommend to charge, RED = vehicle engine will most likely not start.\r\n"},"speedLimitor":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Speedlimitor","description":"Inform if the Speed Limitor system is active. The speed limiter allows the driver to set a maximum speed for the vehicle, preventing unintentional exceedance of the speed limit and contributing to road safety."},"parkAssistRearAlarm":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Parkassistrearalarm","description":"The system notifies if the rear Park Assist has been activated."},"idealBatteryRange":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Idealbatteryrange","description":""},"fuelWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fuelwarning","description":"Indicates whether the remaining range with liquid fuel is critical"},"parkAssistRearMuted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Parkassistrearmuted","description":"The system notifies if the rear Park Assist is enabled."},"laneKeepAssistRight":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lanekeepassistright","description":"Notify if the lane keep right assist is active."},"blindSpotMonitoring":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Blindspotmonitoring","description":"Inform if the Blind Spot Monitoring system is active. Blind Spot Monitoring is a safety system that uses sensors to detect vehicles in the driver's blind spots. When a vehicle is detected, the system alerts the driver with a visual or audible signal, helping to prevent collisions during lane changes."},"interVehicleDistanceRegulator":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Intervehicledistanceregulator","description":"Inform if the Inter-Vehicle Distance Regulator system is active. The Inter-Vehicle Distance Regulator automatically adjusts the vehicle's speed to maintain a safe distance from other vehicles on the road, enhancing safety and driving comfort."},"privacyMode":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Privacymode","description":"Privacy mode disables data collection or information sharing features, ensuring the privacy protection of the vehicle's occupants."},"internalTemperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Internaltemperature","description":"Temperature inside the vehicle's cabin"},"frontLeftWarningStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Frontleftwarningstatus","description":"Provides status of present warning for front left tire."},"tankFuelLevelWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tankfuellevelwarning","description":"Indicates whether a warning for the liquid fuel level is triggered"},"parkAssistFrontAlarm":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Parkassistfrontalarm","description":"The system notifies if the front Park Assist has been activated."},"esp":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Esp","description":"Inform if the ESP system is active. ESP (Electronic Stability Program) is a safety system that enhances vehicle stability by detecting and reducing loss of traction. It does this by automatically applying brakes to specific wheels and adjusting engine power to help the driver maintain control of the vehicle."},"date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date","description":"Last maintenance date"},"autonomyMax":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Autonomymax","description":"Maximum electrical range when battery is fully charged (100% state of charge) in kilometer (km). This can vary depending on the environmental situation, e.g. outside temperature.\r\nOnly available for Electric & Plugin Hybrid Vehicles."},"dateRemaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dateremaining","description":"Remaining days before next maintenance"},"engineOilDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Engineoildate","description":"Date when the engine oil was last changed"},"turn":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Turn","description":"Status of the vehicle's turn signal lights (left/right)"},"sli":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Sli","description":"Inform if the SLI system is active. The SLI (Speed Limit Information) system uses cameras and GPS data to detect speed limit signs and inform the driver of the current speed limits. This information is displayed on the vehicle's dashboard or navigation screen."},"warnings":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Warnings","description":"Warnings status (true/false)"},"engineBatteryWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enginebatterywarning","description":"Indicates whether a warning for the 12V battery is triggered"},"passengerAirbagStatus":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Passengerairbagstatus","description":"Inform if the passenger airbag system is active."},"fogRear":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fogrear","description":"Indicates the operational status (true/false) of the vehicle's rear fog lights"},"limitSocMin":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Limitsocmin","description":"Minimum State of Charge (SOC) threshold to maintain essential vehicle functions and battery health"},"usableBatteryLevel":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Usablebatterylevel","description":"Current amount of battery charge available for driving"},"laneKeepAssistLeft":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lanekeepassistleft","description":"Notify if the lane keep left assist is active."},"dateNext":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Datenext","description":"Next maintenance date"},"accRegulator":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Accregulator","description":"Inform if the AAC Regulator system is active. Adaptive Cruise Control automatically adjusts the vehicle's speed to maintain a safe distance from other vehicles on the road, providing a more comfortable driving experience by regulating speed and following distance based on traffic conditions."},"cruiseControlRegulator":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Cruisecontrolregulator","description":"Inform if the Cruise control system is active. Cruise control maintains a constant speed set by the driver, enabling a more relaxed driving experience on highways and long journeys."},"rearRightWarningStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rearrightwarningstatus","description":"Provides status of present warning for rear right tire."},"fse":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Fse","description":"Inform if the FSE system is active. The FSE (Fuel Shutoff System) is a safety device that cuts off the fuel supply to the engine in the event of a collision. This reduces the risk of fire by preventing fuel from leaking and igniting."},"advancedEbs":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Advancedebs","description":""},"brakeFluidDate":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Brakefluiddate","description":"Date when the brake fluid was last replaced"},"rearLeftWarningStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rearleftwarningstatus","description":"Provides status of present warning for rear left tire."},"laneDeparture":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lanedeparture","description":"Inform if the Lane Departure system is active. Lane Departure Warning system alerts the driver when they unintentionally drift out of their lane, helping to prevent accidents caused by inattention or drowsiness."},"energyBatteryRemaining":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Energybatteryremaining","description":"remaining energy of the battery expressed in kWh"},"engineTemperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Enginetemperature","description":"Temperature of the engine."},"electricEngineTemperature":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Electricenginetemperature","description":"Temperature of the electric engine."},"accelerationVertical":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accelerationvertical","description":"Vertical acceleration (can happen on slopes)"},"moving":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Moving","description":"Indicates if the vehicle is moving"},"drivingBehaviorMode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Drivingbehaviormode","description":"Refers to the selected driving mode or style that influences vehicle performance and responsiveness. It can include modes such as eco (optimized for fuel efficiency), sport (enhanced performance and responsiveness), normal (balanced settings), or hybrid (automatically adjusting between modes for optimal efficiency)."},"laneKeepAssist":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lanekeepassist","description":"LaneKeepAssist is a driver-assistance feature that helps keep the vehicle centered within its lane. It uses cameras or sensors to detect lane markings on the road and can provide gentle steering inputs or alerts if the vehicle begins to drift unintentionally, enhancing safety and reducing driver fatigue."},"transmissionGear":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transmissiongear","description":"TransmissionGear refers to the current gear selected or engaged in a vehicle's transmission system. It determines the ratio between engine speed and wheel speed, affecting acceleration, fuel efficiency, and overall driving performance. This can include automatic, manual, or semi-automatic gear selections such as p, d1, d2, etc."},"engineLock":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enginelock","description":""},"absFailure":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Absfailure","description":""},"lightsFailure":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Lightsfailure","description":""},"adBlueLevelWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Adbluelevelwarning","description":""},"oilLevelWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Oillevelwarning","description":""},"oilLowPressureWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Oillowpressurewarning","description":""},"accelerationLonOutlierNegative":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accelerationlonoutliernegative","description":"Duration in ms where negative longitudinal acceleration has exceeded the defined threshold (< - 0,2g) during the given measurement window."},"accelerationLonOutlierPositive":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accelerationlonoutlierpositive","description":"Duration in ms where positive longitudinal acceleration has exceeded the defined threshold (> 0,2g) during the given measurement window."},"accelerationLatOutlierPositive":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accelerationlatoutlierpositive","description":"Duration in ms where positive latitudinal acceleration has exceeded the defined threshold (> 0,2g) during the given measurement window."},"accelerationLatOutlierNegative":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accelerationlatoutliernegative","description":"Duration in ms where negative latitudinal acceleration has exceeded the defined threshold (< - 0,2g) during the given measurement window."},"accelerationLatRegular":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accelerationlatregular","description":"Duration in ms where latitudinal acceleration has not exceeded the defined threshold (between +/- 0,2g) during the given measurement window."},"accelerationLonRegular":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accelerationlonregular","description":"Duration in ms where longitudinal acceleration has not exceeded the defined threshold (between +/- 0,2g) during the given measurement window."},"sliSpeed":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Slispeed","description":"Limit speed set. The SLI (Speed Limit Information) system uses cameras and GPS data to detect speed limit signs and inform the driver of the current speed limits. This information is displayed on the vehicle's dashboard or navigation screen."},"amperage":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Amperage","description":""},"autonomyChargingRate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Autonomychargingrate","description":"How many Kilometers of autonomy you gain per hour at the current charging rate"},"fastChargerType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fastchargertype","description":""},"isCharging":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ischarging","description":""},"timeToComplete":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Timetocomplete","description":""},"oilTemperatureWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Oiltemperaturewarning","description":""},"tirePressureWarning":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Tirepressurewarning","description":""},"ecoScoreAcceleration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ecoscoreacceleration","description":"ECOscore rating acceleration percentage points (0% - 100%)"},"ecoScoreBonusRange":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ecoscorebonusrange","description":"Bonus score"},"ecoScoreConstancy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ecoscoreconstancy","description":"ECOscore rating constancy percentage points (0% - 100%)"},"ecoScoreFreewheel":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ecoscorefreewheel","description":"ECOscore rating free wheeling percentage points (0% - 100%)"}},"type":"object","title":"ModelWithFields"},"PackageOutput":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the package","default":"6465217ab47fd9efed848cd3"},"name":{"type":"string","title":"Name","description":"The name of the package","default":"my package"},"description":{"type":"string","title":"Description","description":"The description of the package","default":"This is an example"}},"type":"object","title":"PackageOutput"},"PackagesOutput":{"properties":{"packages":{"items":{"$ref":"#/components/schemas/PackageOutput"},"type":"array","title":"Packages"}},"type":"object","required":["packages"],"title":"PackagesOutput"},"SafetyScoreOutput":{"properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","title":"Vin","description":"VIN of the vehicle"},"safetyScore":{"anyOf":[{"type":"number","maximum":100.0,"minimum":-1.0},{"type":"null"}],"title":"Safetyscore","description":"Safety score of the vehicle"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message","description":"Message if no safety score data found","examples":["Safety data not found"]},"scoreSmoothness":{"anyOf":[{"type":"number","maximum":100.0,"minimum":-1.0},{"type":"null"}],"title":"Scoresmoothness","description":"This metric evaluates the smoothness of a vehicle's operation, focusing on how it accelerates, brakes, and turns. A high smoothness score would indicate a ride that's gentle and free from jarring movements, contributing to a more comfortable driving experience."},"scoreOverspeed":{"anyOf":[{"type":"number","maximum":100.0,"minimum":-1.0},{"type":"null"}],"title":"Scoreoverspeed","description":"Assesses frequency of speeds exceeding road limits. A high score signifies speeds consistently below the limit, while a low score indicates frequent surpassing of speed limits."},"drivingTimeExposureRisk":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Drivingtimeexposurerisk","description":"Designed to quantify the risk associated with driving during specific hours on particular days of the week. It employs a scale from 0 to 100, where a score of 100 represents the lowest risk of road incidents, and a score of 0 indicates the highest risk. This score is calculated based on an analysis of public data on accident statistics."},"typeOfRoadExposureRisk":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Typeofroadexposurerisk","description":"This score evaluates the risk associated with driving on different types of roads, such as highways, urban streets, or rural roads. A higher score indicates safer driving conditions, while a lower score suggests increased risk due to road type."},"proportionTimeByTypeOfRoad":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Proportiontimebytypeofroad","description":"This field provides a breakdown of the time spent driving on various types of roads, ","example":{"0-30kmh":0.13,"110-130kmh":0,"30-50kmh":0.87,"50-70kmh":0,"70-90kmh":0,"90-110kmh":0}},"events":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Events","description":"This field provides a breakdown of the number of events that occurred during the period for which the safety score is calculated. The events are categorized by type, such as 'over_speed' or 'smoothness'.","example":{"count_hard_acceleration":5,"count_hard_braking":3,"count_hard_turning":2}}},"type":"object","required":["vin"],"title":"SafetyScoreOutput","description":"SafetyScoreOutput represents the safety score details of a vehicle.","example":{"driving_time_exposure_risk":75.0,"events":{"count_hard_acceleration":2,"count_hard_braking":1,"count_hard_cornering":0},"proportion_time_by_type_of_road":{"0-30kmh":0.1,"110-130kmh":0.1,"30-50kmh":0.2,"50-70kmh":0.3,"70-90kmh":0.2,"90-110kmh":0.1},"safety_score":85.5,"score_over_speed":80.0,"score_smoothness":90.0,"type_of_road_exposure_risk":70.0,"vin":"1HGCM82633A123456"}},"SohOutput":{"properties":{"stateOfHealth":{"type":"number","title":"Stateofhealth","description":"The state of health","examples":[99.99],"gte":0,"lte":100},"vin":{"type":"string","title":"Vin","description":"The vin","default":"VFFFFFFFFFFFFFFFF"}},"type":"object","required":["stateOfHealth"],"title":"SohOutput"},"SpeedAndDirection":{"$ref":"#/components/schemas/SpeedAndDirectionDetails","title":"SpeedAndDirection"},"SpeedAndDirectionDetails":{"properties":{"speed":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Speed","description":"The speed value","examples":[0.0]},"heading":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Heading","description":"The direction value","examples":[0.0]},"timestamp":{"type":"string","format":"date-time","title":"Timestamp","examples":["2026-11-05T19:53:17"]}},"type":"object","required":["timestamp"],"title":"SpeedAndDirectionDetails"},"Token":{"properties":{"access_token":{"type":"string","title":"Access Token","examples":["eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImtleS1pZA"]},"refresh_token":{"type":"string","title":"Refresh Token","examples":["eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImtleS1pZA"]},"token_type":{"type":"string","title":"Token Type","description":"The token type","examples":["bearer"]},"expires_in":{"type":"integer","title":"Expires In","description":"The token expiration time in seconds","examples":[1800]},"expires_at":{"type":"integer","title":"Expires At","description":"The token expiration timestamp","examples":[1793908397.742913]}},"type":"object","required":["access_token","refresh_token","token_type","expires_in","expires_at"],"title":"Token"},"Trip":{"properties":{"uuid":{"type":"string","title":"Uuid","description":"The uuid of the trip","examples":["6aecdead972ab38ce493d86d"]},"vin":{"type":"string","title":"Vin","description":"The vin of the vehicle","examples":["VFFFFFFFFFFFFFFFF"]},"previousTrip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Previoustrip","description":"The previous trip uuid","examples":["6aecdead972ab38ce493d86e"]},"nextTrip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nexttrip","description":"The next trip uuid","examples":["6aecdead972ab38ce493d86f"]},"start":{"type":"string","format":"date-time","title":"Start","description":"The trip start time","examples":["2026-11-05T19:53:17"]},"startLocation":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}],"description":"The trip start location"},"end":{"type":"string","format":"date-time","title":"End","description":"The trip end time","examples":["2026-11-05T19:53:17"]},"endLocation":{"anyOf":[{"$ref":"#/components/schemas/Location"},{"type":"null"}],"description":"The trip end location"},"distance":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Distance","description":"The trip distance (km)","examples":[15.5]},"duration":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration","description":"The trip duration (s)","examples":[180.0]},"totalConsumption":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Totalconsumption","description":"The trip total consumption (l)","examples":[8.0]},"totalElectricConsumption":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Totalelectricconsumption","description":"The trip total electric consumption (%)","examples":[3.0]},"dataPoints":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Datapoints","description":"The trip data points","examples":[["6aecdead972ab38ce493d870"]]},"location":{"anyOf":[{"items":{"$ref":"#/components/schemas/Location"},"type":"array"},{"type":"null"}],"title":"Location","description":"The trip locations"},"speedAndDirection":{"anyOf":[{"items":{"$ref":"#/components/schemas/SpeedAndDirection"},"type":"array"},{"type":"null"}],"title":"Speedanddirection","description":"The trip speed and direction"}},"type":"object","required":["uuid","vin","start"],"title":"Trip"},"TripsOutput":{"properties":{"pageSize":{"type":"integer","title":"Pagesize","description":"Current data number result","default":0},"previousPage":{"type":"string","title":"Previouspage","description":"The previous page URL","default":""},"nextPage":{"type":"string","title":"Nextpage","description":"The next page URL","default":""},"total_count":{"type":"integer","title":"Total Count","description":"Parameters total number","default":0},"trips":{"items":{"$ref":"#/components/schemas/Trip"},"type":"array","title":"Trips","description":"The trips"}},"type":"object","required":["trips"],"title":"TripsOutput"},"TypeVehicle":{"type":"string","enum":["Thermic","Electric","Hybrid (HEV)","Mild Hybrid (MHEV)","Series Hybrid (SHEV)","Plug-in Hybrid (PHEV)"],"title":"TypeVehicle"},"UpdateUser":{"properties":{"password":{"type":"string","maxLength":128,"minLength":16,"title":"Password","description":"The new password of the user","examples":["Xdgk8K7n86p-d3joAOOLDlbmafA"]}},"type":"object","required":["password"],"title":"UpdateUser"},"UserOutput":{"properties":{"username":{"type":"string","title":"Username","description":"The id of the user","examples":["username"]},"firstName":{"type":"string","title":"Firstname","description":"The first name of the user","examples":["first_name"]},"name":{"type":"string","title":"Name","description":"The name of the user","examples":["name"]},"email":{"type":"string","pattern":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","title":"Email","description":"The email address of the user","examples":["email@linkbycar.com"]},"status":{"type":"string","title":"Status","description":"The status of the user","examples":["status"]},"company":{"type":"string","title":"Company","description":"The company of the user","examples":["company"]},"userType":{"type":"string","title":"Usertype","description":"The type of the user","examples":["userType"]}},"type":"object","required":["username","firstName","name","email","status","company","userType"],"title":"UserOutput"},"UsersOutput":{"properties":{"pageSize":{"type":"integer","title":"Pagesize","description":"Current data number result","default":0},"previousPage":{"type":"string","title":"Previouspage","description":"The previous page URL","default":""},"nextPage":{"type":"string","title":"Nextpage","description":"The next page URL","default":""},"totalCount":{"type":"integer","title":"Totalcount","description":"The total number of users","default":0},"users":{"items":{"$ref":"#/components/schemas/UserOutput"},"type":"array","title":"Users","description":"The list of users","default":[]}},"type":"object","title":"UsersOutput"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VehicleActivityStatus":{"type":"string","enum":["ONLINE","OFFLINE"],"title":"VehicleActivityStatus"},"VehicleDetailsOutput":{"properties":{"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"The model of the vehicle","examples":["3008"]},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Year","description":"The year of the vehicle","examples":[2021]},"energy":{"type":"string","title":"Energy","default":"Unknown","examples":["Gasoline","Diesel","Electric","ElectricNR","GPL","Ethanol","NaturalGas"]},"energyFlag":{"type":"integer","title":"Energyflag","description":"The energy flag of the vehicle.Gasoline: 1 / Diesel: 2 / Electric: 4 / ElectricNR: 8 / GPL: 16 / Ethanol: 32 / NaturalGas: 64","default":0,"examples":[1]},"vehicleType":{"anyOf":[{"$ref":"#/components/schemas/TypeVehicle"},{"type":"null"}],"description":"The type of the vehicle","examples":["Thermic","Electric","Hybrid (HEV)","Mild Hybrid (MHEV)","Series Hybrid (SHEV)","Plug-in Hybrid (PHEV)"]},"imageUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imageurl","description":"The image of the vehicle","examples":["https://img.linkbycar.com/vehicles/peugeot/3008_2021_05_fullscreen.png"]}},"type":"object","title":"VehicleDetailsOutput"},"VehicleFlag":{"type":"string","enum":["stolen","tracking"],"title":"VehicleFlag"},"VehicleListOutput":{"properties":{"pageSize":{"type":"integer","title":"Pagesize","description":"Current data number result","default":0},"previousPage":{"type":"string","title":"Previouspage","description":"The previous page URL","default":""},"nextPage":{"type":"string","title":"Nextpage","description":"The next page URL","default":""},"totalCount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Totalcount","description":"The total count of vehicles"},"vehicles":{"items":{"$ref":"#/components/schemas/VehicleOutput"},"type":"array","title":"Vehicles"}},"type":"object","required":["vehicles"],"title":"VehicleListOutput"},"VehicleOutput":{"properties":{"vin":{"type":"string","title":"Vin","description":"The vin of the vehicle","default":"VFFFFFFFFFFFFFFFF"},"license_plate":{"type":"string","title":"License Plate","description":"The license plate of the vehicle","default":"xx-xxx-xx"},"manufacturer":{"type":"string","title":"Manufacturer","description":"The manufacturer of the vehicle","default":"Manufacturer"},"status":{"type":"string","title":"Status","description":"The status of the vehicle","default":"ENABLED"},"activityStatus":{"$ref":"#/components/schemas/VehicleActivityStatus","description":"Online if the vehicle sent data recently. Offline otherwhise.","default":"OFFLINE"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"The tags of the vehicle","default":[],"examples":[["tag1","tag2"]]},"comment":{"type":"string","title":"Comment","description":"The comment of the vehicle","default":""},"details":{"$ref":"#/components/schemas/VehicleDetailsOutput"},"fleets":{"items":{"type":"string"},"type":"array","title":"Fleets","description":"The fleets ids of the vehicle","default":[],"examples":[["6aecdead972ab38ce493d871"]]},"package":{"type":"string","title":"Package","description":"The package under which the vehicle is activated.","examples":["67c09fac41c30015389e3a54"]}},"type":"object","required":["details","package"],"title":"VehicleOutput"},"VehiclePatchInput":{"properties":{"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"The license plate of the vehicle","examples":["AB-123-CD"]},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment","description":"The comment of the vehicle","examples":["comment"]},"package":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Package","description":"The new desired package id","examples":["67bf23039d852ed2729ce2d3","67bf41b2d028764b9822d51f","67c09fac41c30015389e3a54","67c09fe141c30015389e3a55","67c19af87807b653b89c6919","67c19c1e75b544a9c3a2e324","69a94f114cd1d7d3908d311c"]}},"type":"object","title":"VehiclePatchInput"},"VehicleRegisterInput":{"properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$","title":"Vin","description":"The vin of the vehicle","examples":["VFFFFFFFFFFFFFFFF"]},"license_plate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License Plate","description":"The license plate of the vehicle","examples":["AB-123-CD"]},"package":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Package","description":"Package id (you can find available packages for your vehicle in the eligibility API routes)","default":"67c09fac41c30015389e3a54","examples":["67bf23039d852ed2729ce2d3","67bf41b2d028764b9822d51f","67c09fac41c30015389e3a54","67c09fe141c30015389e3a55","67c19af87807b653b89c6919","67c19c1e75b544a9c3a2e324","69a94f114cd1d7d3908d311c"]},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Tags","description":"The tags of the vehicle","default":[],"examples":[["tag1","tag2"]]}},"type":"object","required":["vin"],"title":"VehicleRegisterInput"},"VehicleTags":{"properties":{"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"The tags of the vehicle","examples":[["tag1","tag2"]]}},"type":"object","required":["tags"],"title":"VehicleTags"},"VinsInput":{"properties":{"vins":{"items":{"type":"string"},"type":"array","title":"Vins","description":"The list of vins","default":[]}},"type":"object","title":"VinsInput"}},"securitySchemes":{"OAuth2AuthorizationCodeBearer":{"type":"oauth2","flows":{"authorizationCode":{"refreshUrl":"https://idp.linkbycar.com/realms/prod/protocol/openid-connect/token","scopes":{},"authorizationUrl":"https://idp.linkbycar.com/realms/prod/protocol/openid-connect/auth","tokenUrl":"https://idp.linkbycar.com/realms/prod/protocol/openid-connect/token","x-scalar-client-id":"linkbycar-api-swagger","x-usePkce":"SHA-256"}}},"OAuth2ClientCredentials":{"type":"oauth2","description":"OAuth2 Client Credentials Flow (For Machine to Machine Authentication)","flows":{"clientCredentials":{"scopes":{"read":"Read information about owned vehicles.","write":"Write information about owned vehicles."},"tokenUrl":"https://idp.linkbycar.com/realms/prod/protocol/openid-connect/token"}}},"BearerAuth":{"type":"http","description":"JWT access token for manual token entry","scheme":"bearer"},"OAuth2PasswordBearer":{"type":"oauth2","description":"DEPRECATED: OAuth2 Password Bearer with Scopes (For Legacy Authentication)","flows":{"password":{"scopes":{"read":"Read information about owned vehicles.","manage_vehicle":"Add, delete or update owned vehicles.","manage_company":"Add, delete or update owned company and users."},"tokenUrl":"token"}}}}},"tags":[{"name":"DataCatalog","description":"Operations on **data catalog**"},{"name":"Package","description":"Operations on **Package**"},{"name":"Eligibility","description":"Return the vehicle eligibility status and available data"},{"name":"Vehicles","description":"Operations on **vehicles**"},{"name":"Fleets","description":"Operations on **fleets**"},{"name":"DataPoints","description":"Operations on **data points**"},{"name":"SOH","description":"Operations on **SOH** (State Of Health)"},{"name":"BatteryCareScore","description":"Operations on **Battery Care Score**"},{"name":"EcoDriving","description":"Operations on **eco driving**"},{"name":"Trips","description":"Operations on **trips**"},{"name":"BatteryCycles","description":"Operations on **battery cycles**"},{"name":"SafetyScore","description":"Operations on **safety score**"},{"name":"Aggregation","description":"Operations on **aggregation**"},{"name":"Health","description":"Get the API health status"},{"name":"Status (DEPRECATED)","description":"Get the API status"},{"name":"Users (DEPRECATED)","description":"Operations on **users**"},{"name":"Token (DEPRECATED)","description":"Tokens management"},{"name":"Alerts (DEPRECATED)","description":"Operations on **alerts**"}]}