Tuya Developer PlatformSmart IndustriesSmart BuildingAccess ControlSet up Access Control Devices

Set up Access Control Devices

Last Updated on : 2023-01-12 07:14:25download

API list

Request method	API	Description
POST	/v1.0/iot-02/building/access-controls	Add an access control device
PUT	/v1.0/iot-02/building/access-controls	Edit an access control device
POST	/v1.0/iot-02/building/access-controls/actions/batch-delete	Delete an access control device
POST	/v1.0/iot-02/building/access-controls/actions/edit-readers	Edit a reader
POST	/v1.0/iot-02/building/access-controls/actions/clear-configs	Clear access control configurations
GET	/v1.0/iot-02/building/access-controls/actions/simple-infos	Get the basic information about an access control device
PUT	/v1.0/iot-02/building/access-controls/actions/edit-device	Edit an access controller
POST	/v1.0/iot-02/building/access-controls/actions/batch-move	Bulk move access control devices
GET	/v1.0/iot-02/building/access-controls/actions/config-infos	Get the configuration details of an access control device
GET	/v1.0/iot-02/building/access-controls	Get a list of access control devices
GET	/v1.0/iot-02/building/access-controls/{access_control_id}	Get the details of an access control device
GET	/v1.0/iot-02/building/access-control-devices	Get a list of access control devices that is not bound

Add an access control device

API description

Add an access control device.

API endpoint

POST /v1.0/iot-02/building/access-controls

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
accessControlName	String	body	The name of the specified access control device.	Yes
accessControlType	Integer	body	The type of the specified access control device.	Yes
accessControlTypeStr	String	body	The type name of the specified access control device.	Yes
accessControlModel	String	body	The model of the specified access control device.	No
accessControlFactory	String	body	The manufacturer of the specified access control device.	No
roomId	String	body	The installation location.	Yes
deviceId	String	body	The device ID of the specified access controller.	Yes
deviceName	String	body	The device name of the specified access controller.	No
deviceSourceType	String	body	The source type of a device. Valid values: `1`: non-standard protocol. `2`: standard protocol.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

String{}

Sample request

{
    "cid":"",
    "deviceId":"6c04c99318f080ffc8p***",
    "deviceMac":"0005",
    "deviceName": "Smart Lock (Lora) 3"
    "deviceSn":"","deviceSourceType":"2",
    "deviceStatus":1,
    "firstOnlineTime":1659431459133,
    "ipAddress":"",
    "lastOnlineTime":1660219064232,
    "projectId":"1424615984265764****",
    "accessControlName":"Test",
    "accessControlType":4,
    "accessControlModel":"12345",
    "accessControlFactory":"Manufacturer A",
    "accessControlTypeStr":"Access Control Terminal",
    "roomId":"1424637349790294***"
}

Sample response

String{}

Edit an access control device

API description

Edit an access control device.

API endpoint

PUT /v1.0/iot-02/building/access-controls

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
accessControlName	String	body	The name of the specified access control device.	Yes
accessControlType	Integer	body	The type of the specified access control device.	Yes
accessControlTypeStr	String	body	The type name of the specified access control device.	Yes
accessControlModel	String	body	The model of the specified access control device.	No
accessControlFactory	String	body	The manufacturer of the specified access control device.	No
roomId	String	body	The installation location.	Yes
deviceId	String	body	The device ID of the specified access controller.	Yes
deviceName	String	body	The device name of the specified access controller.	No
deviceSourceType	String	body	The source type of a device. Valid values: `1`: non-standard protocol. `2`: standard protocol.	No
accessControlId	String	body	The ID of a specified access control device.	Yes
needLog	boolean	body	The redundant field that specifies whether to keep a log.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

boolean{}

Sample request

{
    "accessControlId":"1567349953007718***",
    "cid":"",
    "deviceId":"6c04c99318f080ffc8p***",
    "deviceMac":"0005",
    "deviceName": "Smart Lock (Lora) 3"
    "deviceSn":"",
    "deviceSourceType":"2",
    "deviceStatus":1,
    "firstOnlineTime":1659431459133,
    "ipAddress":"",
    "lastOnlineTime":1662535418079,
    "projectId":"1424615984265764***",
    "accessControlName":"New Test",
    "accessControlType":4,
    "accessControlModel":"12345",
    "accessControlFactory":"Manufacturer B",
    "accessControlTypeStr":"Access Control Terminal",
    "roomId":"1424637349790294***"
}

Sample response

boolean{}

Delete an access control device

API description

Delete an access control device.

API endpoint

