接口说明
批量开卡
支持部分成功,部分失败
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/batch-add
请求Method
POST
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardList | true | array | 卡片信息集合 |
| -cardNumber | true | string | 卡号,8~16位数字字母组合,推荐是8位十六进制数(一代门禁设备要求),必须平台唯一 |
| -category | true | stringy | 卡介质 |
| -cardType | true | string | 卡类型 |
| -startDate | true | string | 卡片有效期-开始时间,格式yyyy-MM-dd HH:mm:ss |
| -endDate | true | string | 卡片有效期-结束时间,格式yyyy-MM-dd HH:mm:ss,结束时间减去开始时间不能大于10年 |
| -personId | false | long | 人员id |
| -departmentId | true | long | 部门id |
| -availableTimes | false | string | 有效次数 仅访客卡有效 |
| +fieldExt | false | Array | 自定义字段信息 |
| -businessType | false | string | 业务类型,其中6为卡片 |
| -useFieldNames | false | object | 自定义字段信息 key:value格式的数据 |
请求参数示例
{
"cardList": [{
"category": "0",
"cardType": "0",
"startDate": "2020-02-27 00:00:00",
"endDate": "2030-02-27 00:00:00",
"cardNumber": "11223344",
"personId": 20004,
"departmentId": 1,
"fieldExt": {
"businessType": "6",
"useFieldNames": {
"key1": "value1",
"key2": "value2"
}
}
},
{
"category": "0",
"cardType": "0",
"startDate": "2020-02-27 00:00:00",
"endDate": "2030-02-27 00:00:00",
"cardNumber": "11223345",
"personId": 20003,
"departmentId": 1,
"fieldExt": {
"businessType": "6",
"useFieldNames": {
"key1": "value1",
"key2": "value2"
}
}
}
]
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +errorInfo | objcet | 添加错误信息,若添加成功则无此属性 |
| ++key | string | 报错卡号 |
| ++value | string | 错误码 |
返回参数示例(成功)
{
"success": true,
"data": {},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": true,
"data": {
"errorInfo": {
"11223345": "28160002",
"11223344": "28160002"
}
},
"code": "0",
"errMsg": ""
}
接口说明
新增空白卡/激活卡接口
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/add
请求Method
POST
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| id | true | long | 主键id,调卡片全局id生成接口获取 |
| cardNumber | true | string | 卡号,8~16位数字字母组合,推荐是8位十六进制数(一代门禁设备要求),必须平台唯一 |
| category | true | string | 卡介质 |
| cardType | true | string | 卡类型 |
| startDate | true | string | 卡片有效期-开始时间,格式yyyy-MM-dd HH:mm:ss |
| endDate | true | string | 卡片有效期-结束时间,格式yyyy-MM-dd HH:mm:ss,结束时间减去开始时间不能大于10年 |
| personId | false | long | 人员id |
| departmentId | true | long | 部门id |
| availableTimes | false | string | 仅访客卡有效(现已无效,该功能移到人员来宾属性) |
| fieldExt | false | Array | 自定义字段信息 |
| +businessType | false | string | 业务类型,其中6为卡片 |
| +useFieldNames | false | object | 自定义字段信息 key:value格式的数据 |
请求参数示例
{
"id": 1,
"cardNumber": "11223344",
"cardPassword": "aaaaaa",
"category": "0",
"cardType": "0",
"departmentId": 1,
"startDate": "2020-02-18 00:00:00",
"endDate": "2021-02-18 00:00:00",
"fieldExt": {
"businessType": "6",
"useFieldNames": {
"key1": "value1",
"key2": "value2"
}
}
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +id | int | 新增卡片ID |
返回参数示例(成功)
{
"success": true,
"data": {
"id": 12
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28140000",
"errMsg": "该卡片已经存在"
}
接口说明
更新卡片信息
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/update
请求Method
PUT
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardNumber | true | string | 卡号,8~16位数字字母组合,推荐是8位十六进制数(一代门禁设备要求),必须平台唯一,不支持修改 |
| departmentId | true | long | 部门id,卡片未绑定人员支持修改,卡片已绑定人员则卡片和人员所属部门相同,不支持修改 |
| isCoercion | true | Int | 是否为胁迫卡,1:是,0:否 |
| startDate | true | string | 卡片有效期-开始时间,格式yyyy-MM-dd HH:mm:ss |
| endDate | true | string | 卡片有效期-结束时间,格式yyyy-MM-dd HH:mm:ss,结束时间减去开始时间不能大于10年 |
| availableTimes | false | string | 有效次数 仅访客卡有效 |
| updateAuth | false | string | 更新卡片操作限制类型,子系统使用 1为增加限制 2为删除限制 |
| deleteAuth | false | string | 删除卡片操作限制类型,子系统使用 1为增加限制 2为删除限制 |
| fieldExt | false | Array | 自定义字段信息 |
| +businessType | false | string | 业务类型,其中:6为卡片 |
| +useFieldNames | false | object | 自定义字段信息 key:value格式的数据 |
请求参数示例
{
"cardNumber": "10270001",
"isCoercion": 0,
"departmentId": 1,
"startDate": "2023-10-27 00:00:00",
"endDate": "2024-02-18 00:00:00"
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +id | long | 卡片ID |
返回参数示例(成功)
{
"success": true,
"data": {
"id": 12
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28140008",
"errMsg": "卡片权限错误"
}
接口说明
查询卡片详情
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/{cardNumber}
请求Method
GET
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardNumber | string | true | 卡号,8~16位数字字母组合,推荐是8位十六进制数(一代门禁设备要求),必须平台唯一 |
请求参数示例
/evo-apigw/evo-brm/1.0.0/card/15552551
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +id | long | 卡id |
| +cardNumber | string | 卡号,8~16位数字字母组合,推荐是8位十六进制数(一代门禁设备要求),必须平台唯一 |
| +personId | long | 人员id |
| +personName | string | 人员姓名 |
| +phone | string | 人员手机号 |
| +departmentId | long | 部门id |
| +departmentName | string | 部门名称 |
| +departmentNameExt | string | 部门名称(89系统一长度) |
| +startDate | string | 卡有效期-开始时间,格式yyyy-MM-dd HH:mm:ss |
| +endDate | string | 卡有效期-结束时间,格式yyyy-MM-dd HH:mm:ss |
| +cardStatus | string | 卡状态 |
| +validFlag | string | 有效标示符 |
| +category | string | 卡介质 |
| +isMainCard | int | 主卡标识 |
| +availableTimes | string | 有效次数 - 仅访客卡使用 |
| +isVirtual | int | 虚拟卡标识 系统自动为用户生成的虚拟IC主卡 |
| +fieldExt | object | 自定义字段信息 |
| ++businessType | string | 业务类型 |
| ++useFieldNames | object | 自定义字段信息 key:value格式的数据 |
返回参数示例(成功)
{
"success": true,
"data": {
"id": 12,
"cardNumber": "15552551",
"cardType": "0",
"departmentId": 1,
"departmentName": "根部门",
"startDate": "2020-02-18 00:00:00",
"endDate": "2028-02-18 00:00:00",
"cardStatus": "255",
"validFlag": "ENABLE",
"category": "0",
"isMainCard": 0,
"fieldExt": {
"businessType": "4",
"useFieldNames": {
"key1": "value1",
"key2": "value2"
}
}
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28140001",
"errMsg": "卡号不存在"
}
接口说明
激活卡片主要是绑定人员
前置条件
卡片状态必须为空白,即未绑定人员
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/active
请求Method
PUT
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardNumber | true | string | 卡号,8~16位数字字母组合,推荐是8位十六进制数(一代门禁设备要求),必须平台唯一 |
| personId | true | long | 人员id |
| departmentId | true | long | 部门id |
| cardPassword | false | string | 卡密码 |
| passwordKey | false | string | 公钥uuid 和cardPassword同时使用 |
| startDate | true | string | 卡片有效期-开始时间,格式yyyy-MM-dd HH:mm:ss |
| endDate | true | string | 卡片有效期-结束时间,格式yyyy-MM-dd HH:mm:ss,结束时间减去开始时间不能大于10年 |
| category | true | string | 卡介质 |
| availableTimes | false | string | 有效次数,仅访客卡有效 |
请求参数示例
{
"cardNumber": "88888888",
"personId": 2,
"departmentId": 1,
"cardPassword": null,
"passwordKey": null,
"startDate": "2022-01-03 00:00:00",
"endDate": "2026-01-03 00:00:00",
"availableTimes": null,
"category": "0"
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +id | long | 卡id |
返回参数示例(成功)
{
"success": true,
"data": {
"id": 7
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28140001",
"errMsg": "卡号不存在"
}
接口说明
换卡、补卡 旧卡状态置为已注销、新卡为已激活
前置条件
旧卡状态必须是已激活或已挂失
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/replace
请求Method
PUT
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardNumber | true | string | 原有卡号,8~16位数字字母组合,推荐是8位十六进制数(一代门禁设备要求),必须平台唯一 |
| newCardNumber | true | string | 新卡号,8~16位数字字母组合,推荐是8位十六进制数(一代门禁设备要求),必须平台唯一 |
请求参数示例
{
"cardNumber": "77889900",
"newCardNumber": "11111111"
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +id | long | 新卡id |
返回参数示例(成功)
{
"success": true,
"data": {
"id": 15
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28140000",
"errMsg": "该卡片已经存在"
}
接口说明
批量退卡接口 - 适用于激活卡,退卡成功后,卡片状态为空白
前置条件
卡片必须是激活状态
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口URL
/evo-apigw/evo-brm/1.0.0/card/return
请求Method
PUT
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardIds | true | array | 卡id数组 |
请求参数示例
{
"cardIds": [15, 16]
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +errorInfo | array | 添加错误列表,若添加成功则无此属性 |
| ++key | string | 报错卡号 |
| ++value | string | 错误码 |
返回参数示例(成功)
{
"success": true,
"data": {},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": true,
"data": {
"failNum": 0,
"failList": {
"9836041122": "28140008"
},
"successNum": 1
},
"code": "0",
"errMsg": ""
}
接口说明
批量删除卡片信息后,卡片相应权限自动删除
前置条件
卡片状态为空白或已注销
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/delete
请求Method
DELETE
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardIds | false | array | 卡id数组 |
| cardNumbers | false | array | 卡号数组 |
请求参数示例
{
"cardIds": [15, 16]
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +failNum | int | 删除失败的卡片数量 |
| +successNum | int | 删除成功的卡片数量 |
| +errorInfo | array | 添加错误列表,若添加成功则无此属性 |
| ++key | string | 报错卡号 |
| ++value | string | 错误码 |
返回参数示例(成功)
{
"success": true,
"data": {
"failNum": 0,
"successNum": 1,
"failList": []
},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": true,
"data": {
"failNum": 0,
"errorInfo": {
"9836041122": "28140008"
},
"successNum": 1
},
"code": "0",
"errMsg": ""
}
接口说明
批量挂失卡片后,权限自动取消,配合解挂卡片接口可恢复卡片状态为已激活
前置条件
卡片状态是已激活
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/lose
请求Method
PUT
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardIds | true | array | 卡id数组 |
请求参数示例
{
"cardIds": [15, 16]
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
返回参数示例(成功)
{
"success": true,
"data": {},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28140003",
"errMsg": "参数校验不通过"
}
接口说明
批量解挂卡片后,卡片状态为已激活,权限自动恢复; 主要配合卡片挂失接口调用
前置条件
卡片状态必须为已挂失
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/relieve
请求Method
PUT
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardIds | true | array | 卡id数组 |
请求参数示例
{
"cardIds": [15, 16]
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
返回参数示例(成功)
{
"success": true,
"data": {},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28140003",
"errMsg": "参数校验不通过"
}
接口说明
批量回收卡片后,卡片状态变为空白
前置条件
卡片状态必须是已注销
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/recycle
请求Method
PUT
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cardIds | true | array | 卡id数组 |
请求参数示例
{
"cardIds": [15, 16]
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
返回参数示例(成功)
{
"success": true,
"data": {},
"code": "0",
"errMsg": ""
}
返回参数示例(失败)
{
"success": false,
"data": {},
"code": "28140003",
"errMsg": "参数校验不通过"
}
接口说明
生成卡片全局id
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.0.0
接口URL
/evo-apigw/evo-brm/1.0.0/card/generate-id
请求Method
GET
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|
请求参数示例
/evo-apigw/evo-brm/1.0.0/card/generate-id
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +id | long | 卡片全局唯一id |
返回参数示例(成功)
{
"success": true,
"data": {
"id": 1
},
"code": "0",
"errMsg": ""
}
接口说明
批量生成卡片全局id
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.2.0
接口URL
/evo-apigw/evo-brm/1.2.0/card/batch-generate-id
请求Method
GET
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| count | true | int | 生成数量 |
请求参数示例
/evo-apigw/evo-brm/1.0.0/card/batch-generate-id?count=3
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | object | 返回数据对象 |
| +idList | Array | 卡片全局唯一id集合 |
返回参数示例(成功)
{
"success": true,
"data": {
"idList": [1, 2, 3]
},
"code": "0",
"errMsg": ""
}
接口说明
分页查询卡片信息
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.2.0
接口URL
/evo-apigw/evo-brm/1.2.0/card/subsystem/page
请求Method
POST
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| pageNum | false | int | 当前页, 默认1 |
| pageSize | false | int | 一页几条 默认10 |
| sort | false | string | 排序字段 排序字段(参数描述参考返回列表):id(默认)、createTime、updateTime、cardNumber、startDate、endDate、availableTimes、personId、departmentId |
| sortType | false | string | 排序规则 排序规则:正序-ASC 倒序-DESC(默认) |
| cardNumberList | false | List | 卡号列表 列表最大支持500 |
| personIdList | false | List | 人员id列表 列表最大支持500 |
| cardStatusList | false | List | 卡状态列表最大支持500 |
| isMainCard | false | Integer | 区分是否是主卡 1为主卡 |
| isVirtual | false | Integer | 区分是否是虚拟卡 1为虚拟卡 |
| isCoercion | false | Integer | 区分是否是胁迫卡 1为胁迫卡 |
| category | false | String | 卡介质 |
| departmentId | false | Long | 卡归属主部门id |
| includeSubDepartmentFlag | false | boolean | 是否查询主部门所有下级部门 卡归属主部门id存在时生效,默认false |
请求参数示例
{
"pageNum": 1,
"pageSize": 10,
"sortType": "ASC",
"sort": "createTime",
"cardNumberList":["15684646","22369742","11111111"],
"cardTypeList": ["0","1"],
"personIdList": [1,2],
"cardStatusList": [0,1,2],
"isMainCard":0,
"isVirtual":1,
"isCoercion":0,
"category":"2",
"departmentId":1,
"includeSubDepartmentFlag":true
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | PageVO | 分页数据 |
PageVO
| 名称 | 类型 | 说明 |
|---|---|---|
| currentPage | int | 当前页码 |
| totalPage | int | 总页数 |
| pageSize | int | 每页记录数 |
| totalRows | int | 总数 |
| pageData | List<CardInfoVO> | 数据列表 |
CardInfoVO
| 名称 | 类型 | 说明 |
|---|---|---|
| id | long | 卡id |
| cardNumber | string | 卡号 |
| cardPassword | string | 卡密码 |
| subSystems | string | 子系统编号 |
| personId | long | 人员id |
| departmentId | long | 部门id |
| startDate | long | 卡有效期-开始时间,时间戳,单位毫秒 |
| endDate | long | 卡有效期-结束时间,时间戳,单位毫秒 |
| cardStatus | string | 卡状态,255-空白 0-激活 1-挂失 2-注销 8-欠费 16-逾期 32-预欠费 |
| availableTimes | string | 有效次数 - 仅访客卡使用 |
| description | string | 备注 |
| validFlag | string | 有效标示符 |
| category | string | 卡介质,0-IC卡 1-有源RFID 2-CPU卡 |
| isMainCard | int | 主卡标识 |
| isVirtual | int | 虚拟卡标识 系统自动为用户生成的虚拟IC主卡 |
| isCoercion | Integer | 是否胁迫卡 1为胁迫卡 |
返回参数示例(成功)
{
"success": true,
"data": {
"pageData": [{
"id": 1,
"cardNumber": "11111111",
"cardType": "1",
"cardPassword": "39BBBEFA43FE15B38E83F79D7B65E8AB8B6A257527B305D7A6A1ACA50BE3C4E1",
"subSystems": "1",
"personId": 1,
"departmentId": 1,
"startDate": 1598544000000,
"endDate": 1914131408000,
"cardStatus": "1",
"availableTimes": "1",
"description": "1",
"createTime": 1598598575000,
"createBy": 1,
"updateTime": 1599113511000,
"updateBy": 1,
"validFlag": "ENABLE",
"category": "2",
"isMainCard": 1,
"isVirtual": 1,
"isCoercion": 0
}],
"currentPage": 1,
"totalPage": 1,
"pageSize": 10,
"totalRows": 1
},
"code": "0",
"errMsg": ""
}
接口说明
同步全量的卡片数据
接口配套版本信息
智能物联综合管理平台iConnection Center V5.0.6及以上版本
接口版本
1.2.0
接口URL
/evo-apigw/evo-brm/1.2.0/card/page
请求Method
POST
数据提交格式
application/json
请求参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| pageNum | false | int | 当前页, 默认1 |
| pageSize | false | int | 每页记录数, 默认10 |
| searchKey | false | string | 搜索关键字 |
请求参数示例
{
"pageNum": 1,
"pageSize": 10
}
返回参数
| 名称 | 类型 | 说明 |
|---|---|---|
| success | boolean | 接口返回是否成功 |
| code | string | 错误码:0-为无错误,非0-为具体错误码 |
| errMsg | string | 错误消息 |
| data | PageVO | 分页数据 |
PageVO
| 名称 | 类型 | 说明 |
|---|---|---|
| currentPage | int | 当前页码 |
| totalPage | int | 总页数 |
| pageSize | int | 每页记录数 |
| totalRows | int | 总数 |
| pageData | List<CardInfoVO> | 数据列表 |
CardInfoVO
| 名称 | 类型 | 说明 |
|---|---|---|
| id | long | 卡id |
| cardNumber | string | 卡号 |
| personId | long | 人员id |
| personName | string | 人员姓名 |
| phone | string | 人员手机号 |
| departmentId | long | 部门id |
| departmentName | string | 部门名称 |
| startDate | string | 卡有效期-开始时间 |
| endDate | string | 卡有效期-结束时间 |
| cardStatus | string | 卡状态 |
| validFlag | string | 有效标示符 |
| category | string | 卡介质 |
| isMainCard | int | 主卡标识 |
| availableTimes | string | 有效次数 - 仅访客卡使用 |
| isVirtual | int | 虚拟卡标识 系统自动为用户生成的虚拟IC主卡 |
| pageFieldExt | JSONObject | 自定义字段信息 key:value格式的数据 |
返回参数示例(成功)
{
"success": true,
"data": {
"pageData": [{
"id": 1,
"cardNumber": "11111111",
"cardType": "1",
"cardPassword": "39BBBEFA43FE15B38E83F79D7B65E8AB8B6A257527B305D7A6A1ACA50BE3C4E1",
"subSystems": "1",
"personId": 1,
"departmentId": 1,
"startDate": 1598544000000,
"endDate": 1914131408000,
"cardStatus": "1",
"availableTimes": "1",
"description": "1",
"createTime": 1598598575000,
"createBy": 1,
"updateTime": 1599113511000,
"updateBy": 1,
"validFlag": "ENABLE",
"category": "2",
"isMainCard": 1,
"isVirtual": 1,
"isCoercion": 0,
"pageFieldExt": {
"key1": "value1",
"key2": "value2"
}
}],
"currentPage": 1,
"totalPage": 1,
"pageSize": 10,
"totalRows": 1
},
"code": "0",
"errMsg": ""
}