人员管理

人员获取（查询）

请求

{
  "UserInfoSearchCond": {
    "searchID": "", //必填，string，搜索记录唯一标识，用来确认上层客户端是否为同一个（倘若是同一个,设备记录内存,下次搜索加快速度）
    "searchResultPosition": 0, //必填，integer，查询结果在结果列表中的起始位置。当记录条数很多时，一次查询不能获取所有的记录，下一次查询时指定位置可以查询后面的记录（若设备支持的最大totalMatches为M个，但是当前设备已存储的totalMatches为N个（N<=M），则该字段的合法范围为0~N-1）
    "maxResults": 10, // 必填，integer，本次协议调用可获取的最大记录数（如maxResults值大于设备能力集返回的范围，则设备按照能力集最大值返回，设备不进行报错）
    "EmployeeNoList" : [{ //可选，人员ID列表
      "employeeNo": "" // 可选，string，人员ID
    }]
  }
}

响应

{
  "UserInfoSearch" : {
    "searchID": "", //必填，string，搜索记录唯一标识，用来确认上层客户端是否为同一个（倘若是同一个，设备记录内存，下次搜索加快速度）
    "responseStatusStrg": "OK", //必填，string，查询状态字符串描述：OK-查询结束，MORE-还有数据等待查询，NO MATCH-没有匹配数据
    "numOfMatches": 1, //必填，integer，本次返回的记录条数
    "totalMatches": 1, //必填，integer，符合条件的记录总条数
    "UserInfo" : [{ //可选，人员信息
        "employeeNo": "", //必填，string，人员ID
        "name": "", //可选，string，姓名
        "userType ": "normal", //必填，string，人员类型，normal-普通人，visitor-来宾，blackList-黑名单人
        "Valid" : { //必填，有效期参数（enable不使能代表长期有效）
          "enable": true, //必填，boolean，使能有效期，false-不使能，true-使能
          "beginTime": "", //必填，有效期起始时间（timeType字段不存在或为local时，beginTime为设备本地时间，如：2017-08-01T17:30:08；timeType字段为UTC时，beginTime为UTC时间，如：2017-08-01T17:30:08+08:00）
          "endTime": "", //必填，有效期结束时间（timeType字段不存在或为local时，endTime为设备本地时间，如：2017-08-01T17:30:08；timeType字段为UTC时，endTime为UTC时间，如：2017-08-01T17:30:08+08:00）
          "timeType": "" //可选，string，时间类型：local-设备本地时间，UTC-UTC 时间
        },
        "password": "123456", //可选，string，密码
        "doorRight": "1,3", //可选，string，门权限（代表对门1、门3有权限）
        "RightPlan" : [{ //可选，门权限计划
            "doorNo": 1, //可选，integer，门编号
            "planTemplateNo": "1,3,5" //可选，string，计划模板编号，同个门不同计划模板采用权限或的方式处理
          }
        ],"userVerifyMode": "card", //可选，string，人员验证方式（人员验证方式的优先级高于读卡器验证方式）：cardAndPw-刷卡+密码，card-刷卡，cardOrPw-刷卡或密码，fp-指纹，fpAndPw-指纹+密码，fpOrCard-指纹或刷卡，fpAndCard-指纹+刷卡，fpAndCardAndPw-指纹+刷卡+密码，faceOrFpOrCardOrPw-人脸或指纹或刷卡或密码，faceAndFp-人脸+指纹，faceAndPw-人脸+密码，faceAndCard-人脸+刷卡，face-人脸，employeeNoAndPw-工号+密码，fpOrPw-指纹或密码，employeeNoAndFp-工号+指纹，employeeNoAndFpAndPw-工号+指纹+密码，faceAndFpAndCard-人脸+指纹+刷卡，faceAndPwAndFp-人脸+密码+指纹，employeeNoAndFace-工号+人脸，faceOrfaceAndCard-人脸或人脸+刷卡，fpOrface-指纹或人脸，cardOrfaceOrPw-刷卡或人脸或密码
      }
    ]
  }
}

人员设置（新增/修改）

请求

