### LLM API v1 Device Installation Example

Source: https://roscolive-api-v1.apidog.io/6474466e0

This snippet shows an example of an installed device within the LLM API v1 system. It includes the device ID, type (e.g., 'dv6'), and the associated vehicle name. This information is used to track and manage connected devices.

```yaml
installed_devices:
  - device_id: '3885439985'
    device_type: dv6
    vehicle_name: Test-FWSD-4548
```

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

### GET /installed_reports/{report_id}

Source: https://context7_llms

Partner gets an installed report. This endpoint retrieves details for a specific installed report.

```APIDOC
## GET /installed_reports/{report_id}

### Description
Partner gets an installed report.

### Method
GET

### Endpoint
`/installed_reports/{report_id}`

### Parameters
#### Path Parameters
- **report_id** (string) - Required - The unique identifier of the installed report.

### Response
#### Success Response (200)
- **report_details** (object) - Details of the installed report.
  - **report_id** (string) - The unique identifier of the report.
  - **report_name** (string) - The name of the report.
  - **content** (string) - The content of the report.

#### Response Example
```json
{
  "report_details": {
    "report_id": "report001",
    "report_name": "Monthly Summary",
    "content": "This is the detailed content of the monthly summary report."
  }
}
```
```

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

### Get Installed Devices

Source: https://roscolive-api-v1.apidog.io/6474328e0

Retrieves a list of installed devices, including detailed information about each device's configuration, firmware, connectivity, and status.

```APIDOC
## GET /installed-devices

### Description
Retrieves a list of all installed devices associated with the account. Each device entry contains comprehensive details about its hardware, software, connectivity status, and operational metrics.

### Method
GET

### Endpoint
/installed-devices

### Parameters
#### Query Parameters
- **company_id** (string) - Optional - The ID of the company to filter devices by.
- **device_id** (string) - Optional - The ID of a specific device to retrieve.

### Request Example
```json
{
  "company_id": "825"
}
```

### Response
#### Success Response (200)
- **device_id** (string) - Unique identifier for the device.
- **vehicle_name** (string) - Name assigned to the vehicle associated with the device.
- **serial_number** (string) - Hardware serial number of the device.
- **firmware_version** (object) - Details about the device's firmware versions (e.g., main firmware, MCU, GPS).
  - **firmware** (string) - Main firmware version.
  - **mcu** (string) - MCU firmware version.
- **last_connected_ts** (string) - Timestamp of the last successful connection.
- **last_disconnected_ts** (string) - Timestamp of the last disconnection.
- **online** (boolean) - Indicates if the device is currently online.
- **ignition** (object) - Status of the vehicle's ignition.
  - **state** (boolean) - True if ignition is on, false otherwise.
  - **ts** (string) - Timestamp when the ignition state last changed.

#### Response Example
```json
[
  {
    "device_id": "3917147185",
    "vehicle_name": "test FWSD-7926 task",
    "serial_number": "864839041706900",
    "firmware_version": {
      "firmware": "v2.6.0",
      "mcu": "88"
    },
    "last_connected_ts": "2024-04-03 13:07:43",
    "last_disconnected_ts": "2024-04-03 13:10:13",
    "online": true,
    "ignition": {
      "state": true,
      "ts": "2024-04-03 13:07:22"
    }
  }
]
```
```

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

### GET /api/API_VERSION/device/DEVICE_ID/install/report

Source: https://roscolive-api-v1.apidog.io/6474314e0

Retrieves a list of installed reports for a given device. This endpoint is intended for partners to query device-specific installation data.

```APIDOC
## GET /api/API_VERSION/device/DEVICE_ID/install/report

### Description
Partner gets a list of installed reports of a device.

### Method
GET

### Endpoint
/api/API_VERSION/device/DEVICE_ID/install/report

### Parameters

#### Path Parameters
- **API_VERSION** (string) - Required - The version of the API.
- **DEVICE_ID** (string) - Required - The unique identifier of the device.

### Request Body
This endpoint does not require a request body.

### Request Example
```json
{
  "example": "No request body needed"
}
```

### Response
#### Success Response (200)
- **meta** (object) - Contains metadata about the request, including the HTTP status code.
  - **code** (integer) - The HTTP status code (200 for success).
- **response** (object) - Contains the response data.
  - **reports** (array) - A list of installed reports.
    - **company_id** (string) - The ID of the company associated with the report.
    - **createtime** (string) - The timestamp when the report was created.
    - **device_id** (string) - The ID of the device.
    - **id** (string) - The unique identifier of the report.
    - **url** (string) - The URL to the report (can be null).

#### Response Example
```json
{
  "meta": {
    "code": 200
  },
  "response": {
    "reports": [
      {
        "company_id": "int",
        "createtime": "datetime",
        "device_id": "int|str",
        "id": "int",
        "url": "str|none"
      }
    ]
  }
}
```

#### Error Response (401)
- **meta** (object) - Contains metadata about the error.
  - **code** (integer) - The HTTP status code (401 for unauthorized).
- **response** (object) - Contains error details.
  - **error** (string) - A message indicating the error (e.g., "login required").
- **result** (string) - Indicates the outcome of the request (e.g., "Failed").

#### Response Example (401)
```json
{
  "meta": {
    "code": 401
  },
  "response": {
    "error": "login required"
  },
  "result": "Failed"
}
```

#### Error Response (404)
- **meta** (object) - Contains metadata about the error.
  - **code** (integer) - The HTTP status code (404 for not found).
- **response** (object) - Contains error details.
  - **error** (string) - A message indicating the error.
```

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

