5.17.3 api accesspoint grantaccess

The api/accesspoint/grantaccess function helps grant remote access permission to a user (employee/user or user assigned to a general group. e.g. visitor). The remote access permission can also be granted via a specific account that clearly identifies the access granting user.

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 format.

Table 1. URL Request Parameters

Parameter Name	Mandatory	Expected Values	Default Value	Description
id	Yes	Integer (0, 1)	–	Identifies the access point to be checked (0 for Arrival and 1 for Departure).
user	Yes	uuid	–	Identifies the user that initiates door opening (and whose access settings are to be considered).

Response

The response is in the application/json format.

Table 2. JSON Response Keys

Key	Typical Returned Values	Description
success	`true`, `false`	The value is `true` if the request has been processed successfully (i.e. access blocking is in the requested state regardless of the change).
reason	`invalidAp, invalidCredential, accessBlocked`	The key is displayed in case the response is accessGranted:false. If the access is successful the key is not displayed.

Example of Response

{
  "success" : true,
  "result" : {
    "accessGranted" : false,
    "reason" : "invalidAp"
  }
}

There may occur various errors (e.g. missing mandatory parameter). Error code 18 (access point disallowed) means that the request has not been processed because the access point was not allowed at the time of processing.