groupMembers


URI

<group_uri>/members[.<format>]

支持的方法

GETDELETEHEAD

父资源

group

子资源

groupMembergroupMembersApplygroupMembersInvite

介绍

groupMembers 资源是单个群组成员列表信息,支持批量删除群组成员信息,群组创建者(确保处于登录状态)可以删除群组成员,群组成员(确保处于登录状态)也可以自己退出该群组,退出群组的同时,该成员分享到群组中的资源也一并移除。

支持的方法:

支持的表述格式:RJSON、JSON、HTML、XML。

资源层次

HTTP 请求方法

对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiportal 是服务器名。

http://supermapiportal:8190/iportal/web/groups/{id}/members.rjson

GET 请求

获取指定群组的成员列表信息。

响应结构

对 groupMembers 资源执行 GET 请求,获取指定群组的成员列表信息,由以下字段组成:

字段 类型 说明
content List<GroupMember> 页面内容。
currentPage int 当前第几页。
pageSize int 每页大小。
searchParameter SearchParameter 当前页搜索参数。
total int 总记录数。
totalPage int 总页数。

响应示例

对 groupMembers 资源:http://localhost:8190/iportal/web/groups/1/members.rjson 执行 GET 请求,获取指定群组的成员列表信息,返回的 rjson 资源表述结构如下:

{

    "content": [

        {

            "groupId": 1,

            "groupRole": "CREATOR",

            "id": 1,

            "joinTime": 1416984287897,

            "memberDescription": null,

            "nickname": "admin",

            "roleUpdateTime": null,

            "userName": "admin"

        },

        {

            "groupId": 1,

            "groupRole": "MEMBER",

            "id": 5,

            "joinTime": 1416984478118,

            "memberDescription": null,

            "nickname": "wanghl",

            "roleUpdateTime": null,

            "userName": "xiaowang"

        },

        {

            "groupId": 1,

            "groupRole": "MEMBER",

            "id": 7,

            "joinTime": 1416984601991,

            "memberDescription": null,

            "nickname": "liyl",

            "roleUpdateTime": null,

            "userName": "xiaoli"

        }

    ],

    "currentPage": 1,

    "pageSize": 9,

    "searchParameter": {

        "currentPage": 1,

        "currentUser": null,

        "groupId": 1,

        "groupRole": null,

        "keywords": null,

        "orderBy": null,

        "orderType": "ASC",

        "pageSize": 9,

        "userName": null

    },

    "total": 3,

    "totalPage": 1

}

DELETE 请求

批量删除指定用户名的群组成员,群组创建者(确保处于登录状态)可删除群组成员,群组成员(确保处于登录状态)也可以自己退出该群,url 中传递需要删除的群组成员名称数组。

响应结构

返回的资源表述结构如下:

字段 类型 说明
succeed boolean 删除群组成员(或群组成员自己退群)是否成功。
error Httperror 出错信息,如果删除群组成员(或群组成员自己退群)成功,则没有本字段。

响应示例

对 groupMembers 资源:http://localhost:8190/iportal/groups/6/members.rjson?userNames=["xiaoming","xiaoming2"] 执行 DELETE 请求,批量删除 userName 为 xiaoming 和 xiaoming2 的两个群组成员,返回的 rjson 格式响应结果如下:

{ "succeed": true}

HEAD 请求

返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。

HEAD 请求可以用来判断 groupMembers 资源是否存在,或者客户端是否有权限访问 groupMembers 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 groupMembers 资源是否支持<format>格式的表述。

请参见