1. 卡片管理

卡片管理

1.1. 添加空白卡

基础信息

路径: /v1/api/card/addBlank

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
number string 是 卡号, 格式: 数字;加密方式为只读物理卡号时，取值范围[1,4294967295];加密方式为非只读物理卡号时，如果卡号位数为8，取值范围为[1, 16777215],如果卡号位数为10，取值范围为[1 , 4294967295]

Body示例:

{
  "number": "12345678"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─uuid string 否 卡片UUID

响应示例:

{
  "code":0,
  "data":{
    "uuid":"c4c82851a3154983a914de8891008114"
  },
  "msg":"成功"
}

1.2. 删除空白卡

基础信息

路径: /v1/api/card/batchDelete

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
cardUuidList array 是 卡片UUID列表
  |─ string

Body示例:

{
  "cardUuidList": [
    "c4c82851a3154983a914de8891008114"
  ]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code":0,
  "msg":"成功"
}

1.3. 更新卡片信息，只能修改生效日期和截止日期

基础信息

路径: /v1/api/card/update

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 卡片UUID
beginDate integer 否 生效日期
endDate integer 否 失效日期

Body示例:

{
  "uuid": "de9a101af31b4de18cda0ee0000bcacd",
  "beginDate": 1679379972000,
  "endDate": 1994999172000

}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code":0,
  "msg":"成功"
}

1.4. 卡片列表检索

基础信息

路径: /v1/api/card/list

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
cardStatus integer 是 卡状态
0 :空白(对应悟空卡状态 3)
1 :正常
2 :挂失
cardNum string 否 卡号
beginDate integer 否 生效日期
endDate integer 否 失效日期
personName string 否 人员姓名
orgUuid string 否 部门UUID
isRecursive boolean 否 true 是否递归查询子组织下的人员(此处指的是机构)
是否递归查询子组织下的人员(此处指的是机构)，默认是true
pageNum integer 否 1 页码，从1开始
当前页码,不传默认1
pageSize integer 否 20 页面大小
分页大小，不传默认20

Body示例:

{
  "pageNum": 1,
  "pageSize": 20,
  "cardStatus": 1
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值
  |─pageNum integer 是 页码，从1开始
当前页码
  |─pageSize integer 是 页面大小
分页大小
  |─total integer 是 总记录数
总数
  |─list array 否
    |─ object
      |─uuid string 否 uuid
      |─cardNum string 否 卡号
      |─beginDate string 否 卡片生效日期
      |─endDate string 否 卡片失效日期
      |─status integer 否 卡片状态
0 :空白(对应悟空卡状态 3)
1 :正常
2 :挂失
      |─personUuid string 否 人员ID
      |─personName string 否 人员名称
      |─orgName string 否 组织名称
      |─orgUuid string 否 组织UUID

响应示例:

{
  "code":0,
  "data":{
    "list":[
      {
        "beginDate":1672502400000,
        "cardNum":"100000011",
        "endDate":2524665599000,
        "orgName":"默认部门",
        "orgUuid":"0",
        "personName":"1陈阳",
        "personUuid":"289830385c694f9c8b710dcd8192a21d",
        "status":1,
        "uuid":"d8e94211568c465b90269b104d66a34f"
      },
      {
        "beginDate":1672502400000,
        "cardNum":"100000012",
        "endDate":2524665599000,
        "orgName":"默认部门",
        "orgUuid":"0",
        "personName":"2黄春兰",
        "personUuid":"3234babc345f41eb9347b15131956232",
        "status":1,
        "uuid":"fd286a9dd43c4b8eb279860dc73b4877"
      },
      {
        "beginDate":1672502400000,
        "cardNum":"100000013",
        "endDate":2524665599000,
        "orgName":"默认部门",
        "orgUuid":"0",
        "personName":"3毛强",
        "personUuid":"74e3a7e1d2964bb28ad7ce2ba20f0c65",
        "status":1,
        "uuid":"63dc2e69302b4831883d3ee1300d86b7"
      },
      {
        "beginDate":1672502400000,
        "cardNum":"100000014",
        "endDate":2524665599000,
        "orgName":"默认部门",
        "orgUuid":"0",
        "personName":"4刘伟展",
        "personUuid":"c413b30e5c394966acb46ba8daab7a54",
        "status":1,
        "uuid":"ea3fc04d51644e2a9679b48118d7a951"
      },
      {
        "beginDate":1672502400000,
        "cardNum":"100000015",
        "endDate":2524665599000,
        "orgName":"默认部门",
        "orgUuid":"0",
        "personName":"5刘晓茂",
        "personUuid":"5aa6e960651d41b48d2fbe77cbd695cf",
        "status":1,
        "uuid":"823932d6153c425ebe65991e77e813bf"
      },
      {
        "beginDate":1672502400000,
        "cardNum":"100000016",
        "endDate":2524665599000,
        "orgName":"默认部门",
        "orgUuid":"0",
        "personName":"6骆明",
        "personUuid":"9cc4236e5e7140b4afd936b11e29077a",
        "status":1,
        "uuid":"7e13d8e303044378bdf00566fad45e0b"
      },
      {
        "beginDate":1672502400000,
        "cardNum":"100000017",
        "endDate":2524665599000,
        "orgName":"默认部门",
        "orgUuid":"0",
        "personName":"7彭斯亮",
        "personUuid":"fa537214a63844fc9847b05d6f11a3dc",
        "status":1,
        "uuid":"43a0104de2a4409fa635f03906745363"
      },
      {
        "beginDate":1679328000000,
        "cardNum":"12345678",
        "endDate":1995033599000,
        "orgName":"默认部门",
        "orgUuid":"0",
        "personName":"sxk",
        "personUuid":"0fa98d891d9e4962a9317cabc9099d20",
        "status":1,
        "uuid":"de9a101af31b4de18cda0ee0000bcacd"
      }
    ],
    "pageNum":1,
    "pageSize":20,
    "total":8
  },
  "msg":"成功"
}

1.5. 退卡

基础信息

路径: /v1/api/card/batchBack

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
cardUuidList array 是 卡片UUID列表
  |─ string

Body示例:

{
  "cardUuidList": [
    "68a09e1c0f39445c9a76016d411cc056"
  ]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code":0,
  "msg":"成功"
}

1.6. 换卡

基础信息

路径: /v1/api/card/replace

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
oldCardUuid string 是 旧卡UUID
newCardUuid string 否 新卡UUID
newCardNum string 否 新卡号

Body示例:

{
  "oldCardUuid": "3e78210a1ab04d3f837b6111ac6376c3",
  "newCardNum": "12345677"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code":0,
  "msg":"成功"
}

1.7. 挂失卡片

基础信息

路径: /v1/api/card/loss

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 卡片UuiD

Body示例:

{
  "uuid": "3e78210a1ab04d3f837b6111ac6376c3"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code":0,
  "msg":"成功"
}

1.8. 解挂

基础信息

路径: /v1/api/card/unloss

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
uuid string 是 卡片UuiD

Body示例:

{
  "uuid": "3e78210a1ab04d3f837b6111ac6376c3"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code":0,
  "msg":"成功"
}

1.9. 绑定卡

基础信息

路径: /v1/api/card/bind

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
personUuid string 是 人员ID
cardUuid string 是 卡号Uuid
beginDate integer 否 卡片生效日期
endDate integer 否 卡片失效日期

Body示例:

{
  "personUuid": "0fa98d891d9e4962a9317cabc9099d20",
  "cardUuid": "de9a101af31b4de18cda0ee0000bcacd",
  "beginDate": 1679379972000,
  "endDate": 1994999172000
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 必须 默认值 备注
code integer 否 返回值code
msg string 否 返回值消息
data object 否 具体的返回值

响应示例:

{
  "code":0,
  "msg":"成功"
}

results matching ""

    No results matching ""