{
  "UserInfo" : {
    "employeeNo": "", //必填，string，人员 ID
    "deleteUser": true, //可选，boolean，是否删除该人员，true-是（只有删除该人员时，才填写该字段；新增或修改人员时，不填写该字段）
    "name": "", //可选，string，姓名
    "userType ": "normal", //必填，string，人员类型，normal-普通人，visitor-来宾，blackList-黑名单人
    "Valid" : { //必填，有效期参数（enable 不使能代表长期有效）（有效时间跨度为1970 年 1 月 1 日 0 点 0 分 0 秒~2037 年 12 月 31 日 23 点 59 分 59 秒）
      "enable": true, //必填，boolean，使能有效期，false-不使能，true-使能
      "beginTime": "", //必填，有效期起始时间（timeType 字段不存在或为 local时，beginTime 为设备本地时间，如：2017-08-01T17:30:08；timeType 字段为 UTC 时，beginTime为 UTC 时间，如：2017-08-01T17:30:08+08:00）
      "endTime": "", //必填，有效期结束时间（timeType 字段不存在或为 local 时，endTime 为设备本地时间，如：2017-08-01T17:30:08；timeType 字段为 UTC 时，endTime 为UTC 时间，如：2017-08-01T17:30:08+08:00）
      "timeType": "" //可选，string，时间类型：local-设备本地时间，UTC-UTC时间
    },
    "password": "123456", //可选，string，密码
    "doorRight": "1,3", //可选，string，门权限（代表对门 1、门 3 有权限）（
    "RightPlan" : [{ //可选，门权限计划
        "doorNo": 1, //可选，integer，门编号
        "planTemplateNo": "1,3,5" //可选，string，计划模板编号，同个门不同计划模板采用权限或的方式处理
      }
    ],
    "userVerifyMode": "card",//可选，string，人员验证方式（人员验证方式的优先级高于读卡器验证方式）：cardAndPw-刷卡+密码，card-刷卡，cardOrPw-刷卡或密码，fp-指纹，fpAndPw-指纹+密码，fpOrCard-指纹或刷卡，fpAndCard-指纹+刷卡，fpAndCardAndPw-指纹+刷卡+密码，faceOrFpOrCardOrPw-人脸或指纹或刷卡或密码，faceAndFp-人脸+指纹，faceAndPw-人脸+密码，faceAndCard-人脸+刷卡，face-人脸，employeeNoAndPw-工号+密码，fpOrPw-指纹或密码，employeeNoAndFp-工号+指纹，employeeNoAndFpAndPw-工号+指纹+密码，faceAndFpAndCard-人脸+指纹+刷卡，faceAndPwAndFp-人脸+密码+指纹，employeeNoAndFace-工号+人脸，faceOrfaceAndCard-人脸或人脸+刷卡，fpOrface-指纹或人脸，cardOrfaceOrPw-刷卡或人脸或密码
  }
}

人员删除

请求

{
  "UserInfoDetail" : {
    "mode": "", //必填，string，删除模式（all-删除所有，byEmployeeNo-按人员 ID删除）
    "EmployeeNoList" : [{ //可选，人员 ID 列表
        "employeeNo": "" //可选，string，人员 ID（当 mode 为 byEmployeeNo时，该字段有效）
      }
    ]
  }
}

响应

{
  "UserInfoDetailDeleteProcess" : {
    "status": "" //必填，string，状态（processing-处理中，success-成功，failed-失败）
  }
}

查询所有人员数量

响应

{
  "UserInfoCount" : {
    "userNumber": 100
  }
}

卡管理

卡查询

请求

{
  "CardInfoSearchCond": {
    "searchID": "", //必填，string，搜索记录唯一标识，用来确认上层客户端是否为同一个（倘若是同一个，设备记录内存，下次搜索加快速度）
    "searchResultPosition": 0, //必填，integer，查询结果在结果列表中的起始位置。当记录条数很多时，一次查询不能获取所有的记录，下一次查询时指定位置可以查询后面的记录（若设备支持的最大 totalMatches 为 M 个，但是当前设备已存储的 totalMatches 为 N 个（N<=M），则该字段的合法范围为 0~N-1）
    "maxResults": 30, // 必填，integer，本次协议调用可获取的最大记录数（如maxResults 值大于设备能力集返回的范围，则设备按照能力集最大值返回，设备不进行报错）
    "EmployeeNoList" : [{ //可选，人员 ID 列表
      "employeeNo": "" //可选，string，人员 ID
        }
      ],
    "CardNoList" : [{ //可选，卡号列表（与人员 ID 列表互斥，两者选一）
        "cardNo": "1234567890" //可选，string，卡号
      }
    ]
  }
}

响应

{
  "CardInfoSearch" : {
    "searchID": "", //必填,搜索记录唯一标识，string，用来确认上层客户端是否为同一个（倘若是同一个，设备记录内存，下次搜索加快速度）
    "responseStatusStrg": "OK", //必填，string，查询状态字符串描述：OK-查询结束，MORE-还有数据等待查询，NO MATCH-没有匹配数据
    "numOfMatches": 1, //必填，integer，本次返回的记录条数
    "totalMatches": 1, //必填，integer，符合条件的记录总条数
    "CardInfo" : [{ //可选，人员信息
        "employeeNo": "", //必填，string，人员 ID
        "cardNo": "", //必填，string，卡号
        "cardType ": "normalCard", //必填，string，卡类型，normalCard-普通卡，patrolCard-巡更卡，hijackCard-胁迫卡，superCard-超级卡，dismissingCard-解除卡
      }
    ]
  }
}

