Tuya Developer PlatformSmart IndustriesSmart BuildingManage PermissionsManage Person Permissions

Manage Person Permissions

Last Updated on : 2023-01-12 07:16:08download

API list

Request method	API	Description
POST	/v1.0/iot-02/building/access-auth	Query a list of general access control permissions
GET	/v1.0/iot-02/building/access-auth/detail	Query the details of general access control permissions
POST	/v1.0/iot-02/building/access-auth-issue/actions/full	Send all the permissions
POST	/v1.0/iot-02/building/access-auth-issue/actions/increment	Send additional permissions
POST	/v1.0/iot-02/building/access-auth-task	Query the history of permissions that are sent or being sent
GET	/v1.0/iot-02/building/access-auth-task/{authTaskId}	Query the details of the specified task
POST	/v1.0/iot-02/building/access-auth-task/records	Query a list of task history
GET	/v1.0/iot-02/building/access-auth-task/actions/issue-info	Query the details of sending specific types of permissions

Query general access control permissions

API description

Query a list of general access control permissions.

API endpoint

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

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
name	String	body	The name.	No
sex	Integer	body	The gender.	No
mobile	String	body	The mobile phone number.	No
structureId	String	body	The ID of the specified organization.	No
personCode	String	body	The work number.	No
authDateType	Integer	body	The validity period of the permissions. Valid values: `0`: permanent `-1`: expired `7`: less than 7 days `15`: less than 15 days `30`: less than 30 days	No
accessControlChannelName	String	body	The name of the specified entrance and exit.	No
accessChannelRoomId	String	body	The ID of the specified installation area.	No
businessDeviceName	String	body	The name of the specified access control device.	No
authStartTime	long	body	The time when the permissions take effect.	No
authEndTime	long	body	The time when the permissions expire.	No
faceIssueStatus	Integer	body	Indicates whether the face data is sent successfully. Valid values: `1`: already sent. `0`: to be sent.	No
cardIssueStatus	Integer	body	Indicates whether a card number is sent successfully. Valid values: `1`: already sent. `0`: to be sent.	No
fingerprintIssueStatus	Integer	body	Indicates whether a fingerprint is sent successfully. Valid values: `1`: already sent. `0`: to be sent.	No
page	Integer	body	The total number of returned pages.	No
pageSize	Integer	body	The number of items returned on each page.	No
channelIds	String[]	body	The set of entrance and exit IDs. This field is used to query the permissions related to the entrances and exits.	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": [
    {
      "accessAuthId": "String // The authorization ID",
      "personId": "String // The ID of the specified person",
      "name": "string // The name",
      "sex": "String // The gender",
      "mobileCountry": "String // The country code",
      "mobile": "String // The mobile phone number",
      "personCode": "String // The work number",
      "structureIds": "String[] // The ID of the specified organization",
      "accessAuthTimeRangeId": "String // The ID of the specified accessible period. Currently, the value defaults to all the day",
      "accessAuthTimeRangeStr": "String // The value of the specified accessible period. Currently, the value defaults to always accessible",
      "businessDeviceName": "String // The device name",
      "accessControlChannelId": "String // The ID of the specified entrance and exit",
      "authStartTime": "long // The time when the permission takes effect",
      "authEndTime": "long // The time when the permission expires",
      "accessControlChannelName": "String // The name of the specified entrance and exit",
      "accessControlChannelNo": "String // The channel number of the specified entrance and exit",
      "accessChannelRoomId": "String // The ID of the specified installation area",
      "accessChannelPositionPath": "String // The name of the specified installation area",
      "totalCardNum": "int // The total number of cards",
      "authCardNum": "int // The number of cards that are allowed access to the entrances and exits",
      "totalFaceNum": "int // The total number of faces",
      "authFaceNum": "int // The number of faces that are allowed access to the entrances and exits",
      "totalFingerprintNum": "int // The total number of fingerprints",
      "authFingerprintNum": "int // The number of fingerprints that are allowed access to the entrances and exits",
      "faceIssueStatus": "int // The status of sending the face data. 0: to be sent, 1: already sent",
      "cardIssueStatus": "int // The status of sending the card data. 0: to be sent, 1: already sent",
      "fingerprintIssueStatus": "int // The status of sending the fingerprint data. 0: to be sent, 1: already sent",
    }
  ],
  "hasMore": "boolean"
}

