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

Save Homecard Devices

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	User ID	integer	Required
locationId	Location ID	integer	Required

Body Parameters

List of Device sort order

HomeCardItemOrder

Name	Description	Type	Additional information
ItemOrderInfo		Collection of ItemOrderInfo	None.

Request 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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResults

Name	Description	Type	Additional information
ResultCode		integer	None.
ResultData		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<BaseResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">
  <ResultCode>1</ResultCode>
  <ResultData>sample string 2</ResultData>
</BaseResults>