<groupMembers_uri>/applyinfo[.<format>]
groupMembersApply 资源是用户申请加入单个群组的请求列表信息。支持群组创建者(确保处于登录状态)获取当前群组中的申请列表信息,支持用户申请加入群组,支持群组创建者(确保处于登录状态)批量审核当前群组中的申请列表。
支持的方法:
支持的表述格式:RJSON、JSON、HTML、XML。
对如下 URI 执行 HTTP 请求,以 rjson 输出格式为例加以说明,其中,supermapiportal 是服务器名。
http://supermapiportal:8190/iportal/web/groups/{id}/members/applyinfo.rjson
获取当前群组中的申请列表信息。包括申请的,审核过的,有权限审核的。
如果参数未设置,则返回当前群组中的所有申请列表信息,设置参数后,会返回当前群组中指定的申请列表信息,请求参数必须包含在 URI 中。
名称 | 类型 | 含义 |
currentPage | int | 根据当前第几页查询。 |
pageSize | int | 根据每页大小查询。 |
checkStatus | GroupCheckStatus | 根据群组审核状态查询。 |
orderType | OrderType | 根据排序时升降序查询。 |
对 groupMembersApply 资源执行 GET 请求,返回当前群组中的申请列表信息。由以下字段组成:
字段 | 类型 | 说明 |
content | List<GroupApplyInfo> | 页面内容。 |
currentPage | int | 当前第几页。 |
pageSize | int | 每页大小。 |
searchParameter | SearchParameter | 当前页搜索参数。 |
total | int | 总记录数。 |
totalPage | int | 总页数。 |
对 groupMembersApply 资源:http://localhost:8190/iportal/web/groups/3/members/applyinfo.rjson 执行 GET 请求,获取当前群组 FB 中的所有申请列表信息,返回 rjson 格式的资源表述如下:
{
"content": [
{
"applicant": "wanghl",
"applicantNick": "xiaowang",
"applyReason": "工作",
"applyTime": 1415264407787,
"checkInfo": null,
"checkStatus": "WAITING",
"checkTime": 1415264407787,
"checkUser": "null",
"checkUserNick": "null",
"groupId": 3,
"groupName": "FB",
"id": 14
},
{
"applicant": "iportal",
"applicantNick": "iportal",
"applyReason": "工作",
"applyTime": 1415264449699,
"checkInfo": null,
"checkStatus": "WAITING",
"checkTime": 1415264449699,
"checkUser": "null",
"checkUserNick": "null",
"groupId": 3,
"groupName": "FB",
"id": 15
}
],
"currentPage": 1,
"pageSize": 0,
"searchParameter": null,
"total": 2,
"totalPage": 0
}
如果希望获取指定的申请列表信息,如根据排序和群组审核状态过滤,则需要设置 orderType=ASC&checkStatus=WAITING,即对 groupMembersApply 资源:http://localhost:8190/iportal/web/groups/3/members/applyinfo.rjson?orderType=ASC&checkStatus=WAITING 执行 GET 请求,返回的 rjson 格式的资源表述如下:
{
"content": [
{
"applicant": "wanghl",
"applicantNick": "xiaowang",
"applyReason": "工作",
"applyTime": 1415264407787,
"checkInfo": null,
"checkStatus": "WAITING",
"checkTime": 1415264407787,
"checkUser": "null",
"checkUserNick": "null",
"groupId": 3,
"groupName": "FB",
"id": 14
},
{
"applicant": "iportal",
"applicantNick": "iportal",
"applyReason": "工作",
"applyTime": 1415264449699,
"checkInfo": null,
"checkStatus": "WAITING",
"checkTime": 1415264449699,
"checkUser": "null",
"checkUserNick": "null",
"groupId": 3,
"groupName": "FB",
"id": 15
}
],
"currentPage": 1,
"pageSize": 0,
"searchParameter": null,
"total": 2,
"totalPage": 0
}
用户申请加入当前群组。如果群组不需要审核,可以直接申请并加入群组;如果群组需要审核,那么用户申请成功后,还需要群组创建者审核通过后,才能加入该群组。
发送请求时,需要在请求体中传递如下参数:
名称 | 类型 | 含义 |
groupIds | List<Integer> | 申请加入的群组 id。 |
applyReason | String | 申请加入群组的原因。 |
applicant | String | 申请人。 |
返回的资源表述结构如下:
字段 | 类型 | 说明 |
succeed | boolean | 群组申请是否成功。 |
error | Httperror | 出错信息,如果群组申请成功,则没有本字段。 |
对 groupMembersApply 资源:http://localhost:8190/iportal/web/groups/5/members/applyinfo.rjson 执行 POST 请求,申请加入当前群组,发送请求体如下:
{
"groupIds": [5],
"applyReason": "协同编辑",
"applicant": "wanghl"
}
则返回的 rjson 格式响应结果如下:
{"succeed": true}
批量审核当前群组中的申请,支持根据申请 id 审核指定的申请。
发送请求时,需要在请求体中传递如下参数:
名称 | 类型 | 含义 |
ids | List<Integer> | 申请 id。 |
checkInfo | String | 审核信息。 |
checkStatus | GroupCheckStatus | 审核结果。 |
返回的资源表述结构如下:
字段 | 类型 | 说明 |
succeed | boolean | 审核指定的群组申请是否成功。 |
error | Httperror | 出错信息,如果审核指定的群组申请成功,则没有本字段。 |
对 groupMembersApply 资源:http://localhost:8190/iportal/web/groups/5/members/applyinfo.rjson 执行 PUT 请求,批量审核当前群组中的申请,发送请求体如下:
{
"ids": [1,2],
"checkInfo": "ACCEPTED",
"checkStatus": "ACCEPTED"
}
则返回的 rjson 格式响应结果如下:
{"succeed": true}
返回跟 GET 请求一样的 HTTP 响应头,但是没有响应实体。可以在不必传输整个响应内容的情况下,获取包含在响应消息头中的元数据信息。元数据信息包括媒体类型,字符编码,压缩编码,实体内容长度等。
HEAD 请求可以用来判断 groupMembersApply 资源是否存在,或者客户端是否有权限访问 groupMembersApply 资源。通过对加.<format>的 URI 执行 HEAD 请求,还可以快速判断 groupMembersApply 资源是否支持<format>格式的表述。