Sample request

{
  "authEndTime": "The time when the permission expires",
  "sex": "The gender",
  "accessChannelRoomId": "The ID of the specified installation area",
  "businessDeviceName": "The name of the access control device",
  "mobile": "The mobile phone number",
  "structureId": "The organization ID",
  "pageSize": "The number of items returned on each page",
  "personCode": "The work number",
  "authDateType": "The validity period of the permissions. Valid values: 0: permanent. -1: expired. 7: less than 7 days. 15: less than 15 days. 30: less than 30 days.",
  "accessControlChannelName": "The name of the specified entrance and exit",
  "authStartTime": "The time when the permission takes effect",
  "faceIssueStatus": "The status of sending the face data. 0: to be sent, 1: already sent",
  "name": "The name",
  "fingerprintIssueStatus": "The status of sending the fingerprint data. 0: to be sent, 1: already sent",
  "page": "The total number of returned pages"
  "channelIds": "The set of entrance and exit IDs. This field is used to query the permissions related to the entrances and exits.",
  "projectId": "The project ID",
  "cardIssueStatus": "The status of sending the card data. 0: to be sent, 1: already sent",
}

Sample response

{
    "result": {
        "list": [
            {
                "access_auth_id": "1567699430642122***",
                "access_auth_time_range_id": "1",
                "access_auth_time_range_str": "All the day",
                "access_channel_position_path": "Center-11",
                "access_channel_room_id": "1424637349790294***",
                "access_control_channel_id": "1551450935983616***",
                "access_control_channel_name": "Virtual Dormitory 102",
                "access_control_channel_no": 1,
                "auth_card_num": 4,
                "auth_end_time": 2556115199000,
                "auth_face_num": 0,
                "auth_start_time": 1662566400000,
                "business_device_name": "Virtual device",
                "card_issue_status": 1,
                "face_issue_status": 0,
                "fingerprint_issue_status": 0,
                "mobile": "182****2940",
                "mobile_country": "+86",
                "name": "Test",
                "person_code": "090909",
                "person_id": "1532183396648747***",
                "sex": "1",
                "structure_ids": [
                    "1531473126917959***"
                ],
                "total_card_num": 3,
                "total_face_num": 1
            },
            {
                "access_auth_id": "1567428255730958***",
                "access_auth_time_range_id": "1",
                "access_auth_time_range_str": "All the day",
                "access_channel_position_path": "Center-11",
                "access_channel_room_id": "1424637349790294***",
                "access_control_channel_id": "1551450935983616***",
                "access_control_channel_name": "Virtual Dormitory 102",
                "access_control_channel_no": 1,
                "auth_card_num": 1,
                "auth_end_time": 2556115199000,
                "auth_face_num": 0,
                "auth_start_time": 1662048000000,
                "business_device_name": "Virtual device",
                "card_issue_status": 1,
                "face_issue_status": 0,
                "fingerprint_issue_status": 0,
                "mobile": "199****9879",
                "mobile_country": "+86",
                "name": "newpeople",
                "person_code": "456",
                "person_id": "1567428253323362***",
                "sex": "1",
                "structure_ids": [
                    "1466612511766855***"
                ],
                "total_card_num": 1,
                "total_face_num": 1
            },
            {
                "access_auth_id": "1564884950136676***",
                "access_auth_time_range_id": "1",
                "access_auth_time_range_str": "All the day",
                "access_channel_position_path": "Center-11",
                "access_channel_room_id": "1424637349790294***",
                "access_control_channel_id": "1551450935983616***",
                "access_control_channel_name": "Virtual Dormitory 102",
                "access_control_channel_no": 1,
                "auth_card_num": 1,
                "auth_end_time": 2556115199000,
                "auth_face_num": 0,
                "auth_start_time": 1662048000000,
                "business_device_name": "Virtual device",
                "card_issue_status": 1,
                "face_issue_status": 0,
                "fingerprint_issue_status": 0,
                "mobile": "188****9898",
                "mobile_country": "+86",
                "name":"John",
                "person_code": "1123",
                "person_id": "1564855972651077***",
                "sex": "1",
                "structure_ids": [
                    "1466612511766855***"
                ],
                "total_card_num": 1,
                "total_face_num": 1
            }
        ],
        "total": 7
    },
    "success": true,
    "t": 1664188226266,
    "tid": "3bce60c83d8611ed84fd2237f0528b74"
}