### GET /partners/live/{device_id}

Source: https://roscolive-api-v1.apidog.io/6474414e0

Starts live streaming for specified channels on a given device. Supports multi-channel streaming with a comma-separated list of channel IDs.

```APIDOC
## GET /partners/live/{device_id}

### Description
Start live streaming of all available channels with single API call. Channels should be separated by ',', for example '1,2,3,4'

### Method
GET

### Endpoint
/partners/live/{device_id}

### Parameters
#### Path Parameters
- **device_id** (integer) - Required - Device ID to live stream channels

#### Query Parameters
- **channels** (integer) - Required - comma-separated list of channels to live stream. Channel must be active on device to live stream.

### Request Example
This endpoint does not have a request body. Example query parameters:
`?channels=0`

### Response
#### Success Response (200)
- **meta** (object) - Request metadata object. Contains a 'code' field indicating success (200).
- **response** (array) - Contains response data for each channel streamed.
  - **url** (string) - URL to the manifest file for the live stream.
  - **channel** (integer) - Channel number for the live stream.
- **result** (string) - 'OK' if the request was successful.

#### Response Example
```json
{
  "meta": {
    "code": 200
  },
  "response": [
    {
      "url": "https://fleet.roscolive.com:8080/live/3299582673/1/O2lQYFdR.m3u8",
      "channel": 1
    }
  ],
  "result": "OK"
}
```

#### Error Response (401)
- **meta** (object) - Request metadata object. Contains a 'code' field (401).
- **response** (object) - Contains response data, including an 'error' field.
  - **error** (string) - Description of the error.
- **result** (string) - Indicates failure.
```

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

### GET /devices/{device_id}/installed_reports

Source: https://context7_llms

Partner gets a list of installed reports of a device. This endpoint retrieves all installed reports associated with a specific device.

```APIDOC
## GET /devices/{device_id}/installed_reports

### Description
Partner gets a list of installed reports of a device.

### Method
GET

### Endpoint
`/devices/{device_id}/installed_reports`

### Parameters
#### Path Parameters
- **device_id** (string) - Required - The unique identifier of the device.

### Response
#### Success Response (200)
- **reports** (array) - A list of installed reports for the device.
  - **report_id** (string) - The unique identifier of the report.
  - **report_name** (string) - The name of the report.
  - **installation_date** (string) - The date the report was installed.

#### Response Example
```json
{
  "reports": [
    {
      "report_id": "report001",
      "report_name": "Monthly Summary",
      "installation_date": "2023-01-15"
    }
  ]
}
```
```

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

### GET /api/v1/devices

Source: https://roscolive-api-v1.apidog.io/6474466e0

Retrieves a list of devices with profiles installed. The `installed_devices` can be included in the response by using the `include_data` query parameter.

```APIDOC
## GET /api/v1/devices

### Description
Retrieves a list of devices with profiles installed. If `installed_devices` is passed in the `include_data` query parameter, the response will include a list of devices with profiles applied.

### Method
GET

### Endpoint
/api/v1/devices

### Parameters
#### Query Parameters
- **include_data** (string) - Optional - Specifies to include installed device data in the response.

### Request Example
```json
{
  "example": "GET /api/v1/devices?include_data=installed_devices"
}
```

### Response
#### Success Response (200)
- **device_id** (string) - The unique identifier for the device.
- **device_type** (string) - The type of the device.
- **vehicle_name** (string) - The name of the vehicle associated with the device.

#### Response Example
```json
{
  "example": "{
    \"devices\": [
      {
        \"device_id\": \"device123\",
        \"device_type\": \"camera\",
        \"vehicle_name\": \"Truck-01\"
      }
    ]
  }"
}
```
```

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

