Getalldevicesforalocation

GET

Get all devices for a location

Return all devices in a particular locationID.

{
    "displayedOutdoorHumidity": 67,
    "vacationHold": {
        "enabled": false
    },
    "currentSchedulePeriod": {
        "day": "Thursday",
        "period": "Away"
    },
    "scheduleCapabilities": {
        "availableScheduleTypes": [
            "None",
            "Geofenced",
            "TimedNorthAmerica"
        ],
        "schedulableFan": false
    },
    "scheduleType": {
        "scheduleType": "Timed",
        "scheduleSubType": "NA"
    },
    "scheduleStatus": "Resume",
    "allowedTimeIncrements": 15,
    "settings": {
        "hardwareSettings": {
            "brightness": 0,
            "maxBrightness": 5
        },
        "fan": {
            "allowedModes": [
                "On",
                "Auto",
                "Circulate"
            ],
            "changeableValues": {
                "mode": "On"
            }
        },
        "temperatureMode": {
            "air": true
        },
        "specialMode": {
            "autoChangeoverActive": false,
            "emergencyHeatActive": false
        }
    },
    "deviceClass": "Thermostat",
    "deviceType": "Thermostat",
    "deviceID": "LCC-00D02DAB5CBE",
    "userDefinedDeviceName": "TSeries",
    "name": "TSeries",
    "isAlive": true,
    "isUpgrading": false,
    "isProvisioned": true,
    "macID": "00D02DAB5CBE",
    "deviceSettings": {},
    "units": "Fahrenheit",
    "indoorTemperature": 73,
    "outdoorTemperature": 46,
    "allowedModes": [
        "EmergencyHeat",
        "Heat",
        "Off",
        "Cool",
        "Auto"
    ],
    "deadband": 0,
    "hasDualSetpointStatus": false,
    "minHeatSetpoint": 50,
    "maxHeatSetpoint": 90,
    "minCoolSetpoint": 50,
    "maxCoolSetpoint": 90,
    "changeableValues": {
        "mode": "Heat",
        "autoChangeoverActive": false,
        "emergencyHeatActive": false,
        "heatSetpoint": 62,
        "coolSetpoint": 85,
        "thermostatSetpointStatus": "NoHold",
        "nextPeriodTime": "18:00:00",
        "endHeatSetpoint": 62,
        "endCoolSetpoint": 85,
        "heatCoolMode": "Heat"
    },
    "operationStatus": {
        "mode": "EquipmentOff",
        "fanRequest": false,
        "circulationFanRequest": false
    }
}
Field Name/Location Data Type Definition
displayedOutdoorHumidity Integer Outdoor humidity reading (from weather data), should be treated as percentage
vacationHold Object
vacationHold.enabled Boolean Is vacation hold enabled?
scheduleCapabilities Object
scheduleCapabilities.availableScheduleTypes Array List of available schedule types
scheduleCapabilities.schedulableFan Boolean Is the fan mode scheduleable?
scheduleType Object
scheduleType.scheduleType String Current schedule type
scheduleType.scheduleSubType String Current schedule sub-type
scheduleStatus String Current status of schedule
allowedTimeIncrements Integer Allowed time increments of the timed schedule (in minutes)
settings Object
settings.hardwareSettings Object
settings.hardwareSettings.brightness Integer Current brightness setting
settings.hardwareSettings.maxBrightness Integer Maximum brightness setting
settings.fan Object
settings.fan.allowedModes Array Array of allowed fan modes
settings.fan.changeableValues Object List of writeable fan settings
settings.temperatureMode Object
settings.temperatureMode.air Boolean
settings.specialMode Object
settings.specialMode.autoChangeoverActive Boolean Will exist if device has this mode enabled, true or false based on running in that mode
settings.specialMode.emergencyHeatActive Boolean Will exist if device has this mode enabled, true or false based on running in that mode
deviceClass String Class of device
deviceType String Type of device
deviceID String Unique ID of device. "LCC-" == T-Series, "TCC-" == Lyric Round
userDefinedDeviceName String User defined name of the device. Shown in the mobile app.
name String Device name
isAlive Boolean true == device online. false == device offline
isProvisioned Boolean Is the device provisioned correctly or not
macID String Unique MACID of the device
deviceSettings Object
units String Units used on device (Celsius or Fahrenheit)
indoorTemperature Integer or Float Current display temperature on device. Whole numbers for F units or .5 increments for C units.
outdoorTemperature Integer or Float Current outdoor temperature based on location data.
allowedModes Array List of allowed modes for the device, also be sure to doublecheck settings.specialMode for Lyric Round.
deadband Integer Required separation between high and low setpoints. Default for Lyric Thermostats is 0.
hasDualSetpointStatus Boolean Indicates whether the thermostat maintains separate heat and cool setpoint status value.
minHeatSetpoint Integer or Float The lower limit for the heating setpoint.
maxHeatSetpoint Integer or Float The upper limit for the heating setpoint.
minCoolSetpoint Integer or Float The lower limit for the heating setpoint.
maxCoolSetpoint Integer or Float The upper limit for the heating setpoint.
changeableValues.mode String Current mode of the thermostat.
changeableValues.autoChangeoverActive Boolean If field is set in the response then the thermostat supports autochangeover to be controlled independent of mode. If field is not set in the response then the thermostat does not support autochangeover.
changeableValues.emergencyHeatActive Boolean Indicates if emergency heating is active. When this field is returned (it is nullable and does not have to be in the response) - it means that the device handles emergency heating independently of the mode. When this field is returned (it is nullable and does not have to be in the response) - device will not accept EmergencyHeat as an allowed value. When emergency heating is active you cannot set thermostat's mode to other value than Off and you cannot change autochangeover.
changeableValues.heatSetpoint Decimal Current heating setpoint.
changeableValues.coolSetpoint Decimal Current cooling setpoint.
changeableValues.thermostatSetpointStatus String Signifies current setpoint state. TemporaryHold, HoldUntil, PermanentHold, VacationHold, NoHold
changeableValues.holdUntil timeSpan Time in 15 minutes intervals (the maximum value is 92 = 11:45 PM), meaning depends on other properties.
changeableValues.nextPeriodTime timeSpan Indicates when next schedule period starts
changeableValues.endHeatSetpoint Decimal The heating setpoint that would occur if the current hold ended now. If there is no hold, or if the thermostat cannot control heating, then this value is not present.
changeableValues.endCoolSetpoint Decimal The cooling setpoint that would occur if the current hold ended now. If there is no hold, or if the thermostat cannot control cooling, then this value is not present.
changeableValues.heatCoolMode String Heat cool mode when system switch is in Auto mode.
operationStatus Object Details around operation status of the equipment.
operationStatus.mode String Current running (relay status) of the equipment.
operationStatus.fanRequest Boolean Current running (relay status) of the fan.
operationStatus.circulationFanRequest Boolean Current running (relay status) of the fan circulate mode.
smartAway Object Settings that will take effect when nobody is home (via Geofencing). Null when reported means smart away is not available.
indoorHumidity Decimal Indoor humidity rating as a percentage, currently only on Lyric Round thermostats
indoorHumidityStatus String Status of humidity sensor. Measured, NotAvailable, or SensorFault.
{
    "firmwareVer": "0.5.16A4",
    "waterPresent": false,
    "currentSensorReadings": {
        "time": "2017-10-19T08:27:42",
        "temperature": 20.39,
        "humidity": 44.8
    },
    "currentAlarms": [],
    "lastCheckin": "2017-10-19T08:27:44",
    "lastDeviceSettingUpdatedOn": "0001-01-01T00:00:00",
    "batteryRemaining": 43,
    "isRegistered": true,
    "hasDeviceCheckedIn": true,
    "isDeviceOffline": false,
    "firstFailedAttemptTime": "0001-01-01T00:00:00",
    "failedConnectionAttempts": 0,
    "wifiSignalStrength": -46,
    "isFirmwareUpdateRequired": false,
    "time": "2017-10-19T08:27:42",
    "deviceClass": "LeakDetector",
    "deviceType": "Water Leak Detector",
    "deviceID": "31aae686-6b4a-476e-8cbc-da4a1cab2cd5",
    "userDefinedDeviceName": "Basement",
    "backend": {
        "id": "31aae686-6b4a-476e-8cbc-da4a1cab2cd5"
    },
    "isAlive": true,
    "isUpgrading": false,
    "isProvisioned": true,
    "deviceSettings": {
        "temp": {
            "high": {
                "limit": 36.5
            },
            "low": {
                "limit": 6.5
            }
        },
        "humidity": {
            "high": {
                "limit": 70
            },
            "low": {
                "limit": 20
            }
        },
        "userDefinedName": "Basement",
        "buzzerMuted": false,
        "checkinPeriod": 8,
        "currentSensorReadPeriod": 60
    }
}
Field Name/Location Data Type Definition
firmwareVer String Current firmware version
waterPresent Boolean True if water has been detected
currentSensorReadings Object
currentSensorReadings.time DateTime Timestamp of last reading
currentSensorReadings.temperature Decimal Last read temperature, always in C units
currentSensorReadings.humidity Percentage Last read humidity, always a percentage
currentAlarms Object Array Array of objects for current alerts
lastCheckin DateTime Timestamp of last check-in
lastDeviceSettingUpdatedOn DateTime Date and time stamp of the last device setting change request
batteryRemaining Integer Battery life remaining as a percentage
isRegistered Boolean True/false if the device is registered
hasDeviceCheckedIn Boolean True/false if the device has checked-in to Honeywell servers.
isDeviceOffline Boolean True/false if the device is offline.
firstFailedAttemptTime DateTime
failedConnectionAttempts Integer
wifiSignalStrength Integer WiFi signal strength in db
isFirmwareUpdateRequired Boolean Does the device require a firmware update
time DateTime
deviceClass String Class of the device. "LeakDetector" for Water Leak Detector.
deviceType String Type of the device. "Water Leak Detector" for Water Leak Detector devices.
deviceID String Unique device ID
userDefinedDeviceName String User defined device name, what is shown in the Lyric App
backend Object
backend.id String Backend device ID
isAlive Boolean Is the device online or not.
isUpgrading Boolean Is the device currently running a firmware update?
isProvisioned Boolean Is the device provisioned correctly?
deviceSettings.temp Object Temperature limit settings for alerts
deviceSettings.temp.high Object
deviceSettings.temp.high.limit Decimal The device reading this temp will cause a high temperature alert. Always in C units.
deviceSettings.temp.low Object
deviceSettings.temp.low.limit Decimal The device reading this temp will cause a low temperature alert. Always in C units.
deviceSettings.humidity Object Temperature limit settings for alerts
deviceSettings.humidity.high Object
deviceSettings.humidity.high.limit Percentage The device reading this humidity will cause a high humidity alert.
deviceSettings.humidity.low Object
deviceSettings.humidity.low.limit Percentage The device reading this humidity will cause a low humidity alert.
deviceSettings.humidity Object Humidity limit settings for alerts
deviceSettings.userDefinedName String User defined device name
deviceSettings.buzzerMuted Boolean Buzzer muted true/false
deviceSettings.checkinPeriod Integer User set device check-in/reporting period for periodic readings
deviceSettings.currentSensorReadPeriod Integer Sensor reading period
{
    "model": "C2",
    "manufacturer": "Edimax",
    "serial": "1726ZA300023",
    "maxResolution": "1920x1080",
    "firmwareVer": "v1.26_20171017",
    "wifiStrength": "54",
    "deviceClass": "Camera",
    "deviceType": "C2",
    "deviceID": "c7a4c930-ef20-48ee-b8a4-74e4b4152ef8",
    "userDefinedDeviceName": "Camera",
    "isAlive": true,
    "isUpgrading": false,
    "isProvisioned": true,
    "macID": "74DA38D20850"
}
Field Name/Location Data Type Definition
model String Camera model
manufacturer String Camera manufacturer
serial String Camera serial number
maxResolution String Max display resoultion of the camera (WxH)
firmwareVer String Current firmware version
wifiStrength Integer Wifi signal strength
deviceClass String Class of device. "Camera" for cameras
deviceType String Type of camera (C1, C2, etc)
deviceID String Unique Device ID
userDefinedDeviceName String User defined device name. Shown in the Lyric App.
isAlive Boolean Is the device online or not?
isUpgrading Boolean Is the device currently performing a firmware update?
isProvisioned Boolean Is the device provisioned correctly?
macID Unique MACID of the device

Resource URL

https://api.honeywell.com/v2 /devices

Query Parameters


Name Values Description
apikey
(required)

Your API Key.

locationId
(required)

LocationID that belongs to the currently logged in user


Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Resource Summary

Security

Category

Thermostat, Water Leak Detector

Working...