POST /v1.0/iot-02/building/access-controls/actions/batch-delete

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
accessControlIds	String[]	body	The list of access control device IDs.	Yes

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

boolean{}

Sample request

{
  "accessControlIds": "The list of access control device IDs",
  "projectId": "The project ID",
}

Sample response

boolean{}

Edit a reader

API description

Edit a reader.

API endpoint

POST /v1.0/iot-02/building/access-controls/actions/edit-readers

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	No
accessControlId	String	body	The ID of a specified access control device.	No
accessControlChannelId	String	body	The ID of the specified entrance and exit.	No
accessControlReaderId	String	body	The ID of the specified reader.	No
readerName	String	body	The name of the specified reader.	No
readerType	String	body	The type of the specified reader. Valid values: `self`: the reader. `button`: exit button.	No
readerDirection	Integer	body	The direction of the specified reader. Valid values: `0`: enter. `1`: exit.	No
readerModel	String	body	The model of the specified reader.	No
readerFactory	String	body	The manufacturer of the specified reader.	No
roomId	String	body	The ID of the specified area where the access control reader is installed.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

String{}

Sample request

{
    "readerType":"self",
    "accessControlChannelId":"1567458975220301***",
    "readerName":"Test Reader",
    "readerModel":"12345",
    "readerFactory":"Manufacturer B",
    "readerDirection":0,
    "accessControlId":"1567349953007718***",
    "roomId":"1424637349790294***",
    "readerNo":1,
    "projectId":"1424615984265764***"
}

Sample response

String{}

Clear access control configurations

API description

Clear access control configurations.

API endpoint

POST /v1.0/iot-02/building/access-controls/actions/clear-configs

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	No
clearConfigId	String	body	The ID that needs to be cleared. It can be an ID of the specified access control device, entrance and exit, or reader.	No
type	Integer	body	The ID type. Valid values: `1`: the ID of the specified access control device. `2`: the ID of the specified entrance and exit. `3`: the ID of the specified reader.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

boolean{}

Sample request

{
  "clearConfigId": "The ID that needs to be cleared. It can be an ID of the specified access control device, entrance and exit, or reader",
  "type": "The ID type. 1: the ID of the specified access control device. 2: the ID of the specified entrance and exit. 3: the ID of the specified reader.",
  "projectId": "The project ID",
}

Sample response

boolean{}

Get the basic information about an access control device

API description

Get the basic information about an access control device.

API endpoint

GET /v1.0/iot-02/building/access-controls/actions/simple-infos

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	No
accessControlId	String	body	The ID of a specified access control device.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

{
  "projectId": "String // The project ID",
  "accessControlId": "String // The ID of the specified access control device",
  "accessControlName": "String // The name of the specified access control device",
  "accessControlType": "int // The type of the specified access control device",
  "accessControlModel": "String // The model of the specified access control device",
  "accessControlFactory": "String // The manufacturer of the specified access control device",
  "roomId": "String // The ID of the specified area where the access control device is installed",
  "positionPath": "String // The location where the access control device is installed",
}

Sample request

{
  "projectId": "The project ID",
  "accessControlId": "The ID of the specified access control device"
}

Sample response

{
  "projectId": "The project ID",
  "accessControlId": "The ID of the specified access control device",
  "accessControlName": "The name of the specified access control device",
  "accessControlType": "The type of the specified access control device",
  "accessControlModel": "The model of the specified access control device",
  "accessControlFactory":"The manufacturer of the specified access control device",
  "roomId": "The ID of the specified area where the access control device is installed",
  "positionPath": "The location where the access control device is installed"
}

Edit an access controller

API description

Edit an access controller.

API endpoint

PUT /v1.0/iot-02/building/access-controls/actions/edit-device

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
deviceId	String	body	The device ID of the specified access controller.	No
deviceName	String	body	The name of the specified access controller.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

boolean{}

Sample request

{
    "deviceId":"6c645765f8efb40667w***",
    "deviceName":"Video Access Controller 3",
    "projectId":"1424615984265764***"
}

Sample response

boolean{}

Bulk move access control devices

API description

Bulk move access control devices.

API endpoint

POST /v1.0/iot-02/building/access-controls/actions/batch-move

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
accessControlIds	String[]	body	The list of access control device IDs.	Yes
roomId	String	body	The room ID.	Yes

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

boolean{}

Sample request

{
  "accessControlIds": "The list of access control device IDs",
  "projectId": "The project ID",
  "roomId": "The room ID"
}

Sample response

boolean{}

Get the configuration details of an access control device

