创建员工组

POST /v1/userGroup

请求参数
参数 类型 必填 说明
name 字符串 是 员工组名称.
userList 数组 否 员工列表.
userList[].id 整型 是 员工ID.
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见, true / false .
data 对象 业务对象.
data.id 整型 员工组ID.
data.name 字符串 员工组名称.
data.userCount 整型 员工数.
data.userList 数组 员工列表.
data.userList[].id 整型 员工ID.
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "name" : "测试员工组1",
  "userList" : [ {
    "id" : 2
  } ]
}'
响应示例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "id" : 1,
    "name" : "测试员工组1",
    "userCount" : 1,
    "userList" : [ {
      "id" : 2
    } ]
  }
}

更新员工组

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

嵌入请求参数
参数 类型 必填 说明 限制
id 整型 是 员工组ID 必须大于1
请求参数
参数 类型 必填 说明
name 字符串 是 名称.
userList 数组 是 员工列表.
userList[].id 整型 是 员工ID.
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见, true / false .
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup/1?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "name" : "测试员工组2",
  "userList" : [ {
    "id" : 3
  } ]
}'
响应示例
{
  "code" : 200,
  "message" : "OK",
  "visible" : true
}

查询员工组

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

嵌入请求参数
参数 类型 必填 说明 限制
id 整型 是 员工组ID 必须大于1
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见. true / false .
data 对象 业务对象.
data.id 整型 员工组ID.
data.name 字符串 名称.
data.userCount 整型 员工数.
data.userList 数组 员工列表.
data.userList[].id 整型 员工ID.
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup/1?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" : 1,
    "name" : "测试员工组2",
    "userCount" : 1,
    "userList" : [ {
      "id" : 3
    } ]
  }
}

删除员工组

DELETE /v1/userGroup/{ids}

嵌入请求参数
参数 类型 必填 说明 限制
id 整型 是 员工组ID 必须大于1
响应数据
属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见. true / false .
data 对象 业务对象.
data.successList 数组 删除成功集合
data.successTotal 整型 删除成功个数
data.failMap 对象 删除失败集合
data.failTotal 整型 删除失败个数
data.total 整型 删除成功与失败的数量和
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup/3,4?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" : [3],
    "successTotal" : 1,
    "failMap" : {
        "4" : "员工组不存在"
    },
    "failTotal" : 1,
    "total" : 2
  }
}

查询员工组列表

GET /v1/userGroup

请求参数
参数 类型 必填 描述
pageNum 整型 否 页码, Min: 1, 默认: 1.
pageSize 整型 否 页大小, Min: 1, Max: 100, 默认: 20.
响应数据

标准分页对象分页

属性名 类型 说明
code 整型 响应编码.
message 字符串 响应消息.
visible 布尔型 是否可见, true / false .
paging 对象 分页对象.
paging.pageNum 整型 分页页码.
paging.pageSize 整型 分页页大小.
paging.total 整型 分页查询命中总数.
data 数组 业务对象.
data[].id 整型 ID.
data[].name 字符串 名称.
data[].userCount 整型 员工数.
data[].userList 数组 员工列表.
data[].userList[].id 整型 用户ID.
请求示例
$ curl 'https://servicego.udesk.cn/api/v1/userGroup?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" : 187,
    "name" : "测试员工组1",
    "userCount" : 3,
    "userList" : [{
        "id" : 2
    }]
  }, {
    "id" : 383,
    "name" : "测试员工组2",
    "userCount" : 1,
    "userList" : [{
        "id" : 3
    }]
  }]
}