GET api/LocationsExternal

Request Information

URI Parameters

None.

Body Parameters

Collection of LocationInfoBasic

Name	Type	Additional information
LocationID	integer	None.
LocationName	string	None.
PhotoURL	string	None.
LocationModuleFlags	string	None.
SecurityDeviceID	integer	None.
DeviceList	Collection of DeviceInfoBasic	None.
ServiceType	string	None.
CanSupportMultiPartition	integer	None.
IsLocationToBeDisplayed	boolean	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "LocationID": 1,
    "LocationName": "sample string 2",
    "PhotoURL": "sample string 3",
    "LocationModuleFlags": "sample string 4",
    "SecurityDeviceID": 5,
    "DeviceList": [
      {
        "DeviceID": 1,
        "DeviceName": "sample string 2",
        "DeviceClassID": 3,
        "DeviceSerialNumber": "sample string 4",
        "DeviceFlags": "sample string 5",
        "DeviceSerialText": "sample string 7",
        "DeviceType": "sample string 8",
        "DeviceVariants": "sample string 9",
        "RestrictedPanel": 10
      },
      {
        "DeviceID": 1,
        "DeviceName": "sample string 2",
        "DeviceClassID": 3,
        "DeviceSerialNumber": "sample string 4",
        "DeviceFlags": "sample string 5",
        "DeviceSerialText": "sample string 7",
        "DeviceType": "sample string 8",
        "DeviceVariants": "sample string 9",
        "RestrictedPanel": 10
      }
    ],
    "ServiceType": "sample string 6",
    "CanSupportMultiPartition": 7,
    "IsLocationToBeDisplayed": true
  },
  {
    "LocationID": 1,
    "LocationName": "sample string 2",
    "PhotoURL": "sample string 3",
    "LocationModuleFlags": "sample string 4",
    "SecurityDeviceID": 5,
    "DeviceList": [
      {
        "DeviceID": 1,
        "DeviceName": "sample string 2",
        "DeviceClassID": 3,
        "DeviceSerialNumber": "sample string 4",
        "DeviceFlags": "sample string 5",
        "DeviceSerialText": "sample string 7",
        "DeviceType": "sample string 8",
        "DeviceVariants": "sample string 9",
        "RestrictedPanel": 10
      },
      {
        "DeviceID": 1,
        "DeviceName": "sample string 2",
        "DeviceClassID": 3,
        "DeviceSerialNumber": "sample string 4",
        "DeviceFlags": "sample string 5",
        "DeviceSerialText": "sample string 7",
        "DeviceType": "sample string 8",
        "DeviceVariants": "sample string 9",
        "RestrictedPanel": 10
      }
    ],
    "ServiceType": "sample string 6",
    "CanSupportMultiPartition": 7,
    "IsLocationToBeDisplayed": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfLocationInfoBasic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2Domain">
  <LocationInfoBasic>
    <CanSupportMultiPartition>7</CanSupportMultiPartition>
    <DeviceList>
      <DeviceInfoBasic>
        <DeviceClassID>3</DeviceClassID>
        <DeviceFlags>sample string 5</DeviceFlags>
        <DeviceID>1</DeviceID>
        <DeviceName>sample string 2</DeviceName>
        <DeviceSerialNumber>sample string 4</DeviceSerialNumber>
        <DeviceSerialText>sample string 7</DeviceSerialText>
        <DeviceType>sample string 8</DeviceType>
        <DeviceVariants>sample string 9</DeviceVariants>
        <RestrictedPanel>10</RestrictedPanel>
        <SecurityPanelTypeID>6</SecurityPanelTypeID>
      </DeviceInfoBasic>
      <DeviceInfoBasic>
        <DeviceClassID>3</DeviceClassID>
        <DeviceFlags>sample string 5</DeviceFlags>
        <DeviceID>1</DeviceID>
        <DeviceName>sample string 2</DeviceName>
        <DeviceSerialNumber>sample string 4</DeviceSerialNumber>
        <DeviceSerialText>sample string 7</DeviceSerialText>
        <DeviceType>sample string 8</DeviceType>
        <DeviceVariants>sample string 9</DeviceVariants>
        <RestrictedPanel>10</RestrictedPanel>
        <SecurityPanelTypeID>6</SecurityPanelTypeID>
      </DeviceInfoBasic>
    </DeviceList>
    <IsLocationToBeDisplayed>true</IsLocationToBeDisplayed>
    <LocationID>1</LocationID>
    <LocationModuleFlags>sample string 4</LocationModuleFlags>
    <LocationName>sample string 2</LocationName>
    <PhotoURL>sample string 3</PhotoURL>
    <SecurityDeviceID>5</SecurityDeviceID>
    <ServiceType>sample string 6</ServiceType>
  </LocationInfoBasic>
  <LocationInfoBasic>
    <CanSupportMultiPartition>7</CanSupportMultiPartition>
    <DeviceList>
      <DeviceInfoBasic>
        <DeviceClassID>3</DeviceClassID>
        <DeviceFlags>sample string 5</DeviceFlags>
        <DeviceID>1</DeviceID>
        <DeviceName>sample string 2</DeviceName>
        <DeviceSerialNumber>sample string 4</DeviceSerialNumber>
        <DeviceSerialText>sample string 7</DeviceSerialText>
        <DeviceType>sample string 8</DeviceType>
        <DeviceVariants>sample string 9</DeviceVariants>
        <RestrictedPanel>10</RestrictedPanel>
        <SecurityPanelTypeID>6</SecurityPanelTypeID>
      </DeviceInfoBasic>
      <DeviceInfoBasic>
        <DeviceClassID>3</DeviceClassID>
        <DeviceFlags>sample string 5</DeviceFlags>
        <DeviceID>1</DeviceID>
        <DeviceName>sample string 2</DeviceName>
        <DeviceSerialNumber>sample string 4</DeviceSerialNumber>
        <DeviceSerialText>sample string 7</DeviceSerialText>
        <DeviceType>sample string 8</DeviceType>
        <DeviceVariants>sample string 9</DeviceVariants>
        <RestrictedPanel>10</RestrictedPanel>
        <SecurityPanelTypeID>6</SecurityPanelTypeID>
      </DeviceInfoBasic>
    </DeviceList>
    <IsLocationToBeDisplayed>true</IsLocationToBeDisplayed>
    <LocationID>1</LocationID>
    <LocationModuleFlags>sample string 4</LocationModuleFlags>
    <LocationName>sample string 2</LocationName>
    <PhotoURL>sample string 3</PhotoURL>
    <SecurityDeviceID>5</SecurityDeviceID>
    <ServiceType>sample string 6</ServiceType>
  </LocationInfoBasic>
</ArrayOfLocationInfoBasic>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of LocationDetail

Name	Type	Additional information
id	integer	None.
name	string	None.
PhotoURL	string	None.
LocationModuleFlags	string	None.
ServiceType	string	None.
CanSupportMultiPartition	integer	None.
devices	Collection of LocationDeviceInfoBasic	None.
IsLocationToBeDisplayed	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "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
  }
]

application/xml, text/xml

Sample:

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