OpenCARWINGS API

https://opencarwings.viaaq.eu/apidocs/
Admin
The OpenCARWINGS API provides endpoints to retrieve and manage information about cars, including...
Tokens:9,858
Snippets:25
Trust Score:4.3
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET /api/car/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Retrieve a list of all cars associated with the authenticated account.

```APIDOC
## GET /api/car/

### Description
Retrieves a list of all vehicles registered under the authenticated user's account.

### Method
GET

### Endpoint
/api/car/

### Parameters
None

### Request Example
(No request body is needed for this GET request)

### Response
#### Success Response (200)
- **CarSerializerList** (array) - A list of car objects, each containing summary information.
  - **(Structure of CarSerializerList object can be found in definitions)**

#### Error Responses
- **401** - Not authorized. Authentication is required.

#### Response Example (Success)
```json
[
  {
    "vin": "VIN1234567890ABCDEF",
    "make": "Toyota",
    "model": "Camry",
    "year": 2022
  },
  {
    "vin": "VIN0987654321FEDCBA",
    "make": "Honda",
    "model": "Civic",
    "year": 2021
  }
]
```
```

--------------------------------

### GET /api/alerts/{vin}/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Retrieve a list of alerts for a specific vehicle identified by its VIN.

```APIDOC
## GET /api/alerts/{vin}/

### Description
Retrieves a list of alerts associated with a specific vehicle, identified by its Vehicle Identification Number (VIN).

### Method
GET

### Endpoint
/api/alerts/{vin}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.

#### Query Parameters
None

### Request Example
(No request body is needed for this GET request)

### Response
#### Success Response (200)
- **AlertHistory** (array) - An array of alert history objects for the specified vehicle.
  - **(Structure of AlertHistory object can be found in definitions)**

#### Error Responses
- **401** - Not authorized. Authentication is required.
- **404** - Car not found. The specified VIN does not correspond to a known vehicle.

#### Response Example (Success)
```json
[
  {
    "timestamp": "2023-10-27T10:00:00Z",
    "alert_type": "low_fuel",
    "message": "Fuel level is critically low."
  },
  {
    "timestamp": "2023-10-26T15:30:00Z",
    "alert_type": "tire_pressure",
    "message": "Front-left tire pressure is low."
  }
]
```
```

--------------------------------

### GET /api/probe/location/{vin}/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Retrieves the current location probe data for a specific car.

```APIDOC
## GET /api/probe/location/{vin}/

### Description
Retrieves the current location probe data for a specific car.

### Method
GET

### Endpoint
/api/probe/location/{vin}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **location_data** (object) - The location probe data.
  - **latitude** (number) - The latitude of the car.
  - **longitude** (number) - The longitude of the car.
  - **timestamp** (string) - The timestamp of the location data.

#### Response Example
```json
{
  "location_data": {
    "latitude": 34.0522,
    "longitude": -118.2437,
    "timestamp": "2023-10-27T10:00:00Z"
  }
}
```
```

--------------------------------

### GET /users/{userId}

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Retrieves detailed information about a specific user. This includes profile data, push notification key, user agent, and last used timestamp.

