GET HwStructure/getSensorState?HwStructNodePath={HwStructNodePath}&Token={Token}
Retrieve detail sensor and relay state data from the system. Application privilege "View" for licensed agenda "HW structure" required. Data may also be restricted by record permission "View" of agenda "HW structure"
Request Information
Authorization
- Authorization by token required
Availability
- Method disabled by configuration
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
HwStructNodePath |
Unique identification of the sensor in the system |
string |
Required |
Token |
The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Response Codes
Http Code | Error Number | Description |
---|---|---|
200 request succesfully done | 0 | Successfully done |
400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
401 unauthorized | 1000 | Token {0} not found |
401 unauthorized | 1001 | Token {0} already expired |
401 unauthorized | 1006 | Ip filter violated for ip client address [{0}] |
401 unauthorized | 1007 | Ip filter [{0}] parsing failed |
401 unauthorized | 1008 | Request rate policy violated for [{0}] |
403 server refuses fo fulfill the request | 1221 | Show hw structure privilege violated |
404 required resource does not exist on the server | 1220 | Hw structure unit not found |
415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported | |
500 internal error | Server exception description |
Resource Description
HwStructureGetStateRespName | Description | Type | Additional information |
---|---|---|---|
HwStructNodePath |
Unique identification of the unit node within hardware tree structure |
string |
None. |
Title |
The name of the hardware unit |
string |
None. |
Sensor |
The caption of the hardware unit |
string |
None. |
CommunicationOK |
State - Communication with hardware unit OK |
boolean |
None. |
CommunicationTime |
State - Last time of communication with hardware unit |
date |
None. |
ASCommunicationOK |
State - Communication with application server OK |
boolean |
None. |
ASCommunicationTime |
State - Last time of communication with application server |
date |
None. |
DMCommunicationOK |
State - Communication with device manager OK |
boolean |
None. |
DMCommunicationTime |
State - Last time of communication with device manager |
date |
None. |
PartialActualizationOK |
State - Hardware unit partial actualization OK |
boolean |
None. |
PartialActualizationTime |
State - Last time of hardware unit partial actualization |
date |
None. |
FullActualizationOK |
State - Hardware unit full actualization OK |
boolean |
None. |
FullActualizationTime |
State - Last time of hardware unit full actualization |
date |
None. |
UnauthorisedOpening |
State - Unauthorised opening |
boolean |
None. |
Timeout |
State - Timeout |
boolean |
None. |
TimeoutAlarm |
State - Timeout alarm |
boolean |
None. |
DoorOpened |
State - Door openned |
boolean |
None. |
ButtonPressed |
State - Button pressed |
boolean |
None. |
Tamper |
State - Tamper |
boolean |
None. |
RelayOn |
State - Relay on |
boolean |
None. |
RelayManualControl |
State - Relay manual control |
boolean |
None. |
InputActive |
State - Input active |
boolean |
None. |
IsSensor |
The sensor flag of the hw structure unit. |
integer |
None. |
RelayIndex |
The sensor flag of the hw structure unit. |
integer |
None. |
Response Formats
application/json
{"HwStructNodePath":"HW Structure - 0000151515ff S3","Title":"Sensor S3","Sensor":"S3","CommunicationOK":true,"CommunicationTime":"\/Date(1737612667384)\/","ASCommunicationOK":true,"ASCommunicationTime":"\/Date(1737612727384)\/","DMCommunicationOK":true,"DMCommunicationTime":"\/Date(1737612727384)\/","PartialActualizationOK":true,"PartialActualizationTime":"\/Date(1737611527384)\/","FullActualizationOK":true,"FullActualizationTime":"\/Date(1737609127384)\/","UnauthorisedOpening":null,"Timeout":null,"TimeoutAlarm":null,"DoorOpened":true,"ButtonPressed":null,"Tamper":null,"RelayOn":null,"RelayManualControl":null,"InputActive":null,"IsSensor":0,"RelayIndex":null}
application/xml
<Response> <HwStructNodePath>HW Structure - 0000151515ff S3</HwStructNodePath> <Title>Sensor S3</Title> <Sensor>S3</Sensor> <CommunicationOK>true</CommunicationOK> <CommunicationTime>2025-01-23T06:11:07.3846977Z</CommunicationTime> <ASCommunicationOK>true</ASCommunicationOK> <ASCommunicationTime>2025-01-23T06:12:07.3846977Z</ASCommunicationTime> <DMCommunicationOK>true</DMCommunicationOK> <DMCommunicationTime>2025-01-23T06:12:07.3846977Z</DMCommunicationTime> <PartialActualizationOK>true</PartialActualizationOK> <PartialActualizationTime>2025-01-23T05:52:07.3846977Z</PartialActualizationTime> <FullActualizationOK>true</FullActualizationOK> <FullActualizationTime>2025-01-23T05:12:07.3846977Z</FullActualizationTime> <DoorOpened>true</DoorOpened> <IsSensor>0</IsSensor> </Response>
text/json
{ "HwStructNodePath": "sample string 1", "CommunicationOK": true, "CommunicationTime": "2025-01-23T08:10:29.6522085+01:00", "ASCommunicationOK": true, "ASCommunicationTime": "2025-01-23T08:10:29.6522085+01:00", "DMCommunicationOK": true, "DMCommunicationTime": "2025-01-23T08:10:29.6522085+01:00", "PartialActualizationOK": true, "PartialActualizationTime": "2025-01-23T08:10:29.6522085+01:00", "FullActualizationOK": true, "FullActualizationTime": "2025-01-23T08:10:29.6602139+01:00", "UnauthorisedOpening": true, "Timeout": true, "TimeoutAlarm": true, "DoorOpened": true, "ButtonPressed": true, "Tamper": true, "RelayOn": true, "RelayManualControl": true, "InputActive": true, "IsSensor": 4, "RelayIndex": 1 }
text/xml
<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <HwStructNodePath>sample string 1</HwStructNodePath> <CommunicationOK>true</CommunicationOK> <CommunicationTime>2025-01-23T08:10:29.6522085+01:00</CommunicationTime> <ASCommunicationOK>true</ASCommunicationOK> <ASCommunicationTime>2025-01-23T08:10:29.6522085+01:00</ASCommunicationTime> <DMCommunicationOK>true</DMCommunicationOK> <DMCommunicationTime>2025-01-23T08:10:29.6522085+01:00</DMCommunicationTime> <PartialActualizationOK>true</PartialActualizationOK> <PartialActualizationTime>2025-01-23T08:10:29.6522085+01:00</PartialActualizationTime> <FullActualizationOK>true</FullActualizationOK> <FullActualizationTime>2025-01-23T08:10:29.6602139+01:00</FullActualizationTime> <UnauthorisedOpening>true</UnauthorisedOpening> <Timeout>true</Timeout> <TimeoutAlarm>true</TimeoutAlarm> <DoorOpened>true</DoorOpened> <ButtonPressed>true</ButtonPressed> <Tamper>true</Tamper> <RelayOn>true</RelayOn> <RelayManualControl>true</RelayManualControl> <InputActive>true</InputActive> <IsSensor>4</IsSensor> <RelayIndex>1</RelayIndex> </Response>