Query Access Control Log

Last Updated on : 2023-06-21 07:12:54download

Query the access control log on pages based on multiple criteria.

API address

GET: /v1.0/iot-02/access-control-logs

Request parameter

Parameter name	Type	IN	Required	Description
request	HighWayAccessControlAccessLogQueryRequest	query	true	The query criteria.

Description of request

Parameter name	Type	Required	Description
uids	String	false	The collection of user IDs. Multiple requests are separated with commas (,).
device_ids	String	false	The collection of access control devices. Multiple requests are separated with commas (,).
start_time	Long	false	The start time of query.
end_time	Long	false	The end time of query.
page_size	Integer	false	The number of items returned on each page. Default value: `20`. Maximum value: `200`.
page_no	Integer	false	The current page number. Default value: `1`.
export_face_img	Boolean	false	Indicates whether a face snapshot is displayed. Default value: `true`. `true`: yes. `false`: no.
access_types	String	false	The passing type. Multiple requests are separated with commas (,). The enumeration types. Valid values: `card`: card. `password`: password. `qr_code`: QR code. `face`: face recognition. `fingerprint`: fingerprint. `remote`: remote control. `other`: others.

Return parameter

Parameter name	Type	Description
result	HighwayPageResult	The returned result.

Description of result

Parameter name	Type	Description
total	Long	The total number of results.
list	List	The number of items returned on each page.
has_more	Boolean	Specifies whether to return the next page.

Description of list

Parameter name	Type	Description
device_id	String	The device ID.
name	String	The name of a specified user that passes the access control device.
user_id	String	The ID of a specified user that passes the access control device.
access_time	Long	The time when a user passes the access control device.
access_type	String	The type of access control.
image_capture	String	The face snapshot.
access_log_id	String	The ID of a specified access control log.

Request example

GET: /v1.0/entrance-guard/access-controls/logs?access_types=remote&page_no=1&page_size=1

Return example

{
  "result": {
    "has_more": true,
    "list": [
      {
        "access_log_id": "146305039484531****",
        "access_time": 1637653370946,
        "access_type": "Remote",
        "device_id": "vdevo16370312926****",
        "device_name": "Smart Access Control-vdevo"
        "image_capture": "",
        "name": "sun",
        "user_id": "bay1633662217508****"
      }
    ],
    "total": 6
  },
  "success": true,
  "t": 1637653511622
}

Error code

For more information, see error code.