API description

Get the configuration details of an access control device.

API endpoint

GET /v1.0/iot-02/building/access-controls/actions/config-infos

Request parameter

Parameter name	Type	Parameter type	Description	Required
accessControlId	String	body	The ID of a specified access control device.	No
projectId	String	body	The project ID.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

{
  "projectId": "String // The project ID",
  "accessControlId": "String // The ID of the specified access control device",
  "accessControlDeviceVO": {
    "projectId": "String // The project ID",
    "accessControlId": "String // The ID of the specified access control device",
    "deviceId": "String // The device ID",
    "deviceName": "String // The device name",
    "roomId": "String // The ID of the specified area where the access control device is installed",
    "positionPath": "String // The location where the access control device is installed",
    "deviceMac": "String // The MAC address of the specified device",
    "ipAddress": "String // The IP address of the specified device",
    "cid": "String // The CID of the specified device",
    "deviceSn": "String // The serial number of the specified device",
    "deviceStatus": "int // The device status",
    "firstOnlineTime": "long // The time when the specified device first goes online",
    "lastOnlineTime": "long // The time when the specified device goes online last time",
    "deviceSourceType": "String // The source type. 1: non-standard protocol (luwu_device_bind), 2: standard protocol (luwu_smart_device)",
    "accessControlType": "int // The access control type. 1: unit access control device, 2: gate access control device, 3: access control terminal, 4: pedestrian passage controller, 5: smart lock",
    "gateway": "String // The gateway dedicated for smart locks"
  },
  "accessControlChannelVOList": [
    {
      "projectId": "String // The project ID",
      "accessControlId": "String // The ID of the specified access control device",
      "accessControlChannelId": "String // The ID of the specified entrance and exit",
      "accessControlChannelName": "String //The name of the specified entrance and exit",
      "accessControlChannelNo": "String // The channel number",
      "roomId": "String // The ID of the specified area where the access control device is installed",
      "positionPath": "String // The location of an access control entrance and exit",
      "readerVOList": [
        {
          "projectId": "String // The project ID",
          "accessControlId": "String // The ID of the specified access control device",
          "accessControlChannelId": "String // The ID of the specified entrance and exit",
          "accessControlReaderId": "String // The ID of the specified reader",
          "readerName": "String // The name of the specified reader",
          "readerType": "String // The type of the specified reader. Valid values: self: the reader. button: exit button.",
          "readerDirection": "int // The direction of the specified reader. Valid values: 0: enter. 1: exit.",
          "readerModel": "String // The model of the specified reader",
          "readerFactory": "String // The manufacturer of the specified reader",
          "roomId": "String // The ID of the specified area where the access control device is installed",
          "positionPath": "String // The location of an access control entrance and exit",
        }
      ]
    }
  ]
}

Sample request

{
    "projectId":"1424615984265764***",
    "accessControlId":"1567349953007718***"
}

Sample response

{
    "result": {
        "access_control_channel_v_o_list": [
            {
                "access_control_channel_id": "1567458975220301***",
                "access_control_channel_name": "Channel 1",
                "access_control_channel_no": "1",
                "access_control_id": "1567349953007718***",
                "position_path": "Center-11",
                "project_id": "1424615984265764***",
                "reader_v_o_list": [
                    {
                        "access_control_channel_id": "1567458975220301***",
                        "access_control_reader_id": "1567460228306370***",
                        "position_path": "Center-11",
                        "project_id": "1424615984265764***",
                        "reader_direction": 0,
                        "reader_factory": "Manufacturer B",
                        "reader_model": "12345",
                        "reader_name": "Test Reader",
                        "reader_no": 1,
                        "reader_type": "self",
                        "room_id": "1424637349790294***"
                    },
                    {
                        "access_control_id": "1567349953007718***",
                        "project_id": "1424615984265764***",
                        "reader_no": 2
                    }
                ],
                "room_id": "1424637349790294***"
            }
        ],
        "access_control_device_v_o": {
            "access_control_id": "1567349953007718***",
            "access_control_type": 4,
            "cid": "",
            "device_id": "6c04c99318f080ffc8p***",
            "device_mac": "0005",
            "device_name": "Smart Lock (Lora) 3",
            "device_sn": "",
            "device_source_type": "2",
            "device_status": 1,
            "first_online_time": 1659431459133,
            "ip_address": "",
            "last_online_time": 1662535418079,
            "position_path": "Location 111",
            "project_id": "1424615984265764***",
            "room_id": "1428256638111883***"
        },
        "access_control_id": "1567349953007718***"
    },
    "success": true,
    "t": 1662712140222,
    "tid": "73fe101b301911edaf4dfa23c521f7ba"
}