### Get Devices List Example (OR condition)

Source: https://roscolive-api-v1.apidog.io/11790586e0

Illustrates fetching a list of devices with search criteria using an 'OR' condition. This example showcases the flexibility in searching across multiple fields such as vehicle name, device ID, and serial number.

```HTTP
GET /devices/list/search?company_ids=825&page_number=1&page_size=20&order_fields=vehicle_name&order_dir=asc&search_fields=vehicle_name,device_id,serial_number&search_str=Ford 150,3681226577,015974000040740&search_condition=or
```

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

### GET /api/API_VERSION/device/install/report/REPORT_ID

Source: https://roscolive-api-v1.apidog.io/6474315e0

Retrieves details of an installed device report. Partners can use this endpoint to get specific installation reports for devices.

```APIDOC
## GET /api/API_VERSION/device/install/report/REPORT_ID

### Description
Partner gets an installed report.

### Method
GET

### Endpoint
/api/API_VERSION/device/install/report/REPORT_ID

### Parameters
#### Path Parameters
- **API_VERSION** (string) - Required - The version of the API.
- **REPORT_ID** (string) - Required - The ID of the report to retrieve.

### Request Example
```json
{
  "example": "No request body for this GET request."
}
```

### Response
#### Success Response (200)
- **meta** (object) - Contains metadata about the request.
  - **code** (integer) - HTTP status code.
- **response** (object) - The report data.
  - **company_id** (string) - The ID of the company.
  - **createtime** (string) - The creation timestamp of the report.
  - **device_id** (string) - The ID of the device.
  - **id** (string) - The ID of the report.
  - **url** (string) - The URL associated with the report.
- **result** (string) - Indicates if the request was successful ('OK').

#### Response Example (200)
```json
{
  "example": "{\n  \"meta\": {\n    \"code\": 200\n  },\n  \"response\": {\n    \"company_id\": \"int\",\n    \"createtime\": \"datetime\",\n    \"device_id\": \"int|str\",\n    \"id\": \"int\",\n    \"url\": \"str|none\"\n  },\n  \"result\": \"OK\"\n}"
}
```

#### Error Response (401)
- **meta** (object) - Contains metadata about the request.
  - **code** (integer) - HTTP status code (401).
- **response** (object) - Error details.
  - **error** (string) - Description of the error (e.g., "login required").
- **result** (string) - Indicates if the request was successful ('Failed').

#### Response Example (401)
```json
{
  "example": "{\n  \"meta\": {\n    \"code\": 401\n  },\n  \"response\": {\n    \"error\": \"login required\"\n  },\n  \"result\": \"Failed\"\n}"
}
```

#### Error Response (404)
- **meta** (object) - Contains metadata about the request.
  - **code** (integer) - HTTP status code (404).
- **response** (object) - Error details.
  - **error** (string) - Description of the error.
- **result** (string) - Indicates if the request was successful ('Failed').

#### Response Example (404)
```json
{
  "example": "{\n  \"meta\": {\n    \"code\": 404\n  },\n  \"response\": {\n    \"error\": \"report not found\"\n  },\n  \"result\": \"Failed\"\n}"
}
```
```

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

### POST /devices/create/legacy

Source: https://context7_llms

Partner creates a device in a company's account. 50 devices and more can be created at the same time.

```APIDOC
## POST /devices/create/legacy

### Description
Partner creates a device in a company's account. 50 devices and more can be created at the same time.

### Method
POST

### Endpoint
`/devices/create/legacy`

### Parameters
#### Request Body
- **company_id** (string) - Required - The ID of the company where the device will be created.
- **devices** (array) - Required - A list of devices to create.
  - **name** (string) - Required - The name of the device.
  - **model** (string) - Required - The model of the device.
  - **imei** (string) - Optional - The IMEI number of the device.

### Request Example
```json
{
  "company_id": "companyXYZ",
  "devices": [
    {
      "name": "New Truck 1",
      "model": "TruckModelV3",
      "imei": "987654321098765"
    },
    {
      "name": "New Truck 2",
      "model": "TruckModelV3"
    }
  ]
}
```

### Response
#### Success Response (200)
- **created_devices** (array) - A list of successfully created devices.
  - **device_id** (string) - The unique identifier of the created device.
  - **name** (string) - The name of the created device.

#### Response Example
```json
{
  "created_devices": [
    {
      "device_id": "newDevice1",
      "name": "New Truck 1"
    }
  ]
}
```
```

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

