创建员工

POST /v1/user

请求参数
参数 类型 必填 说明
email 字符串 邮箱, 必须是有效的邮件地址.
password 字符串 密码.
realname 字符串 姓名, 长度32字符.
mobile 字符串 手机号, 需满足格式regular expression ^1[3-9]\d{9}$.
position 对象 岗位.
position.id 整型 岗位ID.
roleList 数组 角色列表.
roleList[].id 整型 角色ID.
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见, true / false .
data 对象 业务对象.
data.id 整型 员工ID.
data.email 字符串 邮箱.
data.position 对象 岗位.
data.position.id 整型 岗位ID.
data.realname 字符串 姓名.
data.mobile 字符串 手机号.
data.roleList 数组 角色数组.
data.roleList[].id 整型 角色ID.
data.authorizationSetList 数组 权限集数组.
data.authorizationSetList[].id 整型 权限集ID.
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/user?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "email" : "1@test.cn",
  "password" : "sJrKTUpSx",
  "realname" : "测试员工1",
  "mobile" : "13300000001",
  "position" : {
    "id" : 2
  },
  "roleList" : [ {
    "id" : 3
  } ]
}'
响应示例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 942,
    "email" : "1@test.cn",
    "position" : {
      "id" : 2
    },
    "realname" : "测试员工1",
    "mobile" : "13300000001",
    "roleList" : [ {
      "id" : 3
    } ],
    "authorizationSetList" : [ ]
  }
}

更新员工

PUT /v1/user/{id:^[1-9]\d*$}

嵌入请求参数
参数 类型 必填 说明 限制
id 整型 ID. 必须大于1
请求参数
参数 类型 必填 说明
realname 字符串 姓名.
mobile 字符串 手机, 需满足格式regular expression ^1[3-9]\d{9}$.
position 对象 岗位.
position.id 整型 岗位ID
status 整型 状态: 1启用; 2禁用; 3审核中.
roleList 数组 角色.
roleList[].id 整型 角色ID.
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见. true / false .
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/user/944?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "realname" : "测试员工1",
  "mobile" : "13300000001",
  "position" : {
    "id" : 2
  },
  "status" : 1,
  "roleList" : [ {
    "id" : 2
  } ]
}'
响应示例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

查询员工

GET /v1/user/{id:^[1-9]\d*$}

嵌入请求参数
参数 类型 必填 说明 限制
id 整型 员工ID 必须大于1
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见. true / false .
data 对象 业务对象.
data.id 整型 员工ID.
data.email 字符串 邮箱.
data.position 对象 岗位.
data.position.id 整型 岗位ID.
data.realname 字符串 姓名.
data.mobile 字符串 手机号.
data.roleList 数组 角色.
data.roleList[].id 整型 角色ID.
data.authorizationSetList 数组 权限集.
data.authorizationSetList[].id 整型 权限集ID.
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/user/941?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
响应示例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 941,
    "email" : "2@test.cn",
    "position" : {
      "id" : 2
    },
    "realname" : "测试员工2",
    "mobile" : "13300000002",
    "roleList" : [ {
      "id" : 3
    } ],
    "authorizationSetList" : [ ]
  }
}

删除员工

DELETE /v1/user/{ids}

请求参数
参数 类型 必填 说明
ids 字符串 false 员工ID. 支持批量删,多个员工时可使用,拼接ID
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见, true / false .
data 对象 业务对象.
data.successList 数组 删除成功员工集合.
data.successTotal 整型 删除成功个数
data.failMap 对象 删除失败员工集合.
data.failTotal 整型 删除失败个数
data.total 整型 删除成功个数
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/user/1,2,3?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'
响应示例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "successList" : [1],
    "successTotal" : 1,
    "failMap" : {
        "2" : "员工不存在",
        "3" : "员工不可删除"
    },
    "failTotal" : 2,
    "total" : 3
  }
}

查询员工列表

GET /v1/user

请求参数
参数 类型 必填 说明
pageNum 整型 页数, Min: 1.
pageSize 整型 页数大小, Min: 1, Max: 100.
positionId 整型 岗位ID, 如果传了此参数, 将仅查询指定岗位下的员工.
响应数据

标准分页对象分页

属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见, true / false .
paging 对象 分页对象.
paging.pageNum 整型 分页页码.
paging.pageSize 整型 分页页大小.
paging.total 整型 分页查询命中总数.
data 数组 业务对象.
data[].id 整型 员工ID.
data[].email 字符串 邮箱.
data[].position 对象 岗位.
data[].position.id 整型 岗位ID.
data[].realname 字符串 姓名.
data[].mobile 字符串 手机号.
data[].roleList 数组 角色.
data[].roleList[].id 整型 角色ID.
data[].authorizationSetList 数组 权限集.
data[].authorizationSetList[].id 整型 权限集ID.
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/user?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&pageSize=10&pageNum=1' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
响应示例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "paging": {
    "pageNum": 1,
    "pageSize": 10,
    "total": 50
  },
  "data" : [ {
    "id" : 936,
    "email" : "1@test.cn",
    "position" : {
      "id" : 2
    },
    "realname" : "测试员工1",
    "mobile" : "13300000001",
    "roleList" : [ {
      "id" : 3
    } ],
    "authorizationSetList" : [ ]
  }, {
    "id" : 935,
    "email" : "lisi@test.cn",
    "position" : {
      "id" : 4
    },
    "realname" : "测试员工2",
    "mobile" : "13300000002",
    "roleList" : [ {
      "id" : 3
    } ],
    "authorizationSetList" : [ ]
  }]
}