批量新增白名单 #
请求方式 POST
consumes ["application/json"]
produces ["*/*"]
接口描述 批量新增白名单
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| request | request | body | true | WhiteMemBatchAddRequest | WhiteMemBatchAddRequest |
schema属性说明
WhiteMemBatchAddRequest
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| memInfoList | 白名单列表(上限5万条) | body | true | array | WhiteMemBatchAddDTO |
| vipId | 客户编号 | body | true | string |
WhiteMemBatchAddDTO
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| staffName | 中文姓名 | body | false | string | |
| sireName | 英文姓(传入中文姓名时,可为空) | body | false | string | |
| giveName | 英文名(传入中文姓名时,可为空) | body | false | string | |
| gender | 性别 1-男 2-女 | body | false | string | |
| birthday | 生日(yyyy-MM-dd) | body | false | string(date) | |
| contact | 联系方式 | body | false | string | |
| country | 国籍(中文) | body | false | string | |
| 邮箱 | body | false | string | ||
| identityType | 身份类别(不传默认员工) 01-员工 02-家属 03-合作伙伴 | body | false | string | |
| memIdList | 证件列表 | body | false | array | WhiteMemIdInfoDTO |
| memo | 备注 | body | false | string | |
| subDepart | 二级部门 | body | false | string |
WhiteMemIdInfoDTO
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
|---|---|---|---|---|---|
| certNo | 证件号 | body | true | string | |
| certType | 证件类型 NI-身份证 PP-护照 07-港澳居民居住证 08-台湾居民居住证 10-港澳通行证 11-大陆居民往来台湾通行证 12-港澳居民来往内地通行证 13-台湾居民来往大陆通行证 14-军方证件 15-海员证/商船船员证 16-外国人永久居留证 17-外国人出入境证 98-户口本/出生证明 OD-其它证件 | body | true | string | |
| country | 证件签发国(中文) | body | false | string | |
| validDate | 证件有效期(yyyy-MM-dd) | body | false | string(date) |
响应参数
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| code | 见响应状态码 | string | |
| errStr | 错误类型 | string | |
| message | 错误消息 | string | |
| traceId | 请求跟踪编号 | string | |
| data | array | WhiteFalseRecDTO |
schema属性说明
WhiteFalseRecDTO
| 参数名称 | 参数说明 | 类型 | schema |
|---|---|---|---|
| index | 错误记录索引 | integer(int32) | |
| reason | 错误原因 | string |
响应状态
| 状态码 | 说明 | schema |
|---|---|---|
| 200 | 成功 | |
| 201 | 参数错误 | |
| 400 | 业务异常 |
请求示例
{
"memInfoList": [
{
"staffName": "林一二",
"sireName": "LIN",
"giveName": "YIER",
"gender": "1",
"birthday": "1999-01-01",
"contact": "18888888888",
"country": "中国",
"email": "test11@qq.com",
"identityType": "01",
"memIdList": [
{
"certNo": "11111111111",
"certType": "PP",
"country": "中国",
"validDate": "2030-12-31"
}
],
"memo": "",
"subDepart": ""
}
],
"vipId": "1900002"
}
成功响应示例
{
"code": "200",
"errStr": "SUCCESS",
"message": "SUCCESS",
"traceId": "3b8c4b40d53046fa9341be313e092ba6",
"data": null
}
失败响应示例
{
"code": "201",
"errStr": "参数错误",
"message": "白名单数据有误,上传失败",
"traceId": "efe0c31fceb14941a4004a7a1ff8352d",
"data": [
{
"index": 0,
"reason": "身份证号码有误"
},
{
"index": 1,
"reason": "中文姓名为空时,必须传入英文姓名"
}
]
}