API Reference

Creates asset.

post
https://asset-management.api.eu1.scalar.zf.com/v1/assets

Creates an asset.

📘

The rate limit for this API is normal.


Body Params

Provides details to create a new asset.

A JSON Merge Patch object as defined by RFC 7386

string | null

Represents the Asset name.

string | null

Represents the Asset code used for internal identification.

string | null

Represents the Asset code used for external identification.

string
enum

Represents the type of the Asset.

Allowed:
assignees
object | null

Represents the field to assign either teams or users to an asset.Or it can be accessed by all when the All property is set True.

string

Represents License-plate details.

string | null

Represents the Vehicle Identification Number (VIN) (Chassis number). When TDA feature is enabled for an organization it is mandatory. For trailer asset types it is optional.

string | null
enum
Defaults to Active

Represents status of the asset.

Allowed:
devices
array of strings | null

Represents a list of devices connected to the asset. Type of device can be anyone of the device types mentioned: txgo, txgo2, txg03, simtxgo, simtxgo2, simtxgo3, daf, tp, tpnb, tpsim, txtrailerguard, simtxtrailerguard, munic, traxee, simtraxee, scania, tcu350c, tmd102, tmd104, tmd200, tmd200a, and mcu.

devices
customLabels
object | null

Represents Custom labels.

string
enum
Defaults to notConnected

Represents the tacho version of the asset. Available only for assetType : car, van, and truck. Tacho version is not required for trailer asset type.

Allowed:
tachoDetail
object | null

Represents the tacho details. It is mandatory when TDA feature is enabled for the organization. Tacho detail is not required for trailer asset type.

double
Defaults to 0

Represents the mileage of the Asset.

string
enum
Defaults to Unknown

Represents the category of the Asset.

string | null

Model setting of the asset.

string | null

Segment setting of the asset.

string | null

Manufacturer setting of the asset

string | null

trailer type of the asset

string | null

Fleet Id

integer
Defaults to 0

Seating Capacity of the Asset

string | null
enum

Energy Source of the asset

string | null
enum

Emission norms of the asset

Allowed:
assetMetadata
object
int32
Defaults to 0

Wheelchair Capacity of the Asset

string | null

Country of registration of the asset. Two-letter country codes (e.g., US for United States, DE for Germany) as per ISO 3166-1 alpha-2 standard.

date-time | null

Next inspection or mandatory checkup date of the asset

Responses

401

Unauthorized access.

429

Too many requests.

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?