5.17.2 api accesspoint blocking status
Service group is API Access Control.
Privileges group is Access Control.
GET
POST
The request contains parameters in the URL.
Parameter Name | Mandatory | Expected Values | Default Value | Description |
---|---|---|---|---|
id | No | Integer (0, 1) | All | Specifies for which access point the status should be returned. If this parameter is omitted, the access blocking status is returned for all the access points. |
Example of Request
URL: https://192.168.1.1/api/accesspoint/blocking/status?id=0
Response
The response is in the application/json format. The value of the result
key contains one key accessPoints
, which contains an array with an object for each access point (the array has a length of 1 if an access point was specified in the request). The objects in the array contain the following keys.
Key | Typical Returned Values | Description |
---|---|---|
id | Integer (0, 1) | Identifies the access point (0 for Entry, 1 for Exit). |
blocked | Boolean ( | Contains the current status of access point blocking ( |
Example of Response
{ "success": true, "result": { "accessPoints": [ { "id": 0, "blocked": true }, { "id": 1, "blocked": false } ] } }
There may occur various errors (e.g. insufficient privileges).