Query the details of general access control permissions

API description

Query the details of general access control permissions.

API endpoint

GET /v1.0/iot-02/building/access-auth/detail

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
accessAuthId	String	body	The ID of the authorization.	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

{
  "personId": "String // The ID of the specified person",
  "name": "string // The name",
  "imageUrl": "String // The image of the specified person",
  "sex": "int // The code of the gender",
  "sexStr": "String // The value of the gender",
  "mobileCountry": "String // The country code",
  "mobile": "String // The mobile phone number",
  "personCode": "String // The work number",
  "structureNames": "String[] // The organization name",
  "accessControlChannelName": "String // The name of the specified entrance and exit",
  "accessControlChannelNo": "String // The channel number of the specified entrance and exit",
  "accessChannelRoomId": "String // The ID of the specified installation area",
  "accessChannelPositionPath": "String // The installation area",
  "businessDeviceName": "String // The name of the access control device",
  "authStartTime": "long // The time when the permission takes effect",
  "authEndTime": "long // The time when the permission expires",
  "authCreateTime": "long // The time when the permission is generated",
  "authSource": "String // The source of the authorization",
  "authSourceStr": "String // The name of the authorization source",
  "totalCardNum": "int // The total number of cards",
  "authCardNum": "int // The number of cards that are allowed access to the entrances and exits",
  "totalFaceNum": "int // The total number of faces",
  "authFaceNum": "int // The number of faces that are allowed access to the entrances and exits",
  "totalFingerprintNum": "int // The total number of fingerprints",
  "authFingerprintNum": "int // The number of fingerprints that are allowed access to the entrances and exits",
  "faceIssueStatus": "int // The status of sending the face data. 0: to be sent, 1: already sent",
  "cardIssueStatus": "int // The status of sending the card data. 0: to be sent, 1: already sent",
  "fingerprintIssueStatus": "int // The status of sending the fingerprint data. 0: to be sent, 1: already sent",
}

Sample request

{
  "accessAuthId": "The authorization ID",
  "projectId": "The project ID",
}

Sample response

{
  "personId": "The ID of the specified person",
  "name": "The name",
  "imageUrl": "The image of the specified person",
  "sex": "The code of the gender",
  "sexStr": "The value of the gender",
  "mobileCountry": "The country code",
  "mobile": "The mobile phone number",
  "personCode": "The work number",
  "structureNames": "The organization name",
  "accessControlChannelName": "The name of the specified entrance and exit",
  "accessControlChannelNo": "The channel number of the specified entrance and exit",
  "accessChannelRoomId": "The ID of the specified installation area",
  "accessChannelPositionPath": "The installation area",
  "businessDeviceName": "The name of the access control device",
  "authStartTime": "The time when the permission takes effect",
  "authEndTime": "The time when the permission expires",
  "authCreateTime": "The time when the permission is generated",
  "authSource": "The source of the authorization",
  "authSourceStr": "The name of the authorization source",
  "totalCardNum": "The total number of cards",
  "authCardNum": "The number of cards that are allowed access to the entrances and exits",
  "totalFaceNum": "The total number of faces",
  "authFaceNum": "The number of faces that are allowed access to the entrances and exits",
  "totalFingerprintNum": "The total number of fingerprints",
  "authFingerprintNum": "The number of fingerprints that are allowed access to the entrances and exits",
  "faceIssueStatus": "The status of sending the face data. 0: to be sent, 1: already sent",
  "cardIssueStatus": "The status of sending the card data. 0: to be sent, 1: already sent",
  "fingerprintIssueStatus": "The status of sending the fingerprint data. 0: to be sent, 1: already sent"
}

