create devices (auto-prov/DV6)

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

The snlist key contains a list of objects with each object containing the following keys:

snlist

Key	Type	Description
enable_ch3	bool: default=false	A flag value that when true will send a config with channel 3 enabled to the camera after install. This field is optional and defaults to false
tag_plate	string: default=""	The vehicle’s license plate number. This field is optional and defaults to null if no value is provided.
sn	string	For DV6 installation this will be the IMEI found on the camera.
vin (optional)	string: default=""	The VIN of the vehicle the camera is being installed in. After a device is created, the camera name will be assigned the VIN
name (optional)	string: default=vin	Name of the vehicle the camera is being installed in.
adas_vehicle_hood_len (optional)	float: default=0.0	The ADAS measurement for length from front of vehicle to camera. The units for this value are centimeters.
adas_camera_height (optional)	float: default=150.0	The ADAS measurement for the vertical distance from the ground to the camera. The units for this value are centimeters.
adas_vehicle_width (optional)	float: default=170.0	The ADAS measurement for the entire width of the vehicle. The units for this value are centimeters.
adas_camera_offset (optional)	float: default=0.0	The ADAS measurement for the distance from the center line of the vehicle to the camera looking inside out from the driver seat. Measurements left of center are positive numbers and measurements right of center are negative numbers. The units for this value are centimeters.

Request

Path Params

company_name

string

required

Name of the company on RoscoLive to create devices in.

Body Params multipart/form-data

snlist

string

required

A list of objects with each object containing the following keys: [{ "sn": string, "vin": string,"name": string,'enable_ch3': bool, 'tag_plate':string },...]

Each object in the list is a new device to be created.

Responses

🟢200Success

application/json

Body

meta

object

required

Request metadata object

code

integer

required

HTTP status code returned by server

response

object

required

Contains response data

devices

array [object {38}]

required

result

string

required

"OK" if request successful, otherwise "Failed"

Example

{
  "meta": {
    "code": 200
  },
  "response": {
    "devices": [
      {
        "active": true,
        "adas_camera_height": 150,
        "adas_camera_offset": 0,
        "adas_units": "imperial",
        "adas_vehicle_hood_len": 0,
        "adas_vehicle_width": 170,
        "ads_online": false,
        "canbus": "0",
        "cardreader": false,
        "channel_available": "1,2",
        "config_checksum": 0,
        "created_at": "Wed, 31 Jul 2024 18:02:01 GMT",
        "data_limit": 1,
        "data_online": false,
        "device_id": "3144799167",
        "device_type": "dv6",
        "disable_live_stream": false,
        "driver_recognition": "company_setting",
        "exceeded_livestream_limit": false,
        "firmware": null,
        "flood_blocked": false,
        "general_status": null,
        "groups": [
          "Installed Devices"
        ],
        "installed_by_user_id": 4737,
        "is_flagged": false,
        "live_online": false,
        "no_sd_card": false,
        "online_gps": false,
        "parking_duration": 60,
        "pending_company_profile": null,
        "serial_number": "015974000000231",
        "sleep": 0,
        "sleep_mode_enabled": false,
        "status": "used",
        "tag_plate": null,
        "vehicle_icon": "van",
        "vehicle_name": "015974000000231",
        "vin_number": null
      }
    ]
  },
  "result": "OK"
}

🟠401Login Required

🟠400Bad Request

Request

Request samples

Responses