View a Config

This API allows the user to view details of a device configuration configured in your account

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

API Response explanation

FieldDescriptionData Type
idUnique identifier representing the configurationString
nameName of the configurationString
descriptionDescription of the configurationString
trackingSchedule

Boolean value representing whether the tracking schedule is enabled.

True = Enabled
False = Disabled

boolean
groupListArray of objects representing the meta data of the groupList<GroupsVO>
groupIdUnique identifier representing the groupString
customerIdUnique identifier representing the customerLong
parentIdUnique identifier representing the parent groupString
nameName of the groupString
descriptionDescription of the groupString
configIdUnique identifier representing the configuration which is associated with this groupString
parentGroupFor internal Azuga useGroupLiteVO
createdByUnique identifier representing the user created the groupString
createdAtGroup created time in UTC millisecondsTimestamp
lastModifiedByUnique identifier representing the user modified the group last.String
lastModifiedAtLast modified time of the group in UTC millisecondsTimestamp
deleted

Boolean value represents the status of the deletion

True = Deleted
False = Active

boolean
deletedAtDeleted time of the group in UTC millisecondsTimestamp
colorHex code representing the Text color of the map icon.String
bgColorHex code representing the background color of the map iconString
adminUsersFor internal Azuga useString
userListArray of objects representing the meta-data of the administratorsList<JobUserVO>
idUnique identifier representing the administratorsString
firstNameFirst name of the administratorString
lastNameLast name of the administratorString
configurationObject representing the meta-data of the configurationConfigurationVO
ssodefaultFor internal Azuga useboolean
groupListStringComma-seperated strings representing the group names associated with the configurationString
hrsOfOperationArray of objects representing the work hours. If the field is black it represents 24/7 trackingList<HoursOfOperationVO>
idUnique identifier representing the hrsOfOperationString
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
startTimeStart time for the vehicle to be tracked. This is in hh:mm formatString
endTimeEnd time for the vehicle to be tracked. This is in hh:mm formatString
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
deviceConfigurationsArray of objects representing the configurations for different device types - Devices & Asset TrackersSet<DeviceConfiguration>
idUnique identifier representing the device configurationString
ignitionOnFrequencyTracking interval in minutes when the ignition is ONInteger
ignitionOffFrequencyTracking interval in hours when the ignition is OFFInteger
deviceTypeIdUnique identifier representing the device type
1 = Device
6 = Asset tracker
Integer
deviceVendorIdUnique identifier representing the device vendorInteger
deletedDelete status of the configuration
True = Deleted
False = Not deleted
boolean
deletedAtDeleted time of the configuration in UTC millisecondsTimestamp
buzzerEnabled

Boolean value representing the ON/OFF status of the buzzer

True = Buzzer is ON
False = Buzzer is OFF

boolean
highIgnitionOnFrequencyHigh frequency tracking interval in seconds when the ignition is ONInteger
highIgnitionOffFrequencyHigh frequency tracking interval in hours when the ignition is OFFInteger
statusChangedFor internal Azuga useboolean
ignitionChangedFor internal Azuga useboolean
errorError description - if anyList<Error>
recordsFilteredTotal number of configuration records filteredInteger
Path Params
string
required

Pass the configurationId of the required configuration

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain