svcTC2API
Click here for a complete list of operations.
ReadConsoleDisplay
Reads 16x2 Alpha Keypad Display and LED Status of Security System
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://services.alarmnet.com/TC2/ReadConsoleDisplay"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ReadConsoleDisplay xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<LocationID>long</LocationID>
<DeviceID>long</DeviceID>
</ReadConsoleDisplay>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ReadConsoleDisplayResponse xmlns="https://services.alarmnet.com/TC2/">
<ReadConsoleDisplayResult>
<ConsoleDisplay>
<Line1>string</Line1>
<Line2>string</Line2>
<LedStatus>int</LedStatus>
</ConsoleDisplay>
</ReadConsoleDisplayResult>
</ReadConsoleDisplayResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /tc21api/tc2.asmx HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ReadConsoleDisplay xmlns="https://services.alarmnet.com/TC2/">
<SessionID>string</SessionID>
<LocationID>long</LocationID>
<DeviceID>long</DeviceID>
</ReadConsoleDisplay>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<ReadConsoleDisplayResponse xmlns="https://services.alarmnet.com/TC2/">
<ReadConsoleDisplayResult>
<ConsoleDisplay>
<Line1>string</Line1>
<Line2>string</Line2>
<LedStatus>int</LedStatus>
</ConsoleDisplay>
</ReadConsoleDisplayResult>
</ReadConsoleDisplayResponse>
</soap12:Body>
</soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /tc21api/tc2.asmx/ReadConsoleDisplay?SessionID=string&LocationID=string&DeviceID=string HTTP/1.1 Host: rs.alarmnet.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ReadConsoleDisplayResults xmlns="https://services.alarmnet.com/TC2/">
<ConsoleDisplay>
<Line1>string</Line1>
<Line2>string</Line2>
<LedStatus>int</LedStatus>
</ConsoleDisplay>
</ReadConsoleDisplayResults>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /tc21api/tc2.asmx/ReadConsoleDisplay HTTP/1.1 Host: rs.alarmnet.com Content-Type: application/x-www-form-urlencoded Content-Length: length SessionID=string&LocationID=string&DeviceID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ReadConsoleDisplayResults xmlns="https://services.alarmnet.com/TC2/">
<ConsoleDisplay>
<Line1>string</Line1>
<Line2>string</Line2>
<LedStatus>int</LedStatus>
</ConsoleDisplay>
</ReadConsoleDisplayResults>