GET api/v2/account/users/{userId}/locations/{locationId}/homeCard
Return List of Home card devices.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userId |
User ID |
integer |
Required |
locationId |
Location ID |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
HomeCardDevice
DeviceOrderName | Description | Type | Additional information |
---|---|---|---|
deviceOrderInfo | Collection of DeviceSortOrder |
None. |
Response Formats
application/json, text/json
Sample:
{ "deviceOrderInfo": [ { "DeviceId": 1, "DeviceOrder": 2, "DeviceClassId": 3, "DeviceInfo": [ { "ChildDeviceID": 1, "ChildDeviceType": 2 }, { "ChildDeviceID": 1, "ChildDeviceType": 2 } ], "Status": {} }, { "DeviceId": 1, "DeviceOrder": 2, "DeviceClassId": 3, "DeviceInfo": [ { "ChildDeviceID": 1, "ChildDeviceType": 2 }, { "ChildDeviceID": 1, "ChildDeviceType": 2 } ], "Status": {} } ] }
application/xml, text/xml
Sample:
<DeviceOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain"> <deviceOrderInfo> <DeviceSortOrder> <DeviceClassId>3</DeviceClassId> <DeviceId>1</DeviceId> <DeviceInfo> <ChildDeviceInfo> <ChildDeviceID>1</ChildDeviceID> <ChildDeviceType>2</ChildDeviceType> </ChildDeviceInfo> <ChildDeviceInfo> <ChildDeviceID>1</ChildDeviceID> <ChildDeviceType>2</ChildDeviceType> </ChildDeviceInfo> </DeviceInfo> <DeviceOrder>2</DeviceOrder> <Status /> </DeviceSortOrder> <DeviceSortOrder> <DeviceClassId>3</DeviceClassId> <DeviceId>1</DeviceId> <DeviceInfo> <ChildDeviceInfo> <ChildDeviceID>1</ChildDeviceID> <ChildDeviceType>2</ChildDeviceType> </ChildDeviceInfo> <ChildDeviceInfo> <ChildDeviceID>1</ChildDeviceID> <ChildDeviceType>2</ChildDeviceType> </ChildDeviceInfo> </DeviceInfo> <DeviceOrder>2</DeviceOrder> <Status /> </DeviceSortOrder> </deviceOrderInfo> </DeviceOrder>