Retrieve an Asset.

get https://qa.connect.calamp.com/connect/services/assets/{id}

Returns the Asset with extendedAttribute.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

_self

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

Relation to the resource represented by the Link, within the context of the containing resource. While a Link represents a specific resource in the system, the 'rel' property defines the type of the association between the containing resource and the linked resource.Except for the 'self', 'first', 'last', 'next', 'prev' relations, generally it is the type of the resource at the other end of the association. E.g. 'asset', 'device', 'pegBehavior, 'role', 'primary-operator', etc.

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

groups

array of objects

Links to Groups to which the resource belongs.

groups

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

extendedAttribute

object

Represents an Extended Attribute in the system

value

string

required

Supplemental data. The application can store any string here as meta-data for a given resource. Max size = 1MB

createdOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When was this extendedAttribute created.

application

object

Represents a resource in the system

lastModifiedOn

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When was this extendedAttribute last modified.

account

object

required

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

route

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

ioProfile

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

schedules

array of objects

Schedules to which the Asset is associated with. Read-only

schedules

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

sensorLayout

object

Represents a resource in the system

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

name

string

required

The Asset name. Max Length = 32 characters

int64

Generated and managed by the server. Read-only. Required for any PUT requests.

color

string

Color of the vehicle

year

string

Year of manufacture for the vehicle. Max Length = 4 characters

fuelTankCapacity

int32

Fuel tank capacity of the vehicle

fuelEfficiencyHighway

int32

Fuel efficiency highway of the vehicle

fuelEfficiencyCity

int32

Fuel efficiency city of the vehicle

idLegalPerHour

double

odometerOffset

float

Odometer Offset of the vehicle

vehicleCategoryId

int32

Vehilce category ID of the vehicle

fuelEfficiencyCombined

int32

Fuel efficiency combined of the vehicle

odometerReferenceUnit

string

Default based on region. US default unit 'mi', UK default unit 'km'

mi km Default

odometerReferenceTime

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Odometer reference time. Read-only.

engineHoursOffset

int64

Engine Hours Offset of the vehicle

engineHoursReference

int64

The number of hours that the engine has run, as recorded on engineHoursReferenceTime, for calculation of engineHoursOffset.

engineHoursReferenceTime

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Engine Hours reference time. Read-only.

odometerReference

float

Odometer reference of the vehicle

description

string

Description for the vehicle. Max Length = 256 characters

model

string

Model of the vehicle. Max Length = 100 characters

vin

string

VIN number of the vehicle.

createdOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

assetType

string

Type of the Asset.

externalId

string

The ExternalId of the Asset. Useful as correlation identifier between CTC and an external system. Max Length = 64 characters.

assetCategory

string

Category of the Asset.

fuelType

string

FuelTypes : G[Gas], D[Diesel], H[Hybrid], E[Electric]. The fuel type of device can be of

G D H E

manufacturer

string

Manufacturer of the vehicle. Max Length = 100 characters

make

string

Make of the vehicle. Max Length = 100 characters

vinRegion

string

VinRegion of Device. DEFAULT 'US'

mappingIconId

int32

uninstallDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

dateSeedTaken

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Date that the odometer was verified with in-vehicle value.

licenseNumber

string

The vehicle's license number. Max Length = 32 characters

licenseState

string

State the vehicle is registered in. Max Length = 32 characters

seedValue

int32

d2aOffset

int32

verified

boolean

Defaults to false. = ['true', 'false']

installDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

useTelematics

int32

unpowered

boolean

Defaults to false. = ['true', 'false'].

imageUrl

string

Image url for Asset

vehicleTypeId

int32

vehicle type id of the vehicle

lastModifiedOn

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Generated and managed by the service. Read-only.

version

int64

Defaults to 0

Read-only. Managed by the service. Required for PUT, ignored for POST.

extensions

object

Properties of asset stored in extensions structure.

Has additional fields

devices

array of objects

Collection of Link<Device> associated with this asset.

devices

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

operators

array of objects

Collection of Link<Operator> associated with this Asset. The following rules apply for determining the primary-operator relation unless explicitely specified:

If there are no assigned operators, the first operator assigned is also flagged as primary
If there is already a primary operator, any additional operators will not change the primary operator status
If the primary operator is removed from the asset, the next least operator id in the list is flagged as primary

operators

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

assets

array of objects

Collection of Link<Assets> associated with this asset.

assets

object

href

string

required

The URI of the resource this Link represents.

rel

string

required

status

string

Status of the resource represented by this Link.

Enabled Disabled Suspended Deleted Pending_Delete

title

string

Some descriptive text about the Link. Generally name of the resource represented by this Link.

associationStatus

string

Association Status of the resource this link represent with the main(top-level) resource

PENDING DISSOCIATING

source

object

Represents a resource in the system

status

string

Status of the Asset. Default value is 'Enabled'

Enabled Disabled Suspended Deleted Pending_Delete

400

Invalid request.

403

Not authorized for this operation.

404

Not found.

417

Link expansion could not be completed.

500

Server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://qa.connect.calamp.com/connect/services/assets/id \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200successful operation