### Success Response Example (JSON)

Source: https://roscolive-api-v1.apidog.io/15248427e0

This example demonstrates a successful API response for retrieving device profiles. It includes metadata, profile details such as event types and configurations, and a success status.

```json
{
  "meta": {
    "code": 200
  },
  "response": {
    "profiles": [
      {
        "advanced_quality_channels": false,
        "comments": null,
        "configuration": "{\"c\":34}",
        "configurationdv6": "{\"d\":4}",
        "created_at": "Wed, 10 Aug 2022 12:39:29 GMT",
        "devices_using": 2,
        "event_types": {
          "dv4_distraction": "video_snapshot",
          "dv4_driver": "video_snapshot",
          "dv4_drowsiness": "video_snapshot",
          "dv4_ext_driver": "snapshot_only",
          "dv4_fatal_gsensor": "video_snapshot",
          "dv4_high_speed": "alert_only",
          "dv4_phone_use": "video_snapshot",
          "dv6_camera_block": "alert_only",
          "dv6_distraction": "video_snapshot",
          "dv6_driver": "video_snapshot",
          "dv6_drowsiness": "video_snapshot",
          "dv6_fatal_gsensor": "video_snapshot",
          "dv6_following_distance": "snapshot_only",
          "dv6_forward_collision": "snapshot_only",
          "dv6_harsh_accel": "video_snapshot",
          "dv6_harsh_braking": "video_snapshot",
          "dv6_headway_monitoring": "snapshot_only",
          "dv6_high_speed": "alert_only",
          "dv6_lane_departure": "snapshot_only",
          "dv6_phone_use": "video_snapshot",
          "dv6_seatbelt": "video_snapshot",
          "dv6_smoking": "video_snapshot",
          "dv6_yawning": "video_snapshot"
        },
        "id": 9617,
        "last_changed_ts": "Thu, 30 Nov 2023 15:15:26 GMT",
        "name": "default",
        "preferred": true
      }
    ]
  },
  "result": "OK"
}
```

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

### POST /devices/create/auto-prov

Source: https://context7_llms

Create a device in a company's account. 50 devices and more can be created at the same time.

```APIDOC
## POST /devices/create/auto-prov

### Description
Create a device in a company's account. 50 devices and more can be created at the same time.

### Method
POST

### Endpoint
`/devices/create/auto-prov`

### Parameters
#### Request Body
- **company_id** (string) - Required - The ID of the company where the device will be created.
- **devices** (array) - Required - A list of devices to create.
  - **name** (string) - Required - The name of the device.
  - **model** (string) - Required - The model of the device.
  - **serial_number** (string) - Required - The serial number of the device.

### Request Example
```json
{
  "company_id": "companyABC",
  "devices": [
    {
      "name": "AutoProv Device 1",
      "model": "DV6Model",
      "serial_number": "SN123456789"
    }
  ]
}
```

### Response
#### Success Response (200)
- **created_devices** (array) - A list of successfully created devices.
  - **device_id** (string) - The unique identifier of the created device.
  - **name** (string) - The name of the created device.

#### Response Example
```json
{
  "created_devices": [
    {
      "device_id": "autoProvDevice1",
      "name": "AutoProv Device 1"
    }
  ]
}
```
```

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

### Get Device Event by Start Time (OpenAPI)

Source: https://roscolive-api-v1.apidog.io/18080597e0

