Documentation for Axxon PSIM 1.0.0-1.0.1.

Previous page Information on a specific object  The list of available actions with the object in a specific state Next page


General request format:

GET http://IP-address:port/web2/secure/configuration/{objectClass}:{id}/state/

Request parameters:

Parameter

Is required

Description

objectClassYesObject class ID
idYesObject ID

Request example:

GET http://127.0.0.1:8085/web2/secure/configuration/GRAY:2/state/

Response example:

<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

idObject state in terms of HTTP API
typeObject state in terms of HTTP API

Possible values of fullState parameter for a sensor are as follows:

Sensor statefullState in web requestdbo.state
Armed + ClosedON,ARMEDON|ARMED
Armed + Closed+ AlarmON,ALARMEDON|ALARMED
Armed + Closed+ Alarm confirmedON,CONFIRMEDON|CONFIRMED
Armed + Closed+ Connection lostON,DETACHED_DISARMON|DETACHED_DISARM
Disarmed + ClosedON,DISARMEDON|DISARMED
Disarmed + Closed+ AlarmON,ALARMEDON|ALARMED
Disarmed + Closed+ Alarm confirmedON,CONFIRMEDON|CONFIRMED
Disarmed + Closed+ Connection lostON,DETACHED_DISARMON|DETACHED_DISARM
Armed + OpenedARMED,OFFARMED|OFF
Armed + Opened+ AlarmOFF,ALARMEDOFF|ALARMED
Armed + Opened+ Alarm confirmedOFF,CONFIRMEDOFF|CONFIRMED
Armed + Opened+ Connection lostDETACHED_DISARM,OFFDETACHED_DISARM|OFF
Disarmed + OpenedDISARMED,OFFDISARMED|OFF
Disarmed + Opened+ AlarmOFF,ALARMEDOFF|ALARMED
Disarmed + Opened+ Alarm confirmedOFF,CONFIRMEDOFF|CONFIRMED
Disarmed + Opened+ Connection lostDETACHED_DISARM,OFFDETACHED_DISARM|OFF
  • No labels