URI
<department_uri>/members[.<format>]
支持的方法
父资源
介绍
departmentMembers 资源是单个部门的成员列表信息。通过 GET 请求可以获取单个部门的成员列表信息;通过 POST 请求可以向部门中添加成员,支持批量添加;通过 PUT 请求,可以模拟 DELETE,移除部门中的成员,支持批量移除,移除的用户不再是该部门的成员,但该用户并没有从门户中删除。
支持的方法:
- GET:获取单个部门的成员列表信息。
- POST:向部门中添加成员,支持批量添加。
- PUT:移除部门中的成员,支持批量移除,移除的用户不再是该部门的成员,但该用户并没有从门户中删除。
- HEAD:检查 departmentMembers 资源是否存在,或权限是否可以访问 departmentMembers 资源。
支持的表述格式:RJSON、JSON、HTML、XML。
资源层次
HTTP 请求方法
对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/manager/iportalconfig/departments/{departmentId}/members.rjson
GET 请求
获取单个部门的成员列表信息。
请求参数
发送请求时,需要在请求体中包含如下参数, 请求参数必须包含在 URI 中。
名称 | 类型 | 含义 |
isReturnRoles | boolean | 【必选参数】是否返回部门成员的角色信息。 |
响应结构
对 departmentMembers 资源执行 GET 请求,返回单个部门的成员列表信息,其中单个成员的表述结构如下:
字段 | 类型 | 说明 |
id | Integer | 标识字段。 |
departmentId | Integer | 所属部门的 ID。 |
userName | String | 部门成员的名称。 |
nickname | String | 部门成员的昵称。 |
roles | String[] | 部门成员的角色。 |
响应示例
获取带有角色信息的单个部门的成员列表信息,则需设置 isReturnRoles=true,即对 departmentMembers 资源:http://localhost:8190/iportal/manager/iportalconfig/departments/4/members.rjson?isReturnRoles=true 执行 GET 请求,返回 rjson 格式的资源表述如下:
[
{
"departmentId": 4,
"roles": [
"PORTAL_USER",
"DATA_CENTER"
],
"nickname": "zhangsy",
"id": 9,
"userName": "zhangsy"
},
{
"departmentId": 4,
"roles": [
"PORTAL_USER",
"DATA_CENTER"
],
"nickname": "Raine",
"id": 36,
"userName": "Raine"
},
{
"departmentId": 4,
"roles": [
"PORTAL_USER",
"DATA_CENTER"
],
"nickname": "qinlj",
"id": 71,
"userName": "qinlj"
}
]
POST 请求
向部门中添加成员,支持批量添加。发送请求体时,请求体中需传递成员的名称数组。
响应结构
返回的资源表述结构如下:
字段 | 类型 | 说明 |
postResultType | PostResultType | 向部门添加成员。 |
succeed | boolean | 添加成员是否成功。 |
响应示例
对 departmentMembers 资源:http://localhost:8190/iportal/manager/iportalconfig/departments/4/members.rjson 执行 POST 请求,向部门中添加成员,发送请求体如下:
[
"liyl",
"xiaoli"
]
则返回的 rjson 格式的资源表述如下:
{
"postResultType": "CreateChild",
"succeed": true
}
PUT 请求
移除部门中的成员,支持批量移除,移除的用户不再是该部门的成员,但该用户并没有从门户中删除。发送请求体时,请求体中需传递需要移除的成员名称数组。
响应结构
返回的资源表述结构如下:
字段 | 类型 | 说明 |
succeed | boolean | 移除部门成员是否成功。 |
error | Httperror | 出错信息,如果移除部门成员成功,则没有本字段。 |
响应示例
对 departmentMembers 资源:http://localhost:8190/iportal/manager/iportalconfig/departments/4/members.rjson 执行 PUT 请求,移除部门中的成员,发送请求体如下:
[
"liyl",
"xiaoli"
]
则返回的 rjson 格式的资源表述如下:
{"succeed": true}
HEAD 请求
返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。
HEAD 请求可以用来判断 departmentMembers 资源是否存在,或者客户端是否有权限访问 departmentMembers 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 departmentMembers 资源是否支持<format>格式的表述。