groupsInvite


URI

<groups_uri>/inviteinfo[.<format>]

支持的方法

GETPUTHEAD

父资源

groups

介绍

groupsInvite 资源是群组邀请资源,支持获取当前用户相关的邀请列表信息,支持更新多个群组的邀请状态。

支持的方法:

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

资源层次

HTTP 请求方法

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

http://supermapiportal:8190/iportal/web/groups/inviteinfo.rjson

GET 请求

获取当前用户相关的邀请列表信息。

请求参数

如果参数未设置,则返回当前用户相关的所有邀请列表信息,设置参数后,会返回当前用户指定的邀请列表信息,请求参数必须包含在 URI 中。

名称 类型 含义
currentPage int 根据当前第几页查询。
pageSize int 根据每页大小查询。
feedbackStatus FeedbackStatus 根据反馈状态查询。反馈状态包含:WAITING(等待中)、ACCEPTED(同意加入)、REFUSED(拒绝加入)
orderType OrderType 根据排序时升降序查询。
orderBy InviteOrderby 根据排序类型查询。
groupInviteRole GroupInviteRole 根据群组邀请角色类型查询。

响应结构

对 groupsInvite 资源执行 GET 请求,返回当前用户相关的邀请列表信息。由以下字段组成:

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

响应示例

对 groupsInvite 资源:http://localhost:8190/iportal/web/groups/inviteinfo.rjson 执行 GET 请求,返回 rjson 格式的资源表述如下:

{

    "content": [

        {

            "feedbackInfo": null,

            "feedbackStatus": "WAITING",

            "feedbackTime": null,

            "groupId": 1,

            "groupName": "FA",

            "id": 1,

            "inviteReason": "",

            "inviteTime": 1415157749401,

            "invitee": "wanghl",

            "inviter": "admin"

        },

        {

            "feedbackInfo": null,

            "feedbackStatus": "WAITING",

            "feedbackTime": null,

            "groupId": 2,

            "groupName": "iPortal",

            "id": 2,

            "inviteReason": "",

            "inviteTime": 1415157824592,

            "invitee": "wanghl",

            "inviteeNick": "xiaowang",

            "inviter": "iportal",

            "inviterNick": "iportal"

        }

    ],

    "currentPage": 1,

    "pageSize": 9,

    "searchParameter": null,

    "total": 2,

    "totalPage": 1

}

如果希望获取指定的邀请列表信息,如根据群组邀请角色类型和反馈状态过滤,则需要设置 groupInviteRole=INVITEE&feedbackStatus=WAITING,即对 groupsInvite 资源:http://localhost:8190/iportal/web/groups/inviteinfo.rjson?groupInviteRole=INVITEE&feedbackStatus=WAITING 执行 GET 请求,返回的 rjson 格式的资源表述如下:

{

    "content": [

        {

            "feedbackInfo": null,

            "feedbackStatus": "WAITING",

            "feedbackTime": null,

            "groupId": 1,

            "groupName": "FA",

            "id": 1,

            "inviteReason": "",

            "inviteTime": 1415157749401,

            "invitee": "wanghl",

            "inviter": "admin"

        },

        {

            "feedbackInfo": null,

            "feedbackStatus": "WAITING",

            "feedbackTime": null,

            "groupId": 2,

            "groupName": "iPortal",

            "id": 2,

            "inviteReason": "",

            "inviteTime": 1415157824592,

            "invitee": "wanghl",

            "inviteeNick": "xiaowang",

            "inviter": "iportal",

            "inviterNick": "iportal"

        }

    ],

    "currentPage": 1,

    "pageSize": 9,

    "searchParameter": null,

    "total": 2,

    "totalPage": 1

}

PUT 请求

更新多个群组的邀请状态。

请求参数

发送请求时,需要在请求体中传递如下参数:

名称 类型 含义
ids List<Integer> 邀请 id。
feedbackStatus FeedbackStatus 反馈状态,只能是 ACCEPTED 或者是 REFUSED。
feedbackInfo String 反馈信息。

响应结构

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

字段 类型 说明
succeed boolean 更新群组邀请状态是否成功。
error Httperror 出错信息,如果更新群组邀请状态成功,则没有本字段。

响应示例

对 groupsInvite  资源:http://localhost:8190/iportal/web/groups/inviteinfo.rjson 执行 PUT 请求,更新多个群组邀请状态,发送请求体如下:

{

    "ids": [1,2],

    "feedbackStatus": "ACCEPTED",

    "feedbackInfo": "ACCEPTED"

}

则返回的 rjson 格式响应结果如下:

{"succeed": true}

HEAD 请求

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

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

请参见