Get a list of access control devices

API description

Get a list of access control devices.

API endpoint

GET /v1.0/iot-02/building/access-controls

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	No
accessControlName	String	body	The name of the specified access control device.	No
ipAddress	String	body	The IP address.	No
deviceMac	String	body	The MAC address of the specified device.	No
cid	String	body	The CID of the specified device.	No
deviceSn	String	body	The serial number of the specified device.	No
deviceStatus	String	body	Indicates the online status of the device. Valid values: `0`: The device is offline. `1`: The device is online.	No
accessControlType	String	body	The type of the specified access control device.	No
accessControlModel	String	body	The model of the specified access control device.	No
accessControlFactory	String	body	The manufacturer of the specified access control device.	No
deviceName	String	body	The name of the specified access controller or access control device.	No
accessControlChannelName	String	body	The name of the specified entrance and exit.	No
readerName	String	body	The name of the specified reader.	No
readerType	String	body	The type of the specified reader. Valid values: `self`: the reader. `button`: exit button. Get the value from the data dictionary.	No
readerModel	String	body	The model of the specified reader.	No
readerFactory	String	body	The manufacturer of the specified reader.	No
roomId	String	body	The area ID.	No
containSub	boolean	body	Specifies whether to include a subordinate area.	No
page	Integer	body	The total number of returned pages.	No
pageSize	Integer	body	The number of items returned on each page.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

{
  "total": "int",
  "list": [
    {
      "projectId": "String // The project ID",
      "accessControlId": "String // The ID of the specified access control device",
      "deviceId": "String // The device ID",
      "accessControlName": "String // The name of the specified access control device",
      "accessControlType": "int // The type of the specified access control device",
      "accessControlModel": "String // The model of the specified access control device",
      "accessControlFactory": "String // The manufacturer of the specified access control device",
      "roomId": "String // The ID of the specified area where the access control device is installed",
      "positionPath": "String // The location where the access control device is installed",
      "deviceStatus": "int // The device status",
      "deviceName": "String // The device name",
      "deviceMac": "String // The MAC address of the specified device",
      "ipAddress": "String // The IP address of the specified device",
      "cid": "String // The CID of the specified device",
      "deviceSn": "String // The serial number of the specified device"
    }
  ]
}

Sample request

{
    "page":1,
    "pageSize":10,
    "roomId":"1424637349790294***",
    "containSub":false,
    "projectId":"1424615984265764***"
}

Sample response

{
    "result": {
        "list": [
            {
                "access_control_factory": "111",
                "access_control_id": "1567497898814345***",
                "access_control_model": "Model A",
                "access_control_name": "Test 2",
                "access_control_type": 4,
                "cid": "",
                "device_id": "6c1df351604c61044en***",
                "device_mac": "",
                "device_sn": "",
                "device_status": 1,
                "ip_address": "118.25.183.11",
                "position_path": "Center-11",
                "project_id": "1424615984265764***",
                "room_id": "1424637349790294***"
            }
        ],
        "total": 30
    },
    "success": true,
    "t": 1662712328349,
    "tid": "e460b0ed301911edaf4dfa23c521f7ba"
}

Get the details of an access control device

API description

Get the details of an access control device.

API endpoint

GET /v1.0/iot-02/building/access-controls/{access_control_id}

Request parameter

Parameter name	Type	Parameter type	Description	Required
accessControlId	String	body	The ID of a specified access control device.	No
projectId	String	body	The project ID.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

{
  "projectId": "String // The project ID",
  "accessControlId": "String // The ID of the specified access control device",
  "accessControlName": "String // The name of the specified access control device",
  "accessControlType": "int // The type of the specified access control device",
  "accessControlModel": "String // The model of the specified access control device",
  "accessControlFactory": "String // The manufacturer of the specified access control device",
  "roomId": "String // The ID of the specified area where the access control device is installed",
  "positionPath": "String // The location where the access control device is installed",
  "accessControlDeviceVO": {
    "projectId": "String // The project ID",
    "accessControlId": "String // The ID of the specified access control device",
    "deviceId": "String // The device ID",
    "deviceName": "String // The device name",
    "roomId": "String // The ID of the specified area where the access control device is installed",
    "positionPath": "String // The location where the access control device is installed",
    "deviceMac": "String // The MAC address of the specified device",
    "ipAddress": "String // The IP address of the specified device",
    "cid": "String // The CID of the specified device",
    "deviceSn": "String // The serial number of the specified device",
    "deviceStatus": "int // The device status",
    "firstOnlineTime": "long // The time when the specified device first goes online",
    "lastOnlineTime": "long // The time when the specified device goes online last time",
    "deviceSourceType": "String // The source type. 1: non-standard protocol (luwu_device_bind), 2: standard protocol (luwu_smart_device)",
    "accessControlType": "int // The access control type. 1: unit access control device, 2: gate access control device, 3: access control terminal, 4: pedestrian passage controller, 5: smart lock",
    "gateway": "String // The gateway dedicated for smart locks"
  }
}

