5.17.1 api accesspoint blocking ctrl

The api/accesspoint/blocking/ctrl function controls blocking of access on individual access points.

Service and Privileges Groups

Service group is API Access Control.
Privileges group is Access Control.

Methods

GET
POST

Request

The request contains parameters in the URL.

Table 1. Request URL Parameters

Parameter Name	Mandatory	Expected Values	Default Value	Description
id	Yes	Integer (0, 1)	-	Specifies the identifier of the access point that is to be controlled (0 for Entry and 1 for Exit).
action	Yes	String (on, off)	-	Specifies whether the blocking for the corresponding access point should be switched on or switched off.

Example of Request

URL:
https://192.168.1.1/api/accesspoint/blocking/ctrl?id=0&action=on

Response

The response is in the application/json format.

Table 2. Response JSON Keys.

Key	Typical Returned Values	Description
success	`true`, `false`	The value is `true` when the request is processed successfully (i.e. the access blocking is in the desired state regardless of a change).

Example of a Response

{
    "success": true
}

There may occur various errors (e.g. missing mandatory parameter). When Error code 18 (access point disabled) is returned, the request was not processed because the specified access point was disabled at the time.