Retrieve the Device by airId

get https://qa.connect.calamp.com/connect/services/devices/airid/{airId}

Returns the Device

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.

type

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

pegBehavior

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

asset

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

replacedDevice

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 Device 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

serviceProfile

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

Name of the device. Max Length = 32 characters.

int64

MUST be present in the resource object in request body for PUT requests. MUST NOT be present for POST requests. Will result in an HTTP 400 - Bad Request response if provided in POST.

port

int32

0 to 65535

The latest communication port reported by the device.

publicKey

string

The public key of the key fob, in hexadecimal format. Max Length = 128 characters.

description

string

Description of the device. Max Length = 255 characters

status

string

Status of the device and their effects

Enabled : Messages from device are processed, stored and retrievable via DataPump. DeviceCommands can be sent.
Suspended : Messages from device are processed and stored.
Disabled : Messages are discarded.
Deleted : Same as for other entities, Device is deleted.

Enabled Disabled Suspended Deleted Pending_Delete

esn

string

The ESN of the device. Max Length = 32 characters.

serialNumber

string

The Serial Number of the device. Max Length = 64 characters.

userESN

string

The User ESN of the device which represents the User Defined Mobile Id Type 8. Max Length = 32 characters. ESN is required when userESN is provided.

imei2

string

The IMEI2 of the device. Max Length = 32 characters.

macAddress

string

The mac address of the key fob, in hexadecimal format. Max Length = 32 characters.

createdOn

date-time

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

min

int64

The MIN of the device.

deletionDate

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When this Device was deleted.

meid

string

The MEID of the device. Max Length = 32 characters.

iccid

string

The ICCID of the device. Max Length = 32 characters.

imei

string

The IMEI of the device. Max Length = 32 characters.

isdn

string

The ISDN of the device. Max Length = 32 characters.

airId

string

A unique identifier generated by the service on device creation.

ipAddress

string

The latest IP address reported by the device. Max Length = 32 characters.

urlAvailable

boolean

Indicates if this device configuration page is available or not.

externalId

string

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

shipDate

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Date when the device was shipped. shipdate-update permission is required to modify the field.

mdn

string

The MDN or phone number of the device. Max Length = 16 characters.

imsi

string

The IMSI of the device. Max Length = 32 characters.

features

object

Allowed values for Features and States are as follows:

Features : [ICN, BLE, IVT, TPMS, WETS, DOOR, CARGO, BMS, LMS, WMS, EA, ATTACHMENTS].
Features: 'TPMS', 'WETS', 'DOOR', 'CARGO', 'BMS', 'LMS', 'WMS', 'EA' are not supported for PULS device so always default to 'Disabled'
States : [Enabled, Disabled, PendingEnable, PendingDisable].
Default value for state is Disabled. PendingEnable and PendingDisable are read-only states.
Attachments : [DICKEYJOHN, FORCEAMERICA, CIRRUS, RAVEN, VULCAN, ROADWATCH, DSP100, GENERICSENSOR].
Supplying Null to Attachments will retain old attachments. To remove attachments, supply empty String("")

Has additional fields

activationDate

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. When this Device was activated.

splitTagMessages

boolean

Shows if the TagReports for the LocoMessage needs to be split while sending to DP. Read-only.

provisionStatus

string

The provisionstatus of the device. Max Length = 32 characters. @Deprecated.

lastModifiedCarrierStatus

date-time

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this device's carrier status was modified. Generated and managed by the server. Deprecated. Now always empty/null

smsConfiguration

object

Represents a SMS Configuration

_self

object

Represents a resource in the system

phoneNumber

string

required

The phone number to sent the sms.

phoneCarrier

string

required

Defaults to 'null'

[AllTel AT&T Bell Mobility (Canada) Boost Mobile Cellular South Cingular Wireless Cricket Wireless Fido (Canada) Koodo Mobile (Canada) Metro PCS MTS (Canada) Nextel Rogers (Canada) SaskTel (Canada) Sprint PCS T-Mobile Telus (Canada) US Cellular Verizon PCS Verizon Pagers Virgin Mobile (Canada) Virgin Mobile (USA) UNKNOWN

userDefinedMobileId

string

The User Defined Mobile Id of the device. Max Length = 32 characters. esn is required when userDefinedMobileId is provided.

sciDeviceSettings

object

Represents an SCI device setting in the system

settings

object

Active SCI Settings

pendingSettings

object

Pending SCI Settings

firmwareVersion

string

The version of firmware currently on the device

firmwareUpdate

string

The version of firmware scheduled to be uploaded to the device on its next report

model

string

The model (or type) of the device

peripheralVersions

object

peripheralVersions

lastModifiedOn

date-time

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

useAirtimePlan

boolean

Show if the device participates in airtime plan subscription. The value defaults to false, but becomes immutable once set to true.

activeAirtimePlan

object

Represents a device's subscription to a airtime plan.

terminationDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this Device was Terminated. Maintained by system based on status change. Read-only

description

string

Description of the device airtime. Max Length = 255 characters

airtimePlan

object

Represents a resource in the system

purchaseDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this Device was purchased. Maintained by system based on status change. Read-only

activationDate

date

yyyy-MM-dd'T'HH:mm:ss.SSSZ. Last time this Device was activated. Maintained by system based on status change. Read-only

version

int64

Defaults to 0

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

version

int64

Defaults to 0

Required for PUT, ignored for POST.

extensions

object

Properties of device stored in extensions structure.

Has additional fields

200successful operation