查询采集数据

POST

https://api2.hik-cloud.com/api/v1/open/collectors/local/actions/search

接口描述
查询已采集的人员数据

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api2.hik-cloud.com/api/v1/open/collectors/local/actions/search' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{

             
        "deviceSerial": "X34289430",

             
        "searchId": "uu67hhjjk",

             
        "searchResultPosition": 0,

             
        "maxResults": 1,

             
        "searchType": "new",

             
        "employeeNos": ["1234567"]

             
    }'

响应示例

{
  "code": 200,
  "message": "操作成功",
  "data": {
    "searchId": "uu67hhjjk",
    "numOfMatches": 1,
    "totalMatches": 1,
    "records": [
      {
        "lastCaptureNo": 1,
        "captureNo": 1,
        "name": "王大锤",
        "employeeNo": "1234567",
        "idcardNo": "000000000000000000",
        "riskDataMark": true,
        "dataType": "new",
        "faceUrl": "http://xxxxxxxxx.jpg",
        "cards": [
          {
            "cardNo": "101112",
            "cardType": "TypeA_M1"
          }
        ],
        "fingerprints": [
          {
            "fingerprintNo": 1,
            "fingerprintData": "QwEHEgELUQAAAAAAAAAAAAAAAB4BmniwAP///////0U1x"
          }
        ],
        "identityInfo": {
          "chnName": "王大锤",
          "enName": "wangdachui",
          "gender": "male",
          "birth": "20121224",
          "addr": "杭州市滨江区xxx街道0号",
          "idcardNo": "000000000000000000",
          "issuingAuthority": "杭州市滨江区公安局",
          "startDate": "20201224",
          "endDate": "20301224",
          "nation": 1,
          "passNo": "",
          "issueNumber": "",
          "certificateType": "",
          "permanentResidenceCardNo": "",
          "nationalityOrAreaCode": "",
          "version": "",
          "receivingAuthorityCode": "",
          "faceData": "/9j/2wCEAAIBAQEBAQIBAQECAgICAgQ...",
          "fingerprints": [
            "QwEHEgELUQAAAAAAAAAAAAAAAB4BmniwAP///////0U1xf",
            "QwEHEgELUQAAAAAAAAAAAAAAAB4BmniwAP///////601C/z"
          ]
        }
      }
    ]
  }
}

请求参数

Header 参数

Authorization

string

可选

默认值:

Bearer {{access_token}}

Body 参数application/json

deviceSerial

string

设备序列号

必需

searchId

string

查询唯一标识

必需

searchResultPosition

integer

查询结果在结果列表中的起始位置。当记录很多时，一次查询不能获取所有记录，下一次查询时指定位置可以查询后面的记录。

必需

maxResults

integer

本次查询需要获取的最大记录数。备注：当该参数值无效时，接口会返回异常信息包含实际支持的参数值。

必需

searchType

string

查询类型，取值：[new-返回新增数据，modified-返回修改数据]，为空表示查询全部数据。

可选

employeeNos

array[string]

人脸编号列表。备注：当该参数值无效时，接口会返回异常信息包含实际支持的参数值。

可选

示例

返回响应

🟢200成功

application/json

Body

code

integer

返回码

必需

message

string

返回信息

必需

data

object

返回数据对象

可选

searchId

string

搜索唯一标识

必需

numOfMatches

integer

本次返回的记录数

必需

totalMatches

integer

符合条件的总记录数

必需

records

array [object {11}]

记录列表

必需

修改于 2022-05-25 07:18:47

录入人员信息

获取采集状态信息