Attach telematics device

This API request can be used to create a bluetooth telematics device and attach it to an existing asset.

Currently only one bluetooth telematics device can be attached to the asset.

⚠️

Beta Version

Please note that this version of the API is currently in beta and might change without warning until a stable V2 is released. This beta version supports the asset type "vehicle", for any other asset types we recommend using V1 for now.

Path Params
string
required
Body Params
telematicsDevices
array
required
length between 1 and 1

List of telematics devices. Currently exactly 1 telematics device is required for asset onboarding

telematicsDevices*
Responses

Response body
object
string
required
TypeDescription
MachineBattery or fuel-powered heavy assets controlled by an operator.
VehicleHeavy assets used for transporting people or goods, especially on land.
GatewayServe as a communication managers between bluetooth tags and the Iris platform.
AttachmentItems added to machines or equipment for enhanced functionality.
ToolSmall powered assets like impact drills or high-pressure washers.
EquipmentNon-powered assets like wheelbarrows or containers.
OtherAssets that do not fit into the defined categories.

MACHINE VEHICLE GATEWAY OTHER ATTACHMENT EQUIPMENT TOOL

string

The brand of the asset.

date-time
required

Timestamp indicating when the asset was created on Iris platform.

string

An external reference on the asset that can be used to store the identifier from other systems such as ERPs.

string
required

The ID of the asset.

string

The model of the asset.

string
required

The name of the asset.

string
required

The ID of the owner account.

date

The production date of the asset.

int32
≥ 1900

The year the asset was produced.

string

The asset serial number (e.g VIN).

telematicsDevices
array of objects

List of associated telematics devices.

telematicsDevices
object
string

Device type, e.g. KIN, TU600, SPOT2.

string
required

ID of telematics device.

string

Serial number of the device.

string

The type of the asset (excavator, lift, bucket etc.)

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json