Sample request

{
  "accessControlId": "The ID of the specified access control device",
  "projectId": "The project ID",
}

Sample response

{
    "result": {
        "access_control_device_v_o": {
            "access_control_id": "1567349953007718***",
            "cid": "",
            "device_id": "6c04c99318f080ffc8p***",
            "device_mac": "0005",
            "device_name": "Smart Lock (Lora) 3",
            "device_sn": "",
            "device_source_type": "2",
            "device_status": 1,
            "first_online_time": 1659431459133,
            "ip_address": "",
            "last_online_time": 1662535418079,
            "project_id": "1424615984265764***"
        },
        "access_control_factory": "Manufacturer B",
        "access_control_id": "1567349953007718***",
        "access_control_model": "12345",
        "access_control_name": "Test 2",
        "access_control_type": 4,
        "position_path": "Location 111",
        "project_id": "1424615984265764***",
        "room_id": "1428256638111883***"
    },
    "success": true,
    "t": 1662712393558,
    "tid": "0b4412ec301a11edaf4dfa23c521f7ba"
}

Get a list of access control devices that is not bound

API description

Get a list of access control devices that is not bound.

API endpoint

GET /v1.0/iot-02/building/access-control-devices

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	No
deviceSourceType	String	body	The source type of the specified device. Each type is displayed on a tab.	No
deviceName	String	body	The device name.	No
deviceMac	String	body	The MAC address.	No
cid	String	body	The CID of the specified device.	No
deviceSn	String	body	The serial number of the specified device.	No
ipAddress	String	body	The IP address of the specified device.	No
page	Integer	body	The total number of returned pages.	No
pageSize	Integer	body	The number of items returned on each page.	No

Return parameter

Parameter name	Type	Description
code	Integer	The response code. For more information, see the error code section. It is empty if the request is successful.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: success. `false`: failure.
msg	String	The message that is returned if the request failed. The response is empty if the request succeeded.
t	Long	The returned 13-digit timestamp.
result	Object	The returned result.

Description of result

{
  "total": "int",
  "list": [
    {
      "projectId": "String // The project ID",
      "accessControlId": "String // The ID of the specified access control device",
      "deviceId": "String // The device ID",
      "deviceName": "String // The device name",
      "roomId": "String // The ID of the specified area where the access control device is installed",
      "positionPath": "String // The location where the access control device is installed",
      "deviceMac": "String // The MAC address of the specified device",
      "ipAddress": "String // The IP address of the specified device",
      "cid": "String // The CID of the specified device",
      "deviceSn": "String // The serial number of the specified device",
      "deviceStatus": "int // The device status",
      "firstOnlineTime": "long // The time when the specified device first goes online",
      "lastOnlineTime": "long // The time when the specified device goes online last time",
      "deviceSourceType": "String // The source type. 1: non-standard protocol (luwu_device_bind), 2: standard protocol (luwu_smart_device)",
      "accessControlType": "int // The access control type. 1: unit access control device, 2: gate access control device, 3: access control terminal, 4: pedestrian passage controller, 5: smart lock",
      "gateway": "String // The gateway dedicated for smart locks"
    }
  ]
}

Sample request

{
  "ipAddress": "The IP address of the specified device",
  "deviceMac": "The MAC address of the device",
  "pageSize": "The number of items returned on each page",
  "page": "The total number of returned pages"
  "projectId": "The project ID",
  "deviceName": "The device name",
  "deviceSn": "The serial number of the specified device",
  "deviceSourceType":"The source type of the specified device. Each type is displayed on a tab.",
  "cid": "The CID of the specified device"
}

Sample response

{
  "total": "int",
  "list": [
    {
      "list": "The gateway dedicated for smart locks"
    }
  ]
}

Error codes

The following table lists common error codes for the API calls. For more error codes, see Global Error Codes.

Error codes	Description
500	A system error has occurred while processing your request.

Prev DocAccess Control

Next DocEntrance and Exit