批量同步接口

  • 接口：common/externalPersonCard/batch
  • Method：POST
  • 数据格式：JSON
  • 限流信息：150次每天和50次每小时
  • 多语言环境：在接口请求头中添加Key为locale,Value值为语言环境,目前支持的语言有zh_CN(中文)、en_US(英文)、ja_JP(日文)、zh_TW(繁体),请选取其中一种
  • 其他补充信息：

参数:

请求参数

字段名称 字段类型 字段描述 是否必填 长度限制(字节)
bizId String 当前次接口同步的唯一标识 TRUE 36
timestamp long 当前次接口同步对应的时间戳 TRUE 13
data Array 当前次接口同步的数据集合 TRUE 无
data.code String 证件号 FALSE 64
data.person_code String 外部人员编码 TRUE 64
data.card_type String 证件类型(1:身份证 2:护照 3:台胞证 4:港澳通行证) TRUE 64
data.nationality String 国籍 FALSE 64
data.time_limit String 证件过期时间(格式 yyy-MM-dd) FALSE 0
data.enabled_flag String 是否启用标志(Y/N,默认为Y) FALSE 1
data.primary_flag String 默认类型标识(Y/N) FALSE 1

返回参数

字段名称 字段类型 字段描述
bizId String 当前次接口同步的唯一标识
resCode Integer 响应状态码（见附录）
resMsg String 返回信息描述
created String 创建成功的条数
updated String 更新成功的条数
validatorErrors Array 字段强校验不合格的数据
dbErrors Array 数据持久化时出现错误的数据
warnings Array 字段弱校验不合格的数据，任会做同步处理

示例：

请求数据

{
  "bizId": "293847928374893274",
  "timestamp": 942085094850934,
  "data": [
    {
      "code": "486937166631798313",
      "person_code": "CHIMULAN",
      "card_type": "1",
      "time_limit": "2037-07-31",
      "primary_flag": "Y",
      "enabled_flag": "Y"
    }
  ]
}

返回数据

{
  "resCode": 200,
  "resMsg": "SUCCESS",
  "bizId": "293847928374893274",
  "data": {
    "validatorErrors": {},
    "created": "此次请求新建成功了0条数据",
    "dbErrors": [],
    "updated": "此次请求更新成功了1条数据"
  }
}

results matching ""

    No results matching ""