Defines the OpenAPI 3.0.1 specification for the '/device/{device_id}/event' GET endpoint. This endpoint retrieves events for a specific device, requiring a device ID and a UTC timestamp. It specifies request parameters, response codes, and provides an example JSON response.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /device/{device_id}/event:
    get:
      summary: Get an Event of a Device by Start Time
      deprecated: false
      description: >-
        Endpoint to get an event of a device by the starting timestamp.

        `start_ts` must be +- 5 secs from the actual starting timestamp of the
        event to return results.

        Otherwise, a 404 error will be returned


      # User Role Permissions

      The following table shows which user roles are allowed to send requests
      using this API endpoint.


      | Role | Permission |

      | --- | --- |

      | Partner | <Icon icon="material-outline-done"/> |

      | Partner View | <Icon style="color: red;"
      icon="material-outline-close"/> |

      | Custom Partner | <Icon icon="material-outline-done"/> |

      | Fleet Manager | <Icon icon="material-outline-done"/> |

      | Group Manager | <Icon icon="material-outline-done"/> |

      | User | <Icon icon="material-outline-done"/> |

      | Custom User | <Icon icon="material-outline-done"/> |
      tags:
        - Event
        - event
        - device
      parameters:
        - name: device_id
          in: path
          description: Unique ID of device
          required: true
          schema:
            type: integer
            examples:
              - 12345678
        - name: start_ts
          in: query
          description: Timestamp in UTC format (YYYYMMDDhhmmss)
          required: true
          schema:
            type: string
            examples:
              - '20250615123000'
            format: date-time
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        description: HTTP status code returned by response
                        x-apidog-mock: '200'
                    x-apidog-orders:
                      - code
                    required:
                      - code
                    description: Request metadata object
                  response:
                    type: object
                    properties: {}
                    description: Contains response data
                    x-apidog-orders: []
                  result:
                    type: string
                    description: '"OK" if successful, else "Failed" if error'
                    x-apidog-mock: OK
                x-apidog-orders:
                  - meta
                  - response
                  - result
                required:
                  - meta
                  - response
                  - result
                x-apidog-refs: {}
              example:
                meta:
                  code: 200
                response:
                  event:
                    accurate_duration: 8
                    archive: null
                    asset_id: null
                    company_id: 825
                    company_name: Rosco-Geotab1
                    created_by: 0
                    createtime: Wed, 11 Jun 2025 11:26:48 GMT
                    custom_event_type: null
                    data: null
                    device_id: '3716245153'
                    driver_card_id: ''
                    driver_id: null
                    driver_name: ''
                    duration: 10
                    email_sent: alert
                    end_ts: Wed, 11 Jun 2025 11:27:19 GMT
                    event_display_type: ''
                    event_label: null
                    event_type: Drowsiness
                    geotab_driver: null
                    geotab_user_id: null
                    groups: null
                    has_feedback: false
                    has_review: null
                    hash: f6ecd20546b611f0bc14069d5833a13f
                    id: 2631179
                    impact_score: true
                    is_datausage_locked: false
                    is_flood: false
                    last_reviewed: null
                    last_reviewed_by: null
                    last_viewed: Wed, 11 Jun 2025 19:22:13 GMT
                    last_viewed_by: 6976
                    lat: 40.7039
                    lon: -73.818
                    meta_json: true
                    mp4_1: true
                    mp4_2: true
                    mp4_3: false
                    mp4_4: false
                    nvr_filename: 0000000000089061-250611-072709-072719-10O700000012.nvr
                    old_device_id: null
                    partner_company: Rosco Vision Partner
                    request_ts: null
                    rule: null
                    size: 9.2953

```

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

### Get an Event of a Device by Start Time

Source: https://context7_llms

Endpoint to retrieve an event of a device based on its starting timestamp.

```APIDOC
## GET /events/device/{device_id}/{start_ts}

### Description
Retrieve an event of a device by its starting timestamp.

### Method
GET

### Endpoint
/events/device/{device_id}/{start_ts}

### Parameters
#### Path Parameters
- **device_id** (string) - Required - The ID of the device.
- **start_ts** (string) - Required - The start timestamp of the event (format: YYYYmmDDHHMMSS).

### Response
#### Success Response (200)
- **event_data** (object) - Contains details of the event.