Send all the permissions

API description

Send all the permissions.

API endpoint

POST /v1.0/iot-02/building/access-auth-issue/actions/full

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
authIssueCertificate	Integer	body	`1`: card `2`: card + face recognition `3`: card + password `4`: card + password + face recognition	Yes
channelIds	String[]	body	The set of entrance and exit 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

String{}

Sample request

{
  "channelIds": "The set of entrance and exit IDs",
  "projectId": "The project ID",
  "authIssueCertificate": "@link com.tuya.lingshu.service.accesscontrol.issue.enums.AuthIssueCertPolicyEnum"
}

Sample response

String{}

Send additional permissions

API description

Send additional permissions.

API endpoint

POST /v1.0/iot-02/building/access-auth-issue/actions/increment

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
authIssueCertificate	Integer	body	`1`: card `2`: card + face recognition `3`: card + password `4`: card + password + face recognition	Yes
channelIds	String[]	body	The set of entrance and exit 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

String{}

Sample request

{
  "channelIds": "The set of entrance and exit IDs",
  "projectId": "The project ID",
  "authIssueCertificate": "@link com.tuya.lingshu.service.accesscontrol.issue.enums.AuthIssueCertPolicyEnum"
}

Sample response

String{}

Query the history of sending permissions

API description

Query the history of permissions that are sent or being sent.

API endpoint

POST /v1.0/iot-02/building/access-auth-task

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
issueType	Integer	body	The query type. `1`: The permission is being sent. `2`: The permission is already sent.	No
taskStartStartTime	long	body	The start time used to search for the start time of the task.	No
taskStartEndTime	long	body	The end time used to search for the start time of the task.	No
accessControlChannelName	String	body	The name of the specified entrance and exit.	No
accessChannelPositionPath	String	body	The installation location.	No
businessDeviceName	String	body	The name of the specified access control device.	No
authNumType	Integer	body	The number of permissions. Valid values: `-1`: all the permissions. `0`: no permissions. `1`: having permissions.	No
authIssueType	Integer	body	The type of sending permissions. Valid values: `1`: Send all the permissions. `2`: Send additional permissions.	No
authIssueCertificate	Integer	body	The access control methods. Valid values: `1`: card. `2`: card + face recognition. `3`: card + fingerprint.	No
authTaskProgress	Integer	body	The task progress. Valid values: `0`: The task is initialized. `1`: The task is completed. `2`: The task is terminated. `3`: The task is being executed.	No
authTaskStatus	Integer	body	The result of sending the specified task. Valid values: `1`: All tasks succeeded. `2`: Some tasks succeeded. `3`: All tasks failed. `4`: All tasks were terminated.	No
taskFinishStartTime	long	body	The start time used to search for the end time of the task.	No
taskFinishEndTime	long	body	The end time used to search for the end time of the task.	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": [
    {
      "authTaskId": "String // The task ID",
      "taskStartTime": "long // The start time",
      "accessControlChannelName": "String // The name of the specified entrance and exit",
      "accessControlChannelNo": "String // The channel number of the specified entrance and exit",
      "accessChannelPositionPath": "String // The installation area",
      "businessDeviceName": "String // The name of the access control device",
      "authNum": "int // The number of permissions",
      "authIssueType": "int // The type of sending permissions. 1: Send all the permissions, 2: Send additional permissions",
      "successNum": "int // The number of permissions that are sent successfully",
      "authTaskProgress": "int // The task progress. Valid values: 0: The task is initialized. 1: The task is to be started. 2: The task is being executed. 3: The task is terminated. 4: The task is completed.",
      "authTaskStatus": "int // The result of sending tasks. Valid values: 0: to be started. 1: partially successful. 2: all successful. 3: all failed. 4: terminated.",
      "taskFinishTime": "long // The end time"
    }
  ],
  "hasMore": "boolean"
}

Sample request

{
  "taskStartStartTime": "The start time used to search for the start time of the task",
  "authTaskProgress": "The task progress. Valid values: 0: The task is initialized. 1: The task is completed. 2: The task is terminated. 3: The task is being executed.",
  "businessDeviceName": "The name of the access control device",
  "authIssueType": "The type of sending permissions. 1: Send all the permissions, 2: Send additional permissions",
  "pageSize": "The number of items returned on each page",
  "accessChannelPositionPath": "The installation area",
  "taskFinishEndTime": "The end time used to search for the end time of the task",
  "taskFinishStartTime": "The start time used to search for the end time of the task",
  "issueType": "The query type. Valid values: 1: being sent. 2: already sent",
  "accessControlChannelName": "The name of the specified entrance and exit",
  "authTaskStatus": "The result of sending tasks. Valid values: 1: all successful. 2: partially successful. 3: all failed. 4: terminated.",
  "authNumType": "The number of permissions. Valid values: -1: all the permissions. 0: no permissions. 1: having permissions.",
  "taskStartEndTime": "The end time used to search for the start time of the task",
  "page": "The total number of returned pages"
  "projectId": "The project ID",
  "authIssueCertificate": "The access control methods. Valid values: 1: card. 2: card + face recognition. 3: card + fingerprint."
}

Sample response

{
  "total": "int",
  "list": [
    {
      "list": "The end time"
    }
  ],
  "hasMore": "boolean"
}

Query the details of the specified task

API description

Query the details of the specified task.

API endpoint

GET /v1.0/iot-02/building/access-auth-task/{authTaskId}

Request parameter

Parameter name	Type	Parameter type	Description	Required
authTaskId	String	url	The task ID.	Yes
projectId	String	body	The project 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

{
  "taskStartTime": "long // The start time of a task",
  "taskFinishTime": "long // The end time of a task"
  "authIssueCertificate": "int // The access control methods. Valid values: 1: card. 2: card + face recognition. 3: card + fingerprint.",
  "authIssueCertificateStr": "String // The access control methods. Valid values: 1: card. 2: card + face recognition. 3: card + fingerprint."
  "accessControlChannelName": "String // The name of the specified entrance and exit",
  "accessControlChannelNo": "String // The channel number of the specified entrance and exit",
  "accessChannelPositionPath": "String // The installation area",
  "businessDeviceName": "String // The name of the access control device"
}

Sample request

{
  "authTaskId": "The task ID",
  "projectId": "The project ID",
}

Sample response

{
  "taskStartTime": "The start time of a task",
  "taskFinishTime": "The end time of a task",
  "authIssueCertificate": "The access control methods. Valid values: 1: card. 2: card + face recognition. 3: card + fingerprint."
  "authIssueCertificateStr": "The access control methods. Valid values: 1: card. 2: card + face recognition. 3: card + fingerprint."
  "accessControlChannelName": "The name of the specified entrance and exit",
  "accessControlChannelNo": "The channel number of the specified entrance and exit",
  "accessChannelPositionPath": "The installation area",
  "businessDeviceName": "The name of the access control device"
}

Query a list of task history

API description

Query a list of task history.

API endpoint

POST /v1.0/iot-02/building/access-auth-task/records

Request parameter

Parameter name	Type	Parameter type	Description	Required
projectId	String	body	The project ID.	Yes
authTaskId	String	body	The ID of the specified authorization task.	Yes
name	String	body	The name.	No
mobile	String	body	The mobile phone number.	No
structureName	String	body	The organization name.	No
issueStatus	Integer	body	The result of sending permissions. Valid values: `0`: initialized `1`: unknown `2`: terminated `3`: failed `4`: succeeded	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

{
  "totalNum": "int // The total number of task history",
  "successNum": "int // The number of successful authorization",
  "recordListVOList": {
    "total": "int",
    "list": [
      {
        "projectId": "String // The project ID",
        "authTaskRecordId": "String // The ID of the specified task history",
        "personId": "String // The ID of the specified person",
        "name": "string // The name",
        "mobileCountry": "String // The country code",
        "mobile": "String // The mobile phone number",
        "structureName": "String // The organization name",
        "accessAuthTimeRangeId": "String // The ID of the specified accessible period. Currently, the value defaults to all the day",
        "accessAuthTimeRangeStr": "String // The value of the specified accessible period. Currently, the value defaults to always accessible",
        "authIssueTime": "long // The time when the permission is sent",
        "issueStatus": "int // 0: initialized. 1: unknown. 2: terminated. 3: failed. 4: succeeded.",
      }
    ],
    "hasMore": "boolean"
  }
}

Sample request

{
  "issueStatus": "int // The sending result. Valid values: 0: initialized. 1: unknown. 2: terminated. 3: failed. 4: succeeded.",
  "authTaskId": "The ID of the specified authorization task",
  "structureName": "The organization name",
  "name": "The name",
  "mobile": "The mobile phone number",
  "pageSize": "The number of items returned on each page",
  "page": "The total number of returned pages"
  "projectId": "The project ID",
}

Sample response

{
  "totalNum": "The total number of task history",
  "successNum": "The number of successful authorization",
  "recordListVOList": {
    "recordListVOList": "boolean",
    "list": [
      {
        "list": "0: initialized. 1: unknown. 2: terminated. 3: failed. 4: succeeded.",
      }
    ]
  }
}

Query the details of sending specific types of permissions

API description

Query the details of sending specific types of permissions.

API endpoint

GET /v1.0/iot-02/building/access-auth-task/actions/issue-info

Request parameter

Parameter name	Type	Parameter type	Description	Required
authTaskRecordId	String	body	The task ID.	Yes
projectId	String	body	The project 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

{
  "projectId": "String // The project ID",
  "authTaskRecordId": "String // The ID of the specified task history",
  "personIssueResult": {
    "successIssueNum": "int // The number of permissions that are sent successfully",
    "failIssueNum": "int // The number of permissions that failed to be sent",
    "successIssueDelNum": "int // The number of permissions that are successfully deleted",
    "failIssueDelNum": "int // The number of permissions that failed to be deleted"
  },
  "cardIssueResult": {
    "successIssueNum": "int // The number of permissions that are sent successfully",
    "failIssueNum": "int // The number of permissions that failed to be sent",
    "successIssueDelNum": "int // The number of permissions that are successfully deleted",
    "failIssueDelNum": "int // The number of permissions that failed to be deleted"
  },
  "cardPwdIssueResult": {
    "successIssueNum": "int // The number of permissions that are sent successfully",
    "failIssueNum": "int // The number of permissions that failed to be sent",
    "successIssueDelNum": "int // The number of permissions that are successfully deleted",
    "failIssueDelNum": "int // The number of permissions that failed to be deleted"
  },
  "faceIssueResult": {
    "successIssueNum": "int // The number of permissions that are sent successfully",
    "failIssueNum": "int // The number of permissions that failed to be sent",
    "successIssueDelNum": "int // The number of permissions that are successfully deleted",
    "failIssueDelNum": "int // The number of permissions that failed to be deleted"
  },
  "fingerprintIssueResult": {
    "successIssueNum": "int // The number of permissions that are sent successfully",
    "failIssueNum": "int // The number of permissions that failed to be sent",
    "successIssueDelNum": "int // The number of permissions that are successfully deleted",
    "failIssueDelNum": "int // The number of permissions that failed to be deleted"
  }
}

Sample request

{
  "projectId": "The project ID",
  "authTaskRecordId": "The task ID"
}

Sample response

{
  "projectId": "The project ID",
  "authTaskRecordId": "The ID of the specified task history",
  "personIssueResult": {
    "personIssueResult": "The number of permissions that failed to be deleted"
  },
  "cardIssueResult": {
    "cardIssueResult": "The number of permissions that failed to be deleted"
  },
  "cardPwdIssueResult": {
    "cardPwdIssueResult": "The number of permissions that failed to be deleted"
  },
  "faceIssueResult": {
    "faceIssueResult": "The number of permissions that failed to be deleted"
  },
  "fingerprintIssueResult": {
    "fingerprintIssueResult": "The number of permissions that failed to be deleted"
  }
}

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 DocManage Cards Held by Persons

Next DocAuthorize Persons