GET api/locations

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Name	Description	Type	Additional information
locationDetailResult		Collection of LocationDetail	None.
UserId		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "locationDetailResult": [
    {
      "id": 1,
      "name": "sample string 2",
      "PhotoURL": "sample string 3",
      "LocationModuleFlags": "sample string 4",
      "ServiceType": "sample string 6",
      "CanSupportMultiPartition": 1,
      "devices": [
        {
          "id": 1,
          "name": "sample string 2",
          "deviceType": "sample string 3",
          "deviceVariants": "sample string 4",
          "deviceClass": "VideoPIR",
          "CanSupportArmNightStay": false,
          "userCodeAvailable": false
        },
        {
          "id": 1,
          "name": "sample string 2",
          "deviceType": "sample string 3",
          "deviceVariants": "sample string 4",
          "deviceClass": "VideoPIR",
          "CanSupportArmNightStay": false,
          "userCodeAvailable": false
        }
      ],
      "IsLocationToBeDisplayed": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "PhotoURL": "sample string 3",
      "LocationModuleFlags": "sample string 4",
      "ServiceType": "sample string 6",
      "CanSupportMultiPartition": 1,
      "devices": [
        {
          "id": 1,
          "name": "sample string 2",
          "deviceType": "sample string 3",
          "deviceVariants": "sample string 4",
          "deviceClass": "VideoPIR",
          "CanSupportArmNightStay": false,
          "userCodeAvailable": false
        },
        {
          "id": 1,
          "name": "sample string 2",
          "deviceType": "sample string 3",
          "deviceVariants": "sample string 4",
          "deviceClass": "VideoPIR",
          "CanSupportArmNightStay": false,
          "userCodeAvailable": false
        }
      ],
      "IsLocationToBeDisplayed": true
    }
  ],
  "UserId": 1
}

application/xml, text/xml

Sample:

<LocationDetailResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.ResultData">
  <UserId>1</UserId>
  <locationDetailResult xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
    <d2p1:LocationDetail>
      <d2p1:CanSupportMultiPartition>1</d2p1:CanSupportMultiPartition>
      <d2p1:IsLocationToBeDisplayed>true</d2p1:IsLocationToBeDisplayed>
      <d2p1:LocationModuleFlags>sample string 4</d2p1:LocationModuleFlags>
      <d2p1:PhotoURL>sample string 3</d2p1:PhotoURL>
      <d2p1:SecurityDeviceID>5</d2p1:SecurityDeviceID>
      <d2p1:ServiceType>sample string 6</d2p1:ServiceType>
      <d2p1:devices>
        <d2p1:LocationDeviceInfoBasic>
          <d2p1:CanSupportArmNightStay>false</d2p1:CanSupportArmNightStay>
          <d2p1:DeviceFlags>sample string 7</d2p1:DeviceFlags>
          <d2p1:DeviceSerialNumber>sample string 6</d2p1:DeviceSerialNumber>
          <d2p1:deviceClassID>5</d2p1:deviceClassID>
          <d2p1:deviceType>sample string 3</d2p1:deviceType>
          <d2p1:deviceVariants>sample string 4</d2p1:deviceVariants>
          <d2p1:id>1</d2p1:id>
          <d2p1:name>sample string 2</d2p1:name>
        </d2p1:LocationDeviceInfoBasic>
        <d2p1:LocationDeviceInfoBasic>
          <d2p1:CanSupportArmNightStay>false</d2p1:CanSupportArmNightStay>
          <d2p1:DeviceFlags>sample string 7</d2p1:DeviceFlags>
          <d2p1:DeviceSerialNumber>sample string 6</d2p1:DeviceSerialNumber>
          <d2p1:deviceClassID>5</d2p1:deviceClassID>
          <d2p1:deviceType>sample string 3</d2p1:deviceType>
          <d2p1:deviceVariants>sample string 4</d2p1:deviceVariants>
          <d2p1:id>1</d2p1:id>
          <d2p1:name>sample string 2</d2p1:name>
        </d2p1:LocationDeviceInfoBasic>
      </d2p1:devices>
      <d2p1:id>1</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
    </d2p1:LocationDetail>
    <d2p1:LocationDetail>
      <d2p1:CanSupportMultiPartition>1</d2p1:CanSupportMultiPartition>
      <d2p1:IsLocationToBeDisplayed>true</d2p1:IsLocationToBeDisplayed>
      <d2p1:LocationModuleFlags>sample string 4</d2p1:LocationModuleFlags>
      <d2p1:PhotoURL>sample string 3</d2p1:PhotoURL>
      <d2p1:SecurityDeviceID>5</d2p1:SecurityDeviceID>
      <d2p1:ServiceType>sample string 6</d2p1:ServiceType>
      <d2p1:devices>
        <d2p1:LocationDeviceInfoBasic>
          <d2p1:CanSupportArmNightStay>false</d2p1:CanSupportArmNightStay>
          <d2p1:DeviceFlags>sample string 7</d2p1:DeviceFlags>
          <d2p1:DeviceSerialNumber>sample string 6</d2p1:DeviceSerialNumber>
          <d2p1:deviceClassID>5</d2p1:deviceClassID>
          <d2p1:deviceType>sample string 3</d2p1:deviceType>
          <d2p1:deviceVariants>sample string 4</d2p1:deviceVariants>
          <d2p1:id>1</d2p1:id>
          <d2p1:name>sample string 2</d2p1:name>
        </d2p1:LocationDeviceInfoBasic>
        <d2p1:LocationDeviceInfoBasic>
          <d2p1:CanSupportArmNightStay>false</d2p1:CanSupportArmNightStay>
          <d2p1:DeviceFlags>sample string 7</d2p1:DeviceFlags>
          <d2p1:DeviceSerialNumber>sample string 6</d2p1:DeviceSerialNumber>
          <d2p1:deviceClassID>5</d2p1:deviceClassID>
          <d2p1:deviceType>sample string 3</d2p1:deviceType>
          <d2p1:deviceVariants>sample string 4</d2p1:deviceVariants>
          <d2p1:id>1</d2p1:id>
          <d2p1:name>sample string 2</d2p1:name>
        </d2p1:LocationDeviceInfoBasic>
      </d2p1:devices>
      <d2p1:id>1</d2p1:id>
      <d2p1:name>sample string 2</d2p1:name>
    </d2p1:LocationDetail>
  </locationDetailResult>
</LocationDetailResults>