#### Response Example
```json
{
  "event_data": {
    "event_id": "event_abc789",
    "timestamp": "20230101100000",
    "duration": 60,
    "type": "motion"
  }
}
```
```

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

### LLM API v1 System Configuration Example

Source: https://roscolive-api-v1.apidog.io/6474466e0

This snippet illustrates a sample configuration for a system within the LLM API v1. It includes settings for sensors, driver monitoring (DMS), server modes, system preferences, and recording options. This configuration is used to define how the system operates and what events it monitors.

```json
{
  "Sensors": [
    {
      "index": 3,
      "SendToCloud": false,
      "Name": "Sensor #3",
      "TriggerOutput": -1,
      "ActiveHigh": true,
      "Enabled": false,
      "ShortName": "S3"
    },
    {
      "index": 4,
      "SendToCloud": true,
      "Name": "Sensor #4",
      "TriggerOutput": -1,
      "ActiveHigh": true,
      "Enabled": false,
      "ShortName": "S4"
    },
    {
      "index": 4,
      "SendToCloud": true,
      "Name": "External Driver Event",
      "TriggerOutput": -1,
      "Enabled": true,
      "ShortName": "EE"
    },
    {
      "index": 8,
      "SendToCloud": true,
      "TriggerOutput": -1
    }
  ],
  "HighTemperature": {
    "Threshold": 99,
    "ShutdownDelay": 150,
    "Enabled": true
  },
  "Dms": {
    "CameraObstruction": {
      "Enabled": false
    },
    "Seatbelt": {
      "Enabled": false,
      "Sensitivity": 0
    },
    "Distraction": {
      "Enabled": true,
      "SendToCloud": true,
      "Sensitivity": 0
    },
    "PhoneUse": {
      "Enabled": true,
      "SendToCloud": true,
      "Sensitivity": 0
    },
    "Enabled": true,
    "Yawning": {
      "SendToCloud": true,
      "Enabled": true,
      "Sensitivity": 0
    },
    "Dozing": {
      "SendToCloud": true,
      "Enabled": true,
      "Sensitivity": 0
    },
    "Sensitivity": 1,
    "HeadDown": {
      "SendToCloud": true,
      "Enabled": true,
      "Sensitivity": 0
    },
    "Smoking": {
      "Enabled": false,
      "Sensitivity": 0
    }
  },
  "BuzzerEnabled": false,
  "Servers": {
    "Ads": {
      "ShutdownDelay": 480
    },
    "SleepMode": {
      "Enabled": false
    }
  },
  "System": {
    "SpeedUnit": 1,
    "Chimes": {
      "CameraObstruction": {
        "Enabled": 0
      },
      "Dms": false,
      "Volume": 100,
      "Adas": false,
      "Accelerometer": false,
      "HarshBraking": false,
      "HarshAccel": false,
      "HighSpeed": false,
      "Distraction": true,
      "Yawning": true,
      "Drowsiness": true,
      "PhoneUse": true,
      "ForwardCollision": true,
      "Headway": true,
      "FollowingDistance": true,
      "LaneDeparture": true,
      "Smoking": false,
      "Seatbelt": false
    }
  },
  "Recording": {
    "LockEventFiles": false
  },
  "Peripherals": {
    "CanBus": {
      "Type": 0
    }
  }
}
```

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

### API Authentication Example (Conceptual)

Source: https://roscolive-api-v1.apidog.io/6474334e0

Illustrates a conceptual API authentication flow, likely involving headers or tokens. This is a placeholder as no direct authentication code is provided.

```http
GET /api/v1.0/some-endpoint
Authorization: Bearer YOUR_API_TOKEN
```

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

### GET /availablefirmware

Source: https://roscolive-api-v1.apidog.io/8891766e0

Retrieves a list of available firmware versions for devices. This endpoint is restricted to partners with valid permissions.

```APIDOC
## GET /availablefirmware

### Description
Get available firmware versions. **NOTE**: Only Partners with valid permissions can access this endpoint.

### Method
GET

### Endpoint
/availablefirmware

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **firmwares** (array) - List of available firmware versions. Each item contains:
  - **release_note** (string) - Release notes for the firmware.
  - **url** (string) - S3 URL to the firmware file.
  - **version** (string) - Firmware version string (e.g., 'dv6_v2.7.0.fw').
- **meta** (object) - Request metadata object.
  - **code** (string) - HTTP status code returned by the server.
- **result** (string) - "OK" if request successful, otherwise "Failed".

#### Response Example
```json
{
  "firmwares": [
    {
      "release_note": "G-sensor fix & CAT1 modem improvement",
      "url": "https://firmwares3.roscocloud.com/staging/dvxc4_v1.6.4.fw?AWSAccessKeyId=AKIAR34ZBXI7E5ZZ7R7C&Signature=mtc91ox8ytD%2B%2B0EueFBAxqApxk0%3D&Expires=1949343807",
      "version": "dvxc4_v1.6.4.fw"
    },
    {
      "release_note": "The modem connection improvements & speed OSD feature added",
      "url": "https://firmwares3.roscocloud.com/staging/dvxc4_v1.6.5.fw?AWSAccessKeyId=AKIAR34ZBXI7E5ZZ7R7C&Signature=GsS3G%2Bqfzjhx4A%2FHW0pPUItUbAg%3D&Expires=1949343814",
      "version": "dvxc4_v1.6.5.fw"
    }
  ],
  "meta": {
    "code": "200"
  },
  "result": "OK"
}
```
```

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

### Get Installed Report of a Non-Existing Device

Source: https://roscolive-api-v1.apidog.io/6474314e0

Retrieves the installed report for a specific device. This endpoint is designed to demonstrate error handling when a device does not exist.

```APIDOC
## GET /device/{id}/installed_report

### Description
Retrieves the installed report for a specific device. This endpoint is designed to demonstrate error handling when a device does not exist.

### Method
GET

### Endpoint
/device/{id}/installed_report

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the device.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **meta** (object) - Contains metadata about the request.
  - **code** (integer) - The HTTP status code.
