svcTC2API


Click here for a complete list of operations.

UpdateEventRecordHideState

Updates the hidden state of a device or audit event record. Hidden records are not returned during normal GetEvents requests unlessthe ShowHidden parameter is true.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
SessionId:
FilterClass:
EventRecordId:
IsHidden:

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/UpdateEventRecordHideState"

<?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>
    <UpdateEventRecordHideState xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <FilterClass>short</FilterClass>
      <EventRecordId>long</EventRecordId>
      <IsHidden>boolean</IsHidden>
    </UpdateEventRecordHideState>
  </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>
    <UpdateEventRecordHideStateResponse xmlns="https://services.alarmnet.com/TC2/">
      <UpdateEventRecordHideStateResult>
        <ResultCode>int</ResultCode>
        <ResultData>string</ResultData>
      </UpdateEventRecordHideStateResult>
    </UpdateEventRecordHideStateResponse>
  </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>
    <UpdateEventRecordHideState xmlns="https://services.alarmnet.com/TC2/">
      <SessionId>string</SessionId>
      <FilterClass>short</FilterClass>
      <EventRecordId>long</EventRecordId>
      <IsHidden>boolean</IsHidden>
    </UpdateEventRecordHideState>
  </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>
    <UpdateEventRecordHideStateResponse xmlns="https://services.alarmnet.com/TC2/">
      <UpdateEventRecordHideStateResult>
        <ResultCode>int</ResultCode>
        <ResultData>string</ResultData>
      </UpdateEventRecordHideStateResult>
    </UpdateEventRecordHideStateResponse>
  </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/UpdateEventRecordHideState?SessionId=string&FilterClass=string&EventRecordId=string&IsHidden=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"?>
<WebMethodResults xmlns="https://services.alarmnet.com/TC2/">
  <ResultCode>int</ResultCode>
  <ResultData>string</ResultData>
</WebMethodResults>

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/UpdateEventRecordHideState HTTP/1.1
Host: rs.alarmnet.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

SessionId=string&FilterClass=string&EventRecordId=string&IsHidden=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<WebMethodResults xmlns="https://services.alarmnet.com/TC2/">
  <ResultCode>int</ResultCode>
  <ResultData>string</ResultData>
</WebMethodResults>