Iris API Reference
Start typing to search…

Onboard asset

post
https://iris.trackunit.com/api/asset/v1/assets/onboard

This API request can be used to onboard an asset along with a bluetooth telematics devices.

To be able to call the service a valid token is required. To get a token follow this guide : How to obtain a token

Body Params
string
enum
required
TypeDescription
AttachmentA thing which can be added/attached to something else (machine or equipment) in order to make it more useful or versatile.
ToolA small powered asset.
EquipmentA non-powered asset.
OtherAnything not matching the other asset types.
Allowed:
string
length between 0 and 256

The brand of the asset.

string
length between 0 and 100

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

string
length between 0 and 256

The model type of the asset.

string
required
length between 0 and 127

The name of the asset.

date
An optional field to specify the exact production date of the asset in the format YYYY-MM-DD when more precision is needed.
Minimum allowed year for production date is 1900. Maximum allowed year for production date is current year plus one.
The year of Production Date must match Production Year if both are provided together.
int32
The year the asset was produced. Minimum allowed production year is 1900. Maximum allowed production year is current year plus one.
Production Year must match the year of Production Date if both are provided together.
string
length between 0 and 100

The asset serial number (VIN, PIN etc.).

telematicsDevices
array
required
length between 1 and 1

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

telematicsDevices*
string
required
length ≥ 1

The serial number of the telematics device.

string
enum
required

The type of the telematics device

Allowed:
string
required
length ≥ 1

The Bluetooth company identifier of the telematics device. Only Trackunit approved company identifiers will be tracked by the Trackunit network.

string
length between 0 and 50

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json
Updated 4 months ago