update a device - RoscoLive API v1.0

Updates a device. All the attributes are optional, only the posted attributes will be changed.

Request

Path Params

device_id

integer

required

ID of device to update

>= 9<= 10

Body Params multipart/form-data

vehicle_icon

enum<string>

optional

Allowed values:

Ambulance 1Ambulance 2Ambulance 3Arrow 1Arrow 2Arrow 3Bus 1Bus 2Bus 3ChopperFire Truck 1Fire Truck 2Garbage TruckHumveeJeepLimousinePickup Truck 1Pickup Truck 2Pickup Truck 3Police CarSchool BusSedanSemi Truck 1Semi Truck 2Sports Car 1Sports Car 2Sports Car 3Taxi 1Taxi 2Van 1Van 2Van 3

Example:

Arrow 1

vehicle_name

string

optional

Name that will be assigned to the camera. Accepted characters are . ' # - _ A-Z,a-z

Example:

Truck 1

user_email

string

optional

A string of comma separated list of emails registered to users with the role user. All the users will be assigned to the device, and have access to the events, videos and alerts of that device.

Example:

john.doe@example.com,jane.doe@example.com

driver_name

string

optional

Name of driver to manually assign to device

Example:

jim.doe@example.com

matching_token

string

optional

A unique string in your database to be used as a matching_token to identify a device by instead of device_id and vehicle_name

Example:

my-unique-matching-token-01

silence_err_notifs

array[string]

optional

A list of camera error alerts to silence user notifications for related to the "get camera health" error notifications. . To clear list and restore back to normal, pass in an empty array list.

Example:

["SD20"]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

Contains response data

device

object (Device)

required

result

enum<string>

required

"OK" if request successful, otherwise "Failed"

Allowed values:

OKFailed

Example

{
    "meta": {
        "code": 200
    },
    "response": {
        "device": {
            "cardreader": true,
            "canbus": "0",
            "device_type": "dv6",
            "is_flagged": true,
            "activated_timestamp": "2024-01-01 12:31:42",
            "active": false,
            "ads_online": false,
            "antenna_img": 1,
            "channel_available": null,
            "company_id": 12345,
            "company_name": "Reilly, Cartwright and Walker",
            "created_at": "2024-01-01 12:31:42",
            "config_checksum": 31529194,
            "data_limit": 1,
            "disable_live_stream": true,
            "dms_enabled": false,
            "deleted_at": "2024-01-01 12:31:42",
            "device_id": "12345",
            "driver_id": "67376042394",
            "driver_name": "Garry Rowe",
            "driver_last_update": "2024-01-01 12:31:42",
            "driver_recognition": null,
            "flood_blocked": -96201719,
            "general_status": null,
            "groups": [
                "fugiat minim enim voluptate tempor",
                "in",
                "est"
            ],
            "installed_by_user_id": null,
            "is_installation": false,
            "is_installation_report": true,
            "last_disconnected_ts": "2024-01-01 12:31:42",
            "last_sleep_connected_ts": "2024-01-01 12:31:42",
            "last_sleep_disconnected_ts": "2024-01-01 12:31:42",
            "live_online": false,
            "matching_token": "ad culpa minim voluptate nostrud",
            "modem_img": 1,
            "modem": {
                "current_firmware": null,
                "firmware_status": "firmware out of date",
                "firmware_updated_ts": null,
                "imei": 61899221,
                "manufacturer": null,
                "model": null,
                "pending_firmware": null,
                "simcard_iccid": "Passenger Van=Passen",
                "version": null
            },
            "online_gps": false,
            "parking_duration": 480,
            "partner_device": null,
            "partner_name": "Mueller, Runte and Koelpin",
            "pending_config": {
                "adas_camera_height": "150",
                "adas_camera_offset": "0",
                "adas_vehicle_hood_len": "150",
                "adas_vehicle_width": "170",
                "canbus": "0",
                "cardreader": false,
                "parking_duration": "et cupidatat proident",
                "timezone": "2024-01-01 12:31:42"
            },
            "power_img": 90392659,
            "recording_status": "OK",
            "silence_err_notifs": null,
            "status": "used",
            "serial_number": null,
            "sleep_mode_enabled": false,
            "tag_plate": null,
            "timezone": "America/Sitka",
            "uploaded_company_profile": null,
            "users": [
                25229953,
                -24168739
            ],
            "vehicle_icon": null,
            "vehicle_name": "ullamco anim nostrud eiusmod",
            "vin_number": "eiusmod eu",
            "windshield_img": 1
        }
    },
    "result": "OK"
}

🟠400update none existing device device

🟠400update a device with an existing name

🟠401Login Required