```APIDOC
## GET /users/{userId}

### Description
Retrieves detailed information about a specific user, including their profile, notification settings, and activity.

### Method
GET

### Endpoint
/users/{userId}

#### Path Parameters
- **userId** (string) - Required - The unique identifier of the user.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the user.
- **email** (string) - The user's email address.
- **name** (string) - The user's full name.
- **push_notification_key** (string) - The push notification key associated with the user.
- **user_agent** (string) - The user's agent string.
- **last_used_at** (string) - The timestamp when the user was last active.

#### Response Example
```json
{
  "id": "user123",
  "email": "user@example.com",
  "name": "John Doe",
  "push_notification_key": "abcdef123456",
  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
  "last_used_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### POST /api/cars/{vin}/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Sends a command to a specific car identified by its VIN.

```APIDOC
## POST /api/cars/{vin}/

### Description
Sends a command to a specific car identified by its VIN.

### Method
POST

### Endpoint
/api/cars/{vin}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number.

#### Query Parameters
None

#### Request Body
- **command** (object) - Required - The command to be sent to the car.
  - **id** (integer) - Required - The ID of the command to execute.
    - **enum**: [0, "No command"], [1, "Refresh data"], [2, "Charge start"], [3, "A/C on"], [4, "A/C off"], [5, "Read configuration"]

### Request Example
```json
{
  "command": {
    "id": 1
  }
}
```

### Response
#### Success Response (200)
- **response** (object) - Description of the command response.
  - **id** (integer) - The ID of the command.
  - **status** (string) - The status of the command execution.

#### Response Example
```json
{
  "response": {
    "id": 1,
    "status": "success"
  }
}
```

#### Error Responses
- **401**: Not authorized
- **404**: Car not found
- **400**: Bad request
```

--------------------------------

### POST /api/command/{vin}/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Send a command to your vehicle identified by VIN.

```APIDOC
## POST /api/command/{vin}/

### Description
Sends a command to a specific vehicle identified by its VIN. This endpoint allows for remote control of vehicle functions.

### Method
POST

### Endpoint
/api/command/{vin}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.
#### Request Body
- **data** (object) - Required - The command details.
  - **vin** (string) - Required - The VIN of the vehicle to send the command to.
  - **command_type** (string) - Required - The type of command to execute (e.g., 'start_charge', 'stop_charge', 'lock_doors').
  - **(Additional command-specific parameters may be required depending on command_type)**

### Request Example
```json
{
  "vin": "VIN1234567890ABCDEF",
  "command_type": "start_charge",
  "charge_limit": 80
}
```

### Response
#### Success Response (200)
- **(The response structure may vary depending on the command executed. It typically confirms the command was received and queued or executed.)**

#### Response Example
```json
{
  "status": "success",
  "message": "Command 'start_charge' queued successfully for VIN VIN1234567890ABCDEF."
}
```
```

--------------------------------

### POST /api/token/obtain/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Obtains a JWT access token by providing user credentials.

```APIDOC
## POST /api/token/obtain/

### Description
Obtains a JWT access token by providing user credentials.

### Method
POST

### Endpoint
/api/token/obtain/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (object) - Required - Credentials for token obtainment.
  - **username** (string) - Required - The user's username.
  - **password** (string) - Required - The user's password.

### Request Example
```json
{
  "data": {
    "username": "user@example.com",
    "password": "securepassword"
  }
}
```

### Response
#### Success Response (201)
- **access** (string) - The JWT access token.
- **refresh** (string) - The JWT refresh token.

#### Response Example
```json
{
  "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```
```

--------------------------------

### POST /account/reset-api-key/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Resets the API key for the account. This action is ONLY accessible from the web portal.

```APIDOC
## POST /account/reset-api-key/

### Description
Resets the API key for the authenticated account. This endpoint is intended for use via the web portal only.

### Method
POST

### Endpoint
/account/reset-api-key/

### Parameters
None

### Request Example
(No request body is expected for this endpoint)

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful reset.

#### Response Example
```json
{
  "message": "API key reset successfully!"
}
```
```

--------------------------------

### CommandTimerSetting Object

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Defines the structure for scheduling commands with specific timing and recurrence options.

```APIDOC
## CommandTimerSetting Object

### Description
Represents a scheduled command with details on its type, schedule, and execution status.

### Properties
- **id** (integer, readOnly) - Unique identifier for the timer setting.
- **command_type_display** (string) - Display string for the command type.
- **last_command_result_display** (string) - Display string for the result of the last command execution.
- **timer_type_display** (string) - Display string for the type of timer (e.g., daily, weekly).
- **last_command_execution** (string, format: date-time, readOnly) - Timestamp of the last command execution.
- **enabled** (boolean) - Indicates if the timer setting is currently enabled.
- **name** (string, maxLength: 32, minLength: 1) - Name of the timer setting.
- **timer_type** (integer, enum: [0, 1]) - Type of the timer (0 or 1).
- **command_type** (integer, enum: [0, 1, 2, 3, 4, 5]) - Type of command to be executed.
- **last_command_result** (integer, enum: [-1, 0, 1, 2, 3]) - Result code of the last command execution.
- **weekday_mon** (boolean) - Whether the command should run on Monday.
- **weekday_tue** (boolean) - Whether the command should run on Tuesday.
- **weekday_wed** (boolean) - Whether the command should run on Wednesday.
- **weekday_thu** (boolean) - Whether the command should run on Thursday.
- **weekday_fri** (boolean) - Whether the command should run on Friday.
- **weekday_sat** (boolean) - Whether the command should run on Saturday.
- **weekday_sun** (boolean) - Whether the command should run on Sunday.
- **time** (string) - The time of day to execute the command (e.g., HH:MM).
- **date** (string, format: date, x-nullable: true) - Specific date for the command execution, if not recurring.
```

--------------------------------

### RoutePlan Schema

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Schema for defining a route plan.

```APIDOC
## RoutePlan Schema

### Description
Allows users to define multi-point route plans for navigation.

### Required Properties
- **name** (string) - Name of the route plan.
- **start_name** (string) - Name of the starting point.
- **start_lat** (string) - Latitude of the starting point.
- **start_lon** (string) - Longitude of the starting point.
- **finish_name** (string) - Name of the finishing point.
- **finish_lat** (string) - Latitude of the finishing point.
- **finish_lon** (string) - Longitude of the finishing point.

### Properties
- **id** (integer, readOnly) - Unique identifier for the route plan.
- **name** (string, minLength: 1, maxLength: 31) - Name of the route plan.
- **created_at** (string, date-time, readOnly) - Timestamp when the route plan was created.
- **start_name** (string, maxLength: 30) - Name of the starting point.
- **start_lat** (string, format: decimal) - Latitude of the starting point.
- **start_lon** (string, format: decimal) - Longitude of the starting point.
- **finish_name** (string, maxLength: 30) - Name of the finishing point.
- **finish_lat** (string, format: decimal) - Latitude of the finishing point.
- **finish_lon** (string, format: decimal) - Longitude of the finishing point.
- **point1_name** (string, maxLength: 30, nullable) - Name of the first waypoint.
- **point1_lat** (string, format: decimal, nullable) - Latitude of the first waypoint.
- **point1_lon** (string, format: decimal, nullable) - Longitude of the first waypoint.
- **point2_name** (string, maxLength: 30, nullable) - Name of the second waypoint.
- **point2_lat** (string, format: decimal, nullable) - Latitude of the second waypoint.
- **point2_lon** (string, format: decimal, nullable) - Longitude of the second waypoint.
```

--------------------------------

### POST /api/token/signout/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Signs out the user and invalidates the provided tokens.

```APIDOC
## POST /api/token/signout/

### Description
Signs out the user and invalidates the provided tokens.

### Method
POST

### Endpoint
/api/token/signout/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (object) - Required - Token information for signout.
  - **token** (string) - Required - The token to invalidate.

### Request Example
```json
{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the token has been revoked.

#### Response Example
```json
{
  "message": "Successfully signed out and token revoked."
}
```

#### Error Responses
- **401**: Not authorized
- **400**: Bad request
```

--------------------------------

### EVInfo Schema

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Defines the structure for electric vehicle information.

```APIDOC
## EVInfo Schema

### Description
Provides details about the electric vehicle's status and capabilities.

### Properties
- **battery_level** (integer) - Current battery level in percentage.
- **battery_level_unit** (string) - Unit for battery level (e.g., "percent").
- **battery_capacity** (integer) - Total battery capacity.
- **battery_capacity_unit** (string) - Unit for battery capacity (e.g., "kWh").
- **last_charging_status** (boolean) - Indicates if the vehicle was last charging.
- **battery_temperature** (integer) - Current battery temperature.
- **battery_temperature_unit** (string) - Unit for battery temperature (e.g., "C").
- **charging_status** (boolean) - Indicates if the vehicle is currently charging.
- **charge_rate** (integer) - Current charging rate.
- **charge_rate_unit** (string) - Unit for charging rate (e.g., "kW").
- **remaining_charge_dist** (integer) - Estimated remaining distance on current charge.
- **remaining_charge_dist_unit** (string) - Unit for remaining distance (e.g., "km").
- **remaining_time_to_full_charge** (integer) - Estimated time to full charge.
- **remaining_time_to_full_charge_unit** (string) - Unit for time to full charge (e.g., "minutes").
- **plug_in_status** (boolean) - Indicates if the vehicle is plugged in.
- **gids** (integer) - Unknown purpose.
- **counter** (integer) - Unknown purpose.
- **max_gids** (integer) - Unknown purpose.
- **full_chg_time** (integer) - Time until full charge.
- **limit_chg_time** (integer) - Time until charge limit is reached.
- **obc_6kw** (integer) - OBC 6kW status.
- **param21** (integer) - Unknown parameter.
- **force_soc_display** (boolean) - Force SOC display.
- **obc_6kw_avail** (boolean) - OBC 6kW availability.
- **batt_heater_avail** (boolean) - Battery heater availability.
- **batt_heater_status** (boolean) - Battery heater status.
```

--------------------------------

### User Authentication API

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Handles user authentication and token management for accessing the API.

```APIDOC
## POST /api/auth/token/

### Description
Obtain JWT access and refresh tokens by providing username and password.

### Method
POST

### Endpoint
/api/auth/token/

### Parameters
#### Request Body
- **username** (string) - Required - The user's username.
- **password** (string) - Required - The user's password.
- **device_type** (string) - Optional - The type of device.
- **device_os** (string) - Optional - The operating system of the device.
- **app_version** (string) - Optional - The version of the application.
- **push_notification_key** (string) - Optional - The push notification key for the device.

### Request Example
```json
{
    "username": "user@example.com",
    "password": "your_password",
    "device_type": "mobile",
    "device_os": "android",
    "app_version": "1.0.0",
    "push_notification_key": "abcdef123456"
}
```

### Response
#### Success Response (200)
- **access** (string) - The JWT access token.
- **refresh** (string) - The JWT refresh token.

#### Response Example
```json
{
    "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```
```

```APIDOC
## POST /api/auth/token/refresh/

### Description
Refresh an expired JWT access token using a valid refresh token.

### Method
POST

### Endpoint
/api/auth/token/refresh/

### Parameters
#### Request Body
- **refresh** (string) - Required - The refresh token.

### Request Example
```json
{
    "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```

### Response
#### Success Response (200)
- **access** (string) - A new JWT access token.

#### Response Example
```json
{
    "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```
```

```APIDOC
## POST /api/auth/token/blacklist/

### Description
Blacklist a refresh token to revoke its ability to obtain new access tokens.

### Method
POST

### Endpoint
/api/auth/token/blacklist/

### Parameters
#### Request Body
- **refresh** (string) - Required - The refresh token to blacklist.

### Request Example
```json
{
    "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
    "message": "Refresh token blacklisted successfully."
}
```
```

```APIDOC
## POST /api/auth/token/metadata/update/

### Description
Update metadata associated with a refresh token.

### Method
POST

### Endpoint
/api/auth/token/metadata/update/

### Parameters
#### Request Body
- **refresh** (string) - Required - The refresh token.
- **device_type** (string) - Optional - The type of device.
- **device_os** (string) - Optional - The operating system of the device.
- **app_version** (string) - Optional - The version of the application.
- **push_notification_key** (string) - Optional - The push notification key for the device.

### Request Example
```json
{
    "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "device_type": "tablet",
    "device_os": "ios",
    "app_version": "1.1.0",
    "push_notification_key": "zyxw987654321"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
    "message": "Token metadata updated successfully."
}
```
```

--------------------------------

### POST /api/token/update/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Updates metadata associated with a token.

```APIDOC
## POST /api/token/update/

### Description
Updates metadata associated with a token.

### Method
POST

### Endpoint
/api/token/update/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (object) - Required - Token metadata update information.
  - **token** (string) - Required - The token to update.
  - **metadata** (object) - Optional - The new metadata to associate with the token.

### Request Example
```json
{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "metadata": {
      "last_used": "2023-10-27T10:00:00Z"
    }
  }
}
```

### Response
#### Success Response (200)
- **token_metadata** (object) - The updated token metadata.
  - **token** (string) - The token.
  - **metadata** (object) - The associated metadata.

#### Response Example
```json
{
  "token_metadata": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "metadata": {
      "last_used": "2023-10-27T10:00:00Z"
    }
  }
}
```

#### Error Responses
- **401**: Not authorized
- **400**: Bad request
```

--------------------------------

### SendToCarLocation Schema

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Schema for sending a location to the car.

```APIDOC
## SendToCarLocation Schema

### Description
Defines the structure for specifying a destination to be sent to the vehicle's navigation system.

### Required Properties
- **lat** (string) - Latitude of the destination.
- **lon** (string) - Longitude of the destination.
- **name** (string) - Name of the destination.

### Properties
- **id** (integer, readOnly) - Unique identifier for the sent location.
- **lat** (string, format: decimal) - Latitude of the destination.
- **lon** (string, format: decimal) - Longitude of the destination.
- **name** (string, minLength: 1, maxLength: 32) - Name of the destination.
- **created_at** (string, date-time, readOnly) - Timestamp when the location was created.
```

--------------------------------

### Car Timers API

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Endpoints for managing timer settings for a specific car.

```APIDOC
## GET /api/car/{vin}/timers/

### Description
Retrieves a list of all timer settings for a specific car.

### Method
GET

### Endpoint
/api/car/{vin}/timers/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.

### Response
#### Success Response (200)
- **CommandTimerSetting** (array) - A list of timer settings objects.
  - **(Structure of CommandTimerSetting object can be found in definitions)**

## POST /api/car/{vin}/timers/

### Description
Creates a new timer setting for a specific car.

### Method
POST

### Endpoint
/api/car/{vin}/timers/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.
#### Request Body
- **data** (object) - Required - The new timer setting details.
  - **(Structure of CommandTimerSetting object can be found in definitions)**

### Response
#### Success Response (200)
- **CommandTimerSetting** (object) - The newly created timer setting object.
  - **(Structure of CommandTimerSetting object can be found in definitions)**

## GET /api/car/{vin}/timers/{id}/

### Description
Retrieves a specific timer setting for a car by its ID.

### Method
GET

### Endpoint
/api/car/{vin}/timers/{id}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.
- **id** (string) - Required - The ID of the timer setting.

### Response
#### Success Response (200)
- **CommandTimerSetting** (object) - The timer setting object.
  - **(Structure of CommandTimerSetting object can be found in definitions)**

## PUT /api/car/{vin}/timers/{id}/

### Description
Updates an existing timer setting for a car by its ID.

### Method
PUT

### Endpoint
/api/car/{vin}/timers/{id}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.
- **id** (string) - Required - The ID of the timer setting.
#### Request Body
- **data** (object) - Required - The updated timer setting details.
  - **(Structure of CommandTimerSetting object can be found in definitions)**

### Response
#### Success Response (200)
- **CommandTimerSetting** (object) - The updated timer setting object.
  - **(Structure of CommandTimerSetting object can be found in definitions)**

## PATCH /api/car/{vin}/timers/{id}/

### Description
Partially updates an existing timer setting for a car by its ID.

### Method
PATCH

### Endpoint
/api/car/{vin}/timers/{id}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.
- **id** (string) - Required - The ID of the timer setting.
#### Request Body
- **data** (object) - Required - The partial timer setting details to update.
  - **(Structure of CommandTimerSetting object can be found in definitions)**

### Response
#### Success Response (200)
- **CommandTimerSetting** (object) - The updated timer setting object.
  - **(Structure of CommandTimerSetting object can be found in definitions)**

## DELETE /api/car/{vin}/timers/{id}/

### Description
Deletes a specific timer setting for a car by its ID.

### Method
DELETE

### Endpoint
/api/car/{vin}/timers/{id}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.
- **id** (string) - Required - The ID of the timer setting.

### Response
#### Success Response (204)
- No content. Indicates successful deletion.

### Request Example (POST/PUT/PATCH)
```json
{
  "name": "Morning Charge",
  "time": "06:00",
  "days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
}
```

### Response Example (GET)
```json
{
  "id": "timer123",
  "name": "Morning Charge",
  "time": "06:00",
  "days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
}
```
```

--------------------------------

### Car Management API

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Endpoints for retrieving, updating, partially updating, and deleting individual car resources.

```APIDOC
## GET /api/car/{vin}/

### Description
Retrieves detailed information about a specific car using its VIN.

### Method
GET

### Endpoint
/api/car/{vin}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.

### Response
#### Success Response (200)
- **Car** (object) - Detailed information about the car.
  - **(Structure of Car object can be found in definitions)**

## PUT /api/car/{vin}/

### Description
Updates all details of a specific car using its VIN. Requires the full car object in the request body.

### Method
PUT

### Endpoint
/api/car/{vin}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.
#### Request Body
- **data** (object) - Required - The updated car data.
  - **(Structure of CarUpdating object can be found in definitions)**

### Response
#### Success Response (200)
- **Car** (object) - The updated car object.
  - **(Structure of Car object can be found in definitions)**

## PATCH /api/car/{vin}/

### Description
Partially updates details of a specific car using its VIN. Allows for updating only specific fields.

### Method
PATCH

### Endpoint
/api/car/{vin}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.
#### Request Body
- **data** (object) - Required - The partial car data to update.
  - **(Structure of CarUpdating object can be found in definitions)**

### Response
#### Success Response (200)
- **Car** (object) - The updated car object.
  - **(Structure of Car object can be found in definitions)**

## DELETE /api/car/{vin}/

### Description
Deletes a specific car resource identified by its VIN.

### Method
DELETE

### Endpoint
/api/car/{vin}/

### Parameters
#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number (VIN) of the car.

### Response
#### Success Response (204)
- No content. Indicates successful deletion.

### Request Example (PUT/PATCH)
```json
{
  "make": "Ford",
  "model": "Mustang",
  "year": 2023
}
```

### Response Example (GET)
```json
{
  "vin": "VIN1234567890ABCDEF",
  "make": "Toyota",
  "model": "Camry",
  "year": 2022,
  "color": "Red"
}
```
```

--------------------------------

### CarSerializerList Schema

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Defines the structure for a list of vehicles.

```APIDOC
## CarSerializerList Schema

### Description
Represents a single vehicle in the system, including its identification, status, and location.

### Required Properties
- **vin** (string) - Vehicle Identification Number.
- **ev_info** (object) - Electric vehicle information.
- **location** (object) - Vehicle's current location.

### Properties
- **vin** (string, minLength: 1, maxLength: 18) - Vehicle Identification Number.
- **last_connection** (string, date-time, readOnly) - Timestamp of the last successful connection.
- **nickname** (string, minLength: 1, maxLength: 64) - User-defined nickname for the vehicle.
- **ev_info** (object) - Electric vehicle information (references EVInfo schema).
- **location** (object) - Vehicle's current location (references LocationInfo schema).
- **carrier** (string, maxLength: 64, nullable) - Mobile network carrier.
- **signal_level** (integer) - Signal strength indicator.
```

--------------------------------

### LocationInfo Schema

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Defines the structure for vehicle location information.

```APIDOC
## LocationInfo Schema

### Description
Provides the geographical location and status of the vehicle.

### Properties
- **id** (integer, readOnly) - Unique identifier for the location record.
- **last_updated** (string, date-time, readOnly) - Timestamp of the last location update.
- **lat** (string, decimal, nullable) - Latitude of the vehicle.
- **lon** (string, decimal, nullable) - Longitude of the vehicle.
- **home** (boolean) - Indicates if this is the home location.
```

--------------------------------

### Car Data Model

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Defines the structure and properties of a car object, including TCU configuration, location, EV information, and command settings.

```APIDOC
## Car Object

### Description
Represents a car with its associated configuration and status information.

### Properties
- **id** (integer, readOnly) - Unique identifier for the car.
- **tcu_configuration** (object) - Configuration details for the Telematics Control Unit (TCU).
- **location** (object) - Current location information of the car.
- **ev_info** (object) - Electric Vehicle (EV) specific information.
- **send_to_car_location** (array of objects) - List of locations to be sent to the car.
- **route_plans** (array of objects) - List of defined route plans for the car.
- **command_type_display** (string, minLength: 1) - Display string for the last command type.
- **command_result_display** (string, minLength: 1) - Display string for the last command result.
- **timer_commands** (array of objects) - List of scheduled command timer settings.
- **command_request_time** (string, format: date-time, readOnly) - Timestamp when the last command was requested.
- **last_connection** (string, format: date-time, readOnly) - Timestamp of the last successful connection.
- **vin** (string, maxLength: 18, minLength: 1) - Vehicle Identification Number.
- **nickname** (string, maxLength: 64, minLength: 1) - User-defined nickname for the car.
- **sms_config** (object) - SMS configuration settings.
- **color** (string, enum: ["l_coulisred", "l_deepblue", "l_forgedbronze", "l_gunmetallic", "l_pearlwhite", "l_planetblue", "l_superblack", "env200_white"]) - The color of the car.
- **vehicle_code1** (integer) - Vehicle code identifier 1.
- **vehicle_code2** (integer) - Vehicle code identifier 2.
- **vehicle_code3** (integer) - Vehicle code identifier 3.
- **vehicle_code4** (integer) - Vehicle code identifier 4.
- **tcu_model** (string, maxLength: 32, minLength: 1, x-nullable: true) - Model of the TCU.
- **tcu_serial** (string, maxLength: 32, minLength: 1, x-nullable: true) - Serial number of the TCU.
- **iccid** (string, maxLength: 32, minLength: 1, x-nullable: true) - Integrated Circuit Card Identifier (SIM card).
- **tcu_ver** (string, maxLength: 32, x-nullable: true) - Software version of the TCU.
- **tcu_user** (string, maxLength: 16, x-nullable: true) - Username for TCU authentication.
- **tcu_pass** (string, maxLength: 16, x-nullable: true) - Password for TCU authentication.
```

--------------------------------

### TCUConfiguration Schema

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Defines the structure for TCU (Telematics Control Unit) configuration.

```APIDOC
## TCUConfiguration Schema

### Description
Manages the network configuration for the vehicle's Telematics Control Unit.

### Properties
- **id** (integer, readOnly) - Unique identifier for the TCU configuration.
- **last_updated** (string, date-time, readOnly) - Timestamp of the last configuration update.
- **dial_code** (string, maxLength: 10, nullable) - Dialing code for the network.
- **apn** (string, maxLength: 48, nullable) - Access Point Name for the mobile network.
- **apn_user** (string, maxLength: 32, nullable) - Username for APN authentication.
- **apn_password** (string, maxLength: 32, nullable) - Password for APN authentication.
- **dns1** (string, maxLength: 32, nullable) - Primary DNS server address.
- **dns2** (string, maxLength: 32, nullable) - Secondary DNS server address.
- **server_url** (string, maxLength: 128, nullable) - URL of the backend server.
- **proxy_url** (string, maxLength: 128, nullable) - URL of the proxy server.
- **connection_type** (string, maxLength: 3, nullable) - Type of network connection.
```

--------------------------------

### POST /api/token/refresh/

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Refreshes a JWT access token using a valid refresh token.

```APIDOC
## POST /api/token/refresh/

### Description
Refreshes a JWT access token using a valid refresh token.

### Method
POST

### Endpoint
/api/token/refresh/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (object) - Required - Token refresh data.
  - **refresh** (string) - Required - The refresh token.

### Request Example
```json
{
  "data": {
    "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}
```

### Response
#### Success Response (201)
- **access** (string) - The new JWT access token.
- **refresh** (string) - The new JWT refresh token (if applicable).

#### Response Example
```json
{
  "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```
```

--------------------------------

### Vehicle Data and Control API

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Endpoints for retrieving vehicle status, sending commands, and managing vehicle settings.

```APIDOC
## GET /api/vehicles/{vin}/

### Description
Retrieve detailed information about a specific vehicle.

### Method
GET

### Endpoint
/api/vehicles/{vin}/

#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number.

### Response
#### Success Response (200)
- **vin** (string) - Vehicle Identification Number.
- **model** (string) - Vehicle model.
- **year** (integer) - Manufacturing year.
- **battery_level** (integer) - Current battery charge level (0-100).
- **range** (integer) - Estimated remaining range.
- **charging_status** (boolean) - Indicates if the vehicle is currently charging.
- **last_updated** (string) - Timestamp of the last data update.

#### Response Example
```json
{
    "vin": "ABC123XYZ789",
    "model": "Leaf",
    "year": 2022,
    "battery_level": 75,
    "range": 250,
    "charging_status": false,
    "last_updated": "2023-10-27T10:00:00Z"
}
```
```

```APIDOC
## POST /api/vehicles/{vin}/command/

### Description
Send a command to the vehicle. This endpoint supports various command types.

### Method
POST

### Endpoint
/api/vehicles/{vin}/command/

#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number.

#### Request Body
- **command_type** (integer) - Required - The type of command to send. Enum: [0, 1, 2, 3, 4, 5].
- **command_payload** (object) - Optional - Additional data for the command. Can be null.

### Request Example
```json
{
    "command_type": 1, 
    "command_payload": {
        "target_temperature": 22
    }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the command was received.
- **car** (object) - Details of the car the command was sent to.

#### Response Example
```json
{
    "message": "Command received successfully.",
    "car": {
        "vin": "ABC123XYZ789",
        "command_id": 12345,
        "command_requested": true
    }
}
```

#### Error Response (400)
- **error** (string) - Description of the error.

#### Error Response Example
```json
{
    "error": "Invalid command type."
}
```
```

```APIDOC
## PUT /api/vehicles/{vin}/settings/

### Description
Update various settings for the vehicle, such as periodic refresh intervals and favorite channels.

### Method
PUT

### Endpoint
/api/vehicles/{vin}/settings/

#### Path Parameters
- **vin** (string) - Required - The Vehicle Identification Number.

#### Request Body
- **periodic_refresh** (integer) - Optional - The interval in minutes for periodic data refresh. Enum: [0, 30, 45, 60, 180, 720, 1440].
- **favorite_channels** (object) - Optional - Custom favorite channels configuration.
- **custom_channels** (object) - Optional - Custom channel configuration.
- **owner** (integer) - Optional - Identifier for the vehicle owner.

### Request Example
```json
{
    "periodic_refresh": 60,
    "favorite_channels": {
        "channel_1": "radio_station_a",
        "channel_2": "music_playlist_b"
    }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message that settings were updated.

#### Response Example
```json
{
    "message": "Vehicle settings updated successfully."
}
```
```

--------------------------------

### POST /api/maplink/resolve

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Resolves a map link from Google Maps or Apple Maps into a location object.

```APIDOC
## POST /api/maplink/resolve

### Description
Resolves a map link from Google Maps or Apple Maps into a location object.

### Method
POST

### Endpoint
/api/maplink/resolve

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **data** (object) - Required - The input data for map link resolution.
  - **map_link** (string) - Required - The map link to resolve.

### Request Example
```json
{
  "data": {
    "map_link": "https://maps.app.goo.gl/examplelink"
  }
}
```

### Response
#### Success Response (200)
- **location** (object) - The resolved location object.
  - **latitude** (number) - The latitude of the location.
  - **longitude** (number) - The longitude of the location.

#### Response Example
```json
{
  "location": {
    "latitude": 34.0522,
    "longitude": -118.2437
  }
}
```
```

--------------------------------

### Map Link Resolver API

Source: https://opencarwings.viaaq.eu/apidocs/index_format=openapi

Resolves map links to geographical coordinates and addresses.

```APIDOC
## POST /api/map/resolve/

### Description
Resolves a given URL to a specific location, extracting latitude, longitude, name, and address.

### Method
POST

### Endpoint
/api/map/resolve/

#### Request Body
- **url** (string) - Required - The URL to resolve. Maximum length 1024 characters.

### Request Example
```json
{
    "url": "https://maps.google.com/?q=Eiffel+Tower,Paris"
}
```

### Response
#### Success Response (200)
- **status** (boolean) - Indicates if the resolution was successful.
- **cause** (string) - The reason for failure if status is false.
- **location** (object) - Contains location details if status is true.
    - **lat** (string) - Latitude of the location.
    - **lon** (string) - Longitude of the location.
    - **name** (string) - Name of the location.
    - **address** (string) - Address of the location.

#### Response Example
```json
{
    "status": true,
    "location": {
        "lat": "48.8584",
        "lon": "2.2945",
        "name": "Eiffel Tower",
        "address": "Champ de Mars, 5 Av. Anatole France, 75007 Paris, France"
    }
}
```

#### Failure Response Example
```json
{
    "status": false,
    "cause": "Invalid URL format."
}
```
```
Tokens:
Raw