GET api/v1/locations/{LocationId}/devices/{DeviceId}/readconsole

Polling API - to display 16x2 Aplha Keypad Display and Led Status of the security System

Request Information

URI Parameters

Name	Description	Type	Additional information
LocationId	Location ID	integer	Required
DeviceId	Device ID	integer	Required

Body Parameters

None.

Response Information

Resource Description

ReadConsoleDisplayResults

Name	Type	Additional information
ConsoleDisplay	ConsoleDisplayInfo	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ConsoleDisplay": {
    "Line1": "sample string 1",
    "Line2": "sample string 2",
    "LedStatus": 3
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<ReadConsoleDisplayResults 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>
  <ConsoleDisplay xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.Security">
    <d2p1:LedStatus>3</d2p1:LedStatus>
    <d2p1:Line1>sample string 1</d2p1:Line1>
    <d2p1:Line2>sample string 2</d2p1:Line2>
  </ConsoleDisplay>
</ReadConsoleDisplayResults>