新增或修改

接口地址:/openapi/worker

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述: 因为有需求需要删除某列值,所以工人属性为空的情况,会执行删除值操作,所以不修改的值,请一起传给接口。

请求示例:

{
  "id": 0,  //新增为nul,修改需要
  "gender": "",
  "genderName": "",
  "idCard": "",
  "bankName": "",
  "bankCardNo": "",
  "orgId": 0,
  "orgIds": [],
  "orgName": "",
  "phoneNumber": "",
  "signDate": "",
  "typeName": "",
  "userId": 0,
  "workerName": "",
  "workerType": "" //参数为下个接口(获取工人工种类型)返回的code,而非value
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
worker 工人 body true Worker Worker
  id 工人ID(新增为nul,修改需要) fasle integer(int64)
  workerName 工人姓名 true string
  phoneNumber 手机号 true string
  workerType 工种 true string 参数为下个接口(获取工人工种类型)返回的code,而非value
  orgId 组织ID true integer(int64)
  gender 性别 false string
  genderName 性别名称 false string
  idCard 身份证号 false string
  bankName 开户行 false string
  bankCardNo 银行卡号 false string
  orgIds 组织ID集合 false array integer
  orgName 组织名称 false string
  signDate 入职时间 false string(date-time)

响应状态:

状态码 说明 schema
200 OK R
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data object
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": {
      "id":1, // 用于查询详情、修改等功能
      "userId": 0
    },
    "message": "",
    "successful": true
}

获取工人工种类型

接口地址:/openapi/worker/getTypes

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK R
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data object
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": {},
    "message": "",
    "successful": true
}

新增工人工种类型

接口地址:/openapi/worker/type/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{
  "code": "",
  "description": "",
  "name": "",
  "parentId": 0,
  "sortNumber": 0,
  "value": ""
}

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
dataDictionary 数据字典 body true DataDictionary DataDictionary
  code true string
  description 描述 false string
  name 字典名称 true string
  parentId 父级ID false integer(int64)
  sortNumber 排序 false integer(int32)
  value true string

响应状态:

状态码 说明 schema
200 OK R
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data object
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": {},
    "message": "",
    "successful": true
}

查询分页数据

接口地址:/openapi/worker/query

请求方式:POST

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求示例:

/openapi/worker/query?pageNo=1&pageSize=20&showPhone=false

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
pageNo pageNo query false integer(int32)
pageSize pageSize query false integer(int32)
showPhone showPhone query false Boolean 显示完整手机号

响应状态:

状态码 说明 schema
200 OK R«open-platform 分页简单对象«Worker»»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data open-platform 分页简单对象«Worker» 分页简单对象«Worker»
  current 当前页 integer(int64)
  records 查询数据列表 array Worker
    id 工人ID integer(int64)
    faceUrl 人脸图片 string
    gender 性别 string
    genderName 性别名称 string
    idCard 身份证号 string
    bankName 开户行 string
    bankCardNo 银行卡号 string
    orgId 组织ID integer
    orgIds 组织ID集合 array integer
    orgName 组织名称 string
    phoneNumber 电话号码 string
    signDate 入职时间 string
    userId 用户ID integer
    workerName 工人姓名 string
    workerType 工种类型编码 string
    typeName 工种类型名称 string
  size 每页显示条数 integer(int64)
  total 总数 integer(int64)
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": {
        "current": 0,
        "records": [
            {
                "id": 0,
                "faceUrl": "",
                "gender": "",
                "genderName": "",
                "idCard": "",
                "bankName": "",
                "bankCardNo": "",
                "orgId": 0,
                "orgIds": [],
                "orgName": "",
                "phoneNumber": "",
                "signDate": "",
                "userId": 0,
                "workerName": "",
                "workerType": "",
                "typeName": ""
            }
        ],
        "size": 0,
        "total": 0
    },
    "message": "",
    "successful": true
}

根据ID查询详情

接口地址:/openapi/worker/{id}

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id id path true integer(int64)

响应状态:

状态码 说明 schema
200 OK R«Worker»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data Worker Worker
  id 工人ID integer(int64)
  faceUrl 人脸图片 string
  gender 性别 string
  genderName 性别名称 string
  idCard 身份证号 string
  bankName 开户行 string
  bankCardNo 银行卡号 string
  orgId 组织ID integer(int64)
  orgIds 组织ID集合 array integer
  orgName 组织名称 string
  phoneNumber 电话号码 string
  signDate 入职时间 string(date-time)
  userId 用户ID integer(int64)
  workerName 工人姓名 string
  workerType 工种类型编码 string
  typeName 工种类型名称 string
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": {
        "id": 0,
        "faceUrl": "",
        "gender": "",
        "genderName": "",
        "idCard": "",
        "bankName": "",
        "bankCardNo": "",
        "orgId": 0,
        "orgIds": [],
        "orgName": "",
        "phoneNumber": "",
        "signDate": "",
        "userId": 0,
        "workerName": "",
        "workerType": "",
        "typeName": ""
    },
    "message": "",
    "successful": true
}

根据ID删除工人

接口地址:/openapi/worker/{id}

请求方式:DELETE

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id id path true integer(int64)

响应状态:

状态码 说明 schema
200 OK R«Worker»
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
data object
message string
successful boolean

响应示例:

{
    "code": 0,
    "data": {},
    "message": "",
    "successful": true
}
作者:admin  创建时间:2021-07-06 11:17
最后编辑:admin  更新时间:2025-05-30 16:03