Go to documentation repository
Page History
General request format:
GET http://IP-address:port/web2/secure/configuration/{objectClass}:{id}/state/
Request parameters:
Parameter | Is required | Description |
|---|---|---|
| objectClass | Yes | Object class ID |
| id | Yes | Object ID |
Request example:
GET http://127.0.0.1:8085.com:[port]/web2/secure/configuration/GRAY:2/state/ - getting a state for the Sensor object with id 2.
Sample of response:
<state>
<fullState>ON,ARMED</fullState>
<id>armed</id>
<type>NORMAL</type>
</state>
Response example:
| Code Block | ||
|---|---|---|
| ||
<GRAY>
<id>GRAY:2</id>
<name>Gray 2</name>
<state>
<id>alarmed</id>
</state>
</GRAY> |
Response parameters:
Parameter | Description |
|---|---|
| fullState | Full |
...
object state as stored in the database |
...
| id | Object state in terms of HTTP API |
| type | Object state in terms of HTTP API |
. Possible values of these parameters fullState parameter for a sensor are as follows:
| Sensor state |
|---|
<fullState>DISARMED</fullState>
<id>connected</id>
<type>NORMAL</type>
<fullState>ALARMED</fullState>
<id>alarmed</id>
<type>ALARM</type>
<fullState>CONFIRMED</fullState>
<id>confirmed</id>
<type>NORMAL</type>
<fullState>ON,DISARMED</fullState>
<id>connected</id>
<type>NORMAL</type>
<fullState>DISARMED</fullState>
<id>connected</id>
<type>NORMAL</type>
<fullState>DISARMED,DETACHED_DISARM</fullState>
<id>disconnected</id>
<type>ALARM</type>
<fullState>ARMED</fullState>
<id>armed</id>
<type>NORMAL</type>
<fullState>ALARMED</fullState>
<id>alarmed</id>
<type>ALARM</type>
<fullState>CONFIRMED</fullState>
<id>confirmed</id>
<type>NORMAL</type>
<fullState>ON,ARMED</fullState>
<id>armed</id>
<type>NORMAL</type>
<fullState>ARMED</fullState>
<id>armed</id>
<type>NORMAL</type>
| fullState in web request | dbo.state | |
|---|---|---|
| Armed + Closed | ON,ARMED | ON|ARMED |
| Armed + Closed+ Alarm | ON,ALARMED | ON|ALARMED |
| Armed + Closed+ Alarm confirmed | ON,CONFIRMED | ON|CONFIRMED |
| Armed + Closed+ Connection lost | ON,DETACHED_DISARM | ON|DETACHED_DISARM |
| Disarmed + Closed | ON,DISARMED | ON|DISARMED |
| Disarmed + Closed+ Alarm | ON,ALARMED | ON|ALARMED |
| Disarmed + Closed+ Alarm confirmed | ON,CONFIRMED | ON|CONFIRMED |
| Disarmed + Closed+ Connection lost | ON,DETACHED_DISARM | ON|DETACHED_DISARM |
| Armed + Opened | ARMED,OFF | ARMED|OFF |
| Armed + Opened+ Alarm | OFF,ALARMED | OFF|ALARMED |
| Armed + Opened+ Alarm confirmed | OFF,CONFIRMED | OFF|CONFIRMED |
| Armed + Opened+ Connection lost | DETACHED_DISARM,OFF | DETACHED_DISARM|OFF |
| Disarmed + Opened | DISARMED,OFF | DISARMED|OFF |
| Disarmed + Opened+ Alarm | OFF,ALARMED | OFF|ALARMED |
| Disarmed + Opened+ Alarm confirmed | OFF,CONFIRMED | OFF|CONFIRMED |
| Disarmed + Opened+ Connection lost | DETACHED_DISARM,OFF | DETACHED_DISARM|OFF |
<id>disconnected</id>
<type>ALARM</type>
Overview
Content Tools