GET api/v3/locations/{locationId}/devices/security/connectionState

Returns the current connection status of the security panel

Request Information

URI Parameters

Name	Description	Type	Additional information
locationId	Location ID	integer	Required

Body Parameters

None.

Response Information

Resource Description

PanelConnectionStatusInfoResults

Name	Type	Additional information
PanelStatusInfo	Collection of PanelConnectionStatusInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PanelStatusInfo": [
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "PhotoURL": "sample string 3",
      "ConnectionStatus": 4,
      "SyncStatus": 5,
      "SyncStatusMessage": "sample string 6",
      "ConnectionType": 7,
      "SingnalStrength": 1
    },
    {
      "LocationID": 1,
      "LocationName": "sample string 2",
      "PhotoURL": "sample string 3",
      "ConnectionStatus": 4,
      "SyncStatus": 5,
      "SyncStatusMessage": "sample string 6",
      "ConnectionType": 7,
      "SingnalStrength": 1
    }
  ],
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<PanelConnectionStatusInfoResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2WebAPIController.Models.V1.Security">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <PanelStatusInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:PanelConnectionStatusInfo>
      <d2p1:ConnectionStatus>4</d2p1:ConnectionStatus>
      <d2p1:ConnectionType>7</d2p1:ConnectionType>
      <d2p1:LocationID>1</d2p1:LocationID>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:PhotoURL>sample string 3</d2p1:PhotoURL>
      <d2p1:SingnalStrength>1</d2p1:SingnalStrength>
      <d2p1:SyncStatus>5</d2p1:SyncStatus>
      <d2p1:SyncStatusMessage>sample string 6</d2p1:SyncStatusMessage>
    </d2p1:PanelConnectionStatusInfo>
    <d2p1:PanelConnectionStatusInfo>
      <d2p1:ConnectionStatus>4</d2p1:ConnectionStatus>
      <d2p1:ConnectionType>7</d2p1:ConnectionType>
      <d2p1:LocationID>1</d2p1:LocationID>
      <d2p1:LocationName>sample string 2</d2p1:LocationName>
      <d2p1:PhotoURL>sample string 3</d2p1:PhotoURL>
      <d2p1:SingnalStrength>1</d2p1:SingnalStrength>
      <d2p1:SyncStatus>5</d2p1:SyncStatus>
      <d2p1:SyncStatusMessage>sample string 6</d2p1:SyncStatusMessage>
    </d2p1:PanelConnectionStatusInfo>
  </PanelStatusInfo>
</PanelConnectionStatusInfoResults>