@Produces(value="application/json") @Path(value="/group") public class GroupWebService extends Object
Constructor and Description |
---|
GroupWebService() |
Modifier and Type | Method and Description |
---|---|
ServiceResult |
add(String sid,
String name)
add a new group
|
ServiceResult |
addRoom(String sid,
Long id,
Long roomid)
Adds a room to an group
|
ServiceResult |
addUser(String sid,
Long id,
Long userid)
Add user to a certain group
|
ServiceResult |
delete(String sid,
long id)
Deletes a group
|
List<Group> |
get(String sid)
Get the list of all groups
|
UserSearchResult |
getUsers(String sid,
long id,
int start,
int max,
String orderby,
boolean asc)
Search users and return them
|
ServiceResult |
removeUser(String sid,
Long id,
Long userid)
Remove user from a certain group
|
@POST @Path(value="/") public ServiceResult add(@QueryParam(value="sid") String sid, @QueryParam(value="name") String name) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID from getSessionname
- the name of the grouporg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/") public List<Group> get(@QueryParam(value="sid") String sid) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID from getSessionorg.apache.openmeetings.webservice.error.ServiceException
@POST @Path(value="/{id}/users/{userid}") public ServiceResult addUser(@QueryParam(value="sid") String sid, @PathParam(value="id") Long id, @PathParam(value="userid") Long userid) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID from getSessionuserid
- the user idid
- the group idorg.apache.openmeetings.webservice.error.ServiceException
@DELETE @Path(value="/{id}/users/{userid}") public ServiceResult removeUser(@QueryParam(value="sid") String sid, @PathParam(value="id") Long id, @PathParam(value="userid") Long userid) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID from getSessionuserid
- the user idid
- the group idorg.apache.openmeetings.webservice.error.ServiceException
@POST @Path(value="/{id}/rooms/add/{roomId}") public ServiceResult addRoom(@QueryParam(value="sid") String sid, @PathParam(value="id") Long id, @PathParam(value="roomid") Long roomid) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- - The SID of the User. This SID must be marked as Loggedinid
- - Id of group that the room is being paired withroomid
- - Id of room to be addedorg.apache.openmeetings.webservice.error.ServiceException
@GET @Path(value="/users/{id}") public UserSearchResult getUsers(@QueryParam(value="sid") String sid, @PathParam(value="id") long id, @QueryParam(value="start") int start, @QueryParam(value="max") int max, @QueryParam(value="orderby") String orderby, @QueryParam(value="asc") boolean asc) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID from getSessionid
- the group idstart
- first recordmax
- max recordsorderby
- orderby clauseasc
- asc or descorg.apache.openmeetings.webservice.error.ServiceException
@DELETE @Path(value="/{id}") public ServiceResult delete(@QueryParam(value="sid") String sid, @PathParam(value="id") long id) throws org.apache.openmeetings.webservice.error.ServiceException
sid
- The SID of the User. This SID must be marked as Loggedinid
- the id of the group{@link
- ServiceException} in case of any errororg.apache.openmeetings.webservice.error.ServiceException
Copyright © 2012–2017 Apache Software Foundation. All rights reserved.