卡设置（新增/修改）

请求

{
  "CardInfo" : {
    "employeeNo": "", //必填，string，人员 ID
    "cardNo": "1234567890", //必填，string，卡号
    "deleteCard": true, //可选，boolean，是否删除该卡，true-是（只有删除该卡时，才填写该字段；新增或修改卡时，不填写该字段）
    "cardType ": "normalCard", //必填，string，卡类型，normalCard-普通卡，patrolCard-巡更卡，hijackCard-胁迫卡，superCard-超级卡，dismissingCard-解除卡，emergencyCard-应急管理卡（用于授权临时卡权限，本身不能开门）
  }
}

卡删除

请求

{
  "CardInfoDelCond" : {
    "EmployeeNoList" : [{ //可选，人员 ID 列表
        "employeeNo": "" //可选，string，人员 ID
      }
    ],
    "CardNoList" : [{ //可选，卡号列表（与人员 ID 列表互斥，两者选一）
        "cardNo": "1234567890" //可选，string，卡号
      }
    ]
  }
}

查询所有卡数量

响应

{
  "CardInfoCount" : {
    "cardNumber": 100
  }
}

查询指定工号所有卡数量

响应

{
  "CardInfoCount" : {
    "cardNumber": 100
  }
}

指纹管理

指纹获取（查询）

请求

{
  "FingerPrintCond": {
    "searchID": "", //必填，string，搜索记录唯一标识，用来确认上层客户端是否为同一个（倘若是同一个，设备记录内存，下次搜索加快速度）
    "employeeNo": "", //必填，string，指纹关联的人员 ID
    "cardReaderNo": 123, //可选，integer，读卡器编号
    "fingerPrintID": 123, //可选，integer，手指编号：1-10
  }
}

响应

{
  "FingerPrintInfo": {
    "searchID": "", //必填，string，搜索记录唯一标识,用来确认上层客户端是否为同一个（倘若是同一个，设备记录内存，下次搜索加快速度）
    "status": "", //必填，string，状态（OK-存在指纹，NoFP-不存在指纹）
    "FingerPrintList": [
      {
        "cardReaderNo": 123, //必填，integer，读卡器编号
        "fingerPrintID": 123, //必填，integer，手指编号：1-10
        "fingerType": "", // 必填，string，指纹类型：normalFP- 普通指纹，hijackFP-胁迫指纹，patrolFP-巡更指纹，superFP-超级指纹，dismissingFP-解除指纹
        "fingerData": "", //必填，string，指纹数据（需要 Base64 编码）
        "leaderFP": [1,3,5] //可选，array，是否有首次认证功能（[1,3,5]代表指纹对于门 1、门 3、门 5 有首次认证功能）
      }
    ]
  }
}

指纹设置（新增/修改）

请求

{
  "FingerPrintCfg": {
    "employeeNo": "", //必填，string，指纹关联的人员 ID
    "enableCardReader": [1,3,5], //必填，array，需要下发指纹的读卡器（[1,3,5]代表需要下发给读卡器 1、读卡器 3、读卡器 5）
    "fingerPrintID": 123, //必填，integer，手指编号：1-10
    "deleteFingerPrint": true, //可选，boolean，是否删除该指纹，true-是（只有删除该指纹时，才填写该字段；新增或修改指纹时，不填写该字段）
    "fingerType": "", //必填，string，指纹类型：normalFP-普通指纹，hijackFP-胁迫指纹，patrolFP-巡更指纹，superFP-超级指纹，dismissingFP-解除指纹
    "fingerData": "", //可选，string，指纹数据（需要 Base64 编码）
  }
}

响应

{
  "FingerPrintStatus": {
    "status": "", //可选，string，状态：success-成功，failed-失败（对于实际下发指纹数据到读卡器时，不会返回该字段。如果仅是修改指纹参数（不涉及到指纹数据下发到读卡器）或删除指纹，才会返回该字段）
    "StatusList" : [ //可选，状态列表（对于实际下发指纹数据到读卡器时，才会返回该列表。如果仅是修改指纹参数（不涉及到指纹数据下发到读卡器）或删除指纹，则不会返回该列表）
      {
        "id": 123, //可选，integer，读卡器编号
        "cardReaderRecvStatus": 123, //可选，integer，指纹读卡器状态：0-失败，1-成功，2-该指纹模组不在线，3-重试或指纹质量差，4-内存已满，5-已存在该指纹，6-已存在该指纹 ID，7-非法指纹 ID，8-该指纹模组无需配置，10-指纹读卡器版本过低（无法支持工号）
        "errorMsg": "", //可选，string，下发错误信息：当 cardReaderRecvStatus为 5 时，表示已存在指纹对应的人员 ID
      }
    ]
  }
}

