View all Configs

This API allows the user to view all the device configurations configured in your account

API Response explanation

Field

Description

Data Type

id

Unique identifier representing the configuration

String

name

Name of the configuration

String

description

Description of the configuration

String

trackingSchedule

Boolean value representing whether the tracking schedule is enabled.

True = Enabled
False = Disabled

boolean

groupList

Array of objects representing the meta data of the group

List<GroupsVO>

groupId

Unique identifier representing the group

String

customerId

Unique identifier representing the customer

Long

parentId

Unique identifier representing the parent group

String

name

Name of the group

String

description

Description of the group

String

configId

Unique identifier representing the configuration which is associated with this group

String

parentGroup

For internal Azuga use

GroupLiteVO

createdBy

Unique identifier representing the user created the group

String

createdAt

Group created time in UTC milliseconds

Timestamp

lastModifiedBy

Unique identifier representing the user modified the group last.

String

lastModifiedAt

Last modified time of the group in UTC milliseconds

Timestamp

deleted

Boolean value represents the status of the deletion

True = Deleted
False = Active

boolean

deletedAt

Deleted time of the group in UTC milliseconds

Timestamp

color

Hex code representing the Text color of the map icon.

String

bgColor

Hex code representing the background color of the map icon

String

adminUsers

For internal Azuga use

String

userList

Array of objects representing the meta-data of the administrators

List<JobUserVO>

id

Unique identifier representing the administrators

String

firstName

First name of the administrator

String

lastName

Last name of the administrator

String

configuration

Object representing the meta-data of the configuration

ConfigurationVO

ssodefault

For internal Azuga use

boolean

groupListString

Comma-seperated strings representing the group names associated with the configuration

String

hrsOfOperation

Array of objects representing the work hours. If the field is black it represents 24/7 tracking

List<HoursOfOperationVO>

id

Unique identifier representing the hrsOfOperation

String

day

Integer value representing the day of the week to be tracked

0 = Sunday
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday

Byte

startTime

Start time for the vehicle to be tracked. This is in hh:mm format

String

endTime

End time for the vehicle to be tracked. This is in hh:mm format

String

hooConfigType

Integer value representing the configuration type if the hrsOfOperation. The valid inputs are 1 & 2.

1 = Hours of operation(work hours) for normal tracking interval
2 = Hours of operation(work hours) for high frequency tracking interval

Integer

deviceConfigurations

Array of objects representing the configurations for different device types - Devices & Asset Trackers

Set<DeviceConfiguration>

id

Unique identifier representing the device configuration

String

ignitionOnFrequency

Tracking interval in minutes when the ignition is ON

Integer

ignitionOffFrequency

Tracking interval in hours when the ignition is OFF

Integer

deviceTypeId

Unique identifier representing the device type
1 = Device
6 = Asset tracker

Integer

deviceVendorId

Unique identifier representing the device vendor

Integer

deleted

Delete status of the configuration
True = Deleted
False = Not deleted

boolean

deletedAt

Deleted time of the configuration in UTC milliseconds

Timestamp

buzzerEnabled

Boolean value representing the ON/OFF status of the buzzer

True = Buzzer is ON
False = Buzzer is OFF

boolean

highIgnitionOnFrequency

High frequency tracking interval in seconds when the ignition is ON

Integer

highIgnitionOffFrequency

High frequency tracking interval in hours when the ignition is OFF

Integer

statusChanged

For internal Azuga use

boolean

ignitionChanged

For internal Azuga use

boolean

error

Error description - if any

List<Error>

recordsFiltered

Total number of configuration records filtered

Integer

Language
Credentials
Header
Click Try It! to start a request and see the response here!