- **response** (object) - Contains the response data.
  - **error** (string) - An error message if the request failed.
- **result** (string) - The overall result of the operation (e.g., 'Failed').

#### Response Example
```json
{
  "meta": {
    "code": 404
  },
  "response": {
    "error": "device doesn't exist"
  },
  "result": "Failed"
}
```
```

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

### POST /login

Source: https://roscolive-api-v1.apidog.io/6474265e0

Logs in a user, establishing a session and returning session tokens.

```APIDOC
## POST /login

### Description
Login a user to begin a user session. Once logged in, a `session` and `session_token` cookie will be returned. Pass these cookies in the request header for any subsequent API requests for actions using this current user session. User session tokens expire after 24 hours in which a Login request will have to be resubmitted to retrieve a new session.

### Method
POST

### Endpoint
/login

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **email** (string) - Required - Email address of the user
- **password** (string) - Required - Password for the user

### Request Example
```json
{
  "email": "example@example.com",
  "password": "user_password"
}
```

### Response
#### Success Response (200)
- **meta** (object) - Object that contains the metadata of response
  - **code** (integer) - HTTP status code of request
- **response** (object) - Contains the details of the logged in user and session
  - **roles** (array) - Contains the role of the logged in user. Will always have only 1 item.
    - **items** (string) - The user role of the logged in user.
  - **user** (string) - Email address of logged in user.
  - **last_login** (string) - Timestamp of last successful login of user
  - **user_id** (integer) - UID of user
  - **session_expire** (string) - Datetime when user session expires
  - **session_token** (string) - Session token

#### Response Example
```json
{
  "meta": {
    "code": 200
  },
  "response": {
    "roles": [
      "partner"
    ],
    "user": "example@example.com",
    "last_login": "2024-01-01 13:40:14",
    "user_id": 12345,
    "session_expire": "2024-01-02 13:40:14",
    "session_token": "your_session_token_here"
  }
}
```
```

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

### API Response Example Structure

Source: https://roscolive-api-v1.apidog.io/6474409e0

An example demonstrating the structure of a successful API response. It includes metadata about the request, a list of device data, and a result status.

```yaml
example:
  meta:
    code: 200
  response:
    - asset_id: 123
      device_id: '1234567890'
      driver_name: Dr. Alonzo Flatley
      driver_trips:
        - 12345
        - 12345
        - 12345
      driver_mode: cardreader
      metadata:
        - dir: 0
          dst: 0
          key: '1'
          latitude: 40.6415596008301
          longitude: -73.9445953369141
          speed: 0
          timestamp: Thu, 23 Oct 2025 20:11:05 GMT
          type: Gps
        - dir: 177
          dst: 30
          key: '1'
          latitude: 40.6413917541504
          longitude: -73.9447402954102
          speed: 20.505
          timestamp: Thu, 23 Oct 2025 20:11:10 GMT
          type: Gps
      vehicle_name: First Vehicle
    - asset_id: 321
      device_id: '1234567890'
      driver_name: Kari Kuhic
      driver_trips:
```

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

### Get None Existing Installed Report

Source: https://roscolive-api-v1.apidog.io/6474315e0

Retrieves information about an installed report. This endpoint is designed to handle cases where the specified report does not exist, returning a 404 error.

```APIDOC
## GET /llmstxt/roscolive-api-v1_apidog_io_llms_txt

### Description
Retrieves information about an installed report. Returns a 404 error if the report does not exist.

### Method
GET

### Endpoint
/llmstxt/roscolive-api-v1_apidog_io_llms_txt

### Parameters

#### Query Parameters

#### Request Body

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **result** (string) - Placeholder for successful response data.
- **x-apidog-orders** (array) - Defines the order of response fields.
  - **meta** (object) - Metadata about the response.
  - **response** (object) - The main response data.
  - **result** (string) - Final status of the operation.

#### Error Response (404)
- **meta** (object)
  - **code** (integer) - The HTTP status code (404).
- **response** (object)
  - **error** (string) - Description of the error, e.g., "install report doesn't exist".
- **result** (string) - Indicates failure, e.g., "Failed".

#### Response Example
```json
{
  "meta": {
    "code": 404
  },
  "response": {
    "error": "install report doesn't exist"
  },
  "result": "Failed"
}
```
```

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

### Get Devices List Example (AND condition)

Source: https://roscolive-api-v1.apidog.io/11790586e0

Demonstrates how to retrieve a list of devices with specific search criteria using an 'AND' condition. It includes parameters like company IDs, pagination, ordering, search fields, search string, and search condition.

```HTTP
GET /devices/list/search?company_ids=825&page_number=1&page_size=20&order_fields=vehicle_name&order_dir=asc&search_fields=vehicle_name,device_id&search_str=Ford 150,35174862&search_condition=and
```

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

### Get Company Ignition Notifications (OpenAPI)

Source: https://roscolive-api-v1.apidog.io/6474277e0

Defines the GET endpoint for retrieving ignition notifications for a specific company. It details path parameters, request body structure (though empty in this example), and successful (200) and error responses (401, 404), including example data for each.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /companies/{company_id}/notifications/ignition:
    get:
      summary: get ignition notifications of a company
      deprecated: false
      description: An user gets notifications of a company when ignition works in a vehicle
      tags:
        - Company
      parameters:
        - name: company_id
          in: path
          description: ''
          required: true
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                    required:
                      - code
                    x-apidog-orders:
                      - code
                  response:
                    type: array
                    items:
                      type: object
                      properties:
                        company_id:
                          type: integer
                        id:
                          type: integer
                        type:
                          type: integer
                        url:
                          type: string
                      x-apidog-orders:
                        - company_id
                        - id
                        - type
                        - url
                  result:
                    type: string
                required:
                  - meta
                  - response
                  - result
                x-apidog-orders:
                  - meta
                  - response
                  - result
              example:
                meta:
                  code: 200
                response:
                  - company_id: 66
                    id: 62
                    type: 4
                    url: >-
                      https://staging.roscocloud.com/api/v0.5/partners/notifications/test
                result: OK
          headers: {}
          x-apidog-name: '200'
        '401':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        title: ''
                        description: HTTP status code returned by server
                        faker: '401'
                    required:
                      - code
                    x-apidog-orders:
                      - code
                    title: ''
                    description: Request metadata object
                  response:
                    type: object
                    properties:
                      error:
                        type: string
                    required:
                      - error
                    x-apidog-orders:
                      - error
                    title: ''
                    description: Contains response data
                  result:
                    type: string
                    title: ''
                    description: '"OK" if request successful, otherwise "Failed"'
                    faker: Failed
                required:
                  - meta
                  - response
                  - result
                x-apidog-orders:
                  - meta
                  - response
                  - result
              example:
                meta:
                  code: 401
                response:
                  error: login required
                result: Failed
          headers: {}
          x-apidog-name: Login Required
        '404':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                    required:
                      - code
                    x-apidog-orders:
                      - code
                  response:
                    type: object
                    properties:
                      error:
                        type: string
                    required:
                      - error
                    x-apidog-orders:
                      - error
                  result:
                    type: string
                required:
                  - meta
                  - response

```

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

### POST /users/profiles

Source: https://roscolive-api-v1.apidog.io/15248427e0

Creates a new user profile with specified configuration details. Requires 'configuration', 'configurationdv6', 'name', 'comments', and 'preferred' fields. Returns the created profile object upon success.

```APIDOC
## POST /users/profiles

### Description
Creates a new user profile with specified configuration details. Requires 'configuration', 'configurationdv6', 'name', 'comments', and 'preferred' fields. Returns the created profile object upon success.

### Method
POST

### Endpoint
/users/profiles

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **configuration** (string) - Required - DV4 configuration object
- **configurationdv6** (string) - Required - DV6 configuration object
- **name** (string) - Required - Profile name
- **comments** (string) - Required - Profile comments
- **preferred** (boolean) - Required - Flag value if profile is set as preferred

### Request Example
```json
{
  "configuration": "{\"key\": \"value\"}",
  "configurationdv6": "{\"key\": \"value\"}",
  "name": "My Profile",
  "comments": "This is a test profile.",
  "preferred": true
}
```

### Response
#### Success Response (200)
- **id** (integer) - Profile ID
- **configuration** (string) - DV4 configuration object
- **configurationdv6** (string) - DV6 configuration object
- **name** (string) - Profile name
- **comments** (string) - Profile comments
- **created_at** (string) - Timestamp profile was created
- **last_changed** (string) - Timestamp profile was last updated
- **preferred** (boolean) - Flag value if profile is set as preferred

#### Response Example
```json
{
  "id": 1,
  "configuration": "{\"key\": \"value\"}",
  "configurationdv6": "{\"key\": \"value\"}",
  "name": "My Profile",
  "comments": "This is a test profile.",
  "created_at": "Mon, 25 Nov 2024 01:07:57 GMT",
  "last_changed": "Mon, 25 Nov 2024 01:07:57 GMT",
  "preferred": true
}
```
```