GET api/v1/account/users/{userId}/locations/{locationId}/homeCardEx

Return List of Home card devices.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

User ID

integer

Required

locationId

Location ID

integer

Required

Body Parameters

None.

Response Information

Resource Description

HomeCardDevice

HomeCardItemOrder
NameDescriptionTypeAdditional information
ItemOrderInfo

Collection of ItemOrderInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "ItemOrderInfo": [
    {
      "ItemTypeID": 1,
      "ItemOrderID": 1,
      "ItemInfo": [
        {
          "DeviceId": 1,
          "ChildItemID": 2,
          "ChildItemType": 1,
          "ChildItemOrderID": 3
        },
        {
          "DeviceId": 1,
          "ChildItemID": 2,
          "ChildItemType": 1,
          "ChildItemOrderID": 3
        }
      ]
    },
    {
      "ItemTypeID": 1,
      "ItemOrderID": 1,
      "ItemInfo": [
        {
          "DeviceId": 1,
          "ChildItemID": 2,
          "ChildItemType": 1,
          "ChildItemOrderID": 3
        },
        {
          "DeviceId": 1,
          "ChildItemID": 2,
          "ChildItemType": 1,
          "ChildItemOrderID": 3
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<HomeCardItemOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain">
  <ItemOrderInfo>
    <ItemOrderInfo>
      <ItemInfo>
        <ItemInfo>
          <ChildItemID>2</ChildItemID>
          <ChildItemOrderID>3</ChildItemOrderID>
          <ChildItemType>Lock</ChildItemType>
          <DeviceId>1</DeviceId>
        </ItemInfo>
        <ItemInfo>
          <ChildItemID>2</ChildItemID>
          <ChildItemOrderID>3</ChildItemOrderID>
          <ChildItemType>Lock</ChildItemType>
          <DeviceId>1</DeviceId>
        </ItemInfo>
      </ItemInfo>
      <ItemOrderID>1</ItemOrderID>
      <ItemTypeID>SecuritySystemPanel</ItemTypeID>
    </ItemOrderInfo>
    <ItemOrderInfo>
      <ItemInfo>
        <ItemInfo>
          <ChildItemID>2</ChildItemID>
          <ChildItemOrderID>3</ChildItemOrderID>
          <ChildItemType>Lock</ChildItemType>
          <DeviceId>1</DeviceId>
        </ItemInfo>
        <ItemInfo>
          <ChildItemID>2</ChildItemID>
          <ChildItemOrderID>3</ChildItemOrderID>
          <ChildItemType>Lock</ChildItemType>
          <DeviceId>1</DeviceId>
        </ItemInfo>
      </ItemInfo>
      <ItemOrderID>1</ItemOrderID>
      <ItemTypeID>SecuritySystemPanel</ItemTypeID>
    </ItemOrderInfo>
  </ItemOrderInfo>
</HomeCardItemOrder>