指纹删除

指纹采集

人脸管理

人脸查询

请求

{
  "searchResultPosition": 0,//必填，integer，查询结果在结果列表中的起始位置。当记录条数很多时，一次查询不能获取所有的记录，下一次查询时指定位置可以查询后面的记录
  "maxResults": 123, //必填，integer，本次协议调用可获取的最大记录数
  "faceLibType": "blackFD", //必填，string，人脸库类型：blackFD-名单库。最大长度为 32
  "FDID": "", //必填，string，人脸库 ID。最大长度为 63 字节，多个人脸库用逗号隔开（门禁设备默认为 1）
  "FPID": "", //可选，string，人脸记录 ID（与门禁人员 ID 字段一致）。最大长度为 63字节
}

响应

{
  "requestURL": "", //可选，string，请求 URL
  "statusCode": 123, //必填，integer，状态码
  "statusString": "", //必填，string，状态描述
  "subStatusCode": "", //必填，string，子状态码
  "errorCode": 1, //可选，integer，当 statusCode 不为 1 时，必填。错误码与 subStatusCode对应
  "errorMsg": "ok", //可选，string，当 statusCode 不为 1 时，必填。错误详细信息，能具体到某一个参数的错误
  "responseStatusStrg": "OK", //可选，string，查询状态字符串描述：OK-查询结束，MORE-还有数据等待查询，NO MATCH-没有匹配数据，最大长度为 32，{dep if errcode == 1&& errMsg == ok}
  "numOfMatches": 1, //可选，integer，本次返回的记录条数，{dep if errcode == 1 &&errMsg == ok}
  "totalMatches": 1, //可选，integer，符合条件的记录总条数，{dep if errcode == 1 &&errMsg == ok}
  "MatchList": [{ //可选，array，查询到的匹配数据信息
    "FPID": "", //可选，string，人脸记录 ID（与门禁人员 ID 字段一致），最大长度为 63 字节
  }]
}

人脸设置（新增/修改）

请求

{
  "faceLibType": "blackFD", //必填，string，人脸库类型：blackFD-名单库
  "FDID": "1", //必填，string，人脸库 ID 最大长度为 63 字节（门禁设备默认为 1）
  "FPID": "", //可选，string，人脸记录 ID，如果外部传入，最长 63 字节，字母数字组合，需要保证唯一性。如果外部不传则由设备自动生成（与门禁人员 ID 字段一致）
  "deleteFP": true, //可选，boolean，是否删除该人脸，true-是（只有删除该人脸时，才填写该字段；新增或修改人脸时，不填写该字段）
}

人脸删除

请求

{
  "FPID": [{ //人脸记录 ID 列表（与门禁人员 ID 字段一致），array，支持多个人脸记录批量删除
    "value": "" //必填，string，人脸记录 ID，最大长度为 63 字节
  }]
}

查询所有人脸库人脸记录总数

响应

{
  "requestURL": "", //可选，string，请求 URL
  "statusCode": 123, //必填，integer，状态码
  "statusString": "", //必填，string，状态描述
  "subStatusCode": "", //必填，string，子状态码
  "errorCode": 1, //可选，integer，当 statusCode 不为 1 时，必填。错误码，与 subStatusCode对应
  "errorMsg": "ok", //可选，string，当 statusCode 不为 1 时，必填。错误详细信息，能具体到某一个参数的错误
  "FDRecordDataInfo": [{ //可选，人脸库记录信息，{dep if errcode==1&&errMsg==ok}
    "FDID": "", //可选，string，人脸库 ID，最大长度为 63 字节（门禁设备默认为 1）
    "faceLibType": "blackFD", //可选，string，人脸库类型：blackFD-名单库，最大长度为 32
    "recordDataNumber": 123 //可选，integer，记录数据条数
  }]
}

查询指定人脸库人脸记录总数

响应

{
  "requestURL": "", //可选，string，请求 URL
  "statusCode": 123, //必填，integer，状态码
  "statusString": "", //必填，string，状态描述
  "subStatusCode": "", //必填，string，子状态码
  "errorCode": 1, //可选，integer，当 statusCode 不为 1 时，必填。错误码，与 subStatusCode对应
  "errorMsg": "ok", //可选，string，当 statusCode 不为 1 时，必填。错误详细信息，能具体到某一个参数的错误
  "FDID": "", //可选，string，人脸库 ID，最大长度为 63 字节（门禁设备默认为 1）
  "faceLibType": "blackFD", //可选，string，人脸库类型：blackFD-名单库，最大长度为 32
  "recordDataNumber": 123 //可选，integer，记录数据条数
}

人脸采集