Class GroupWebService

java.lang.Object
org.apache.openmeetings.webservice.BaseWebService
org.apache.openmeetings.webservice.GroupWebService

@Service("groupWebService") @Produces("application/json") @Path("/group") public class GroupWebService extends BaseWebService
The Service contains methods to login and create hash to directly enter conference rooms, recordings or the application in general
Author:
sebawagner
  • Constructor Details

    • GroupWebService

      public GroupWebService()
  • Method Details

    • add

      @POST @Path("/") public ServiceResult add(@QueryParam("sid") String sid, @QueryParam("name") String name) throws ServiceException
      add a new group
      Parameters:
      sid - The SID from getSession
      name - the name of the group
      Returns:
      ServiceResult with result type, and id of the group added
      Throws:
      ServiceException
    • get

      @GET @Path("/") public List<GroupDTO> get(@QueryParam("sid") String sid) throws ServiceException
      Get the list of all groups
      Parameters:
      sid - The SID from getSession
      Returns:
      list of all groups
      Throws:
      ServiceException
    • addUser

      @POST @Path("/{id}/users/{userid}") public ServiceResult addUser(@QueryParam("sid") String sid, @PathParam("id") Long id, @PathParam("userid") Long userid) throws ServiceException
      Add USER to a certain group
      Parameters:
      sid - The SID from getSession
      userid - the USER id
      id - the group id
      Returns:
      ServiceResult with result type, and id of the USER added, or error id in case of the error as text
      Throws:
      ServiceException
    • removeUser

      @DELETE @Path("/{id}/users/{userid}") public ServiceResult removeUser(@QueryParam("sid") String sid, @PathParam("id") Long id, @PathParam("userid") Long userid) throws ServiceException
      Remove USER from a certain group
      Parameters:
      sid - The SID from getSession
      userid - the USER id
      id - the group id
      Returns:
      ServiceResult with result type, and id of the USER removed, or error id in case of the error as text
      Throws:
      ServiceException
    • addRoom

      @POST @Path("/{id}/rooms/add/{roomid}") public ServiceResult addRoom(@QueryParam("sid") String sid, @PathParam("id") Long id, @PathParam("roomid") Long roomid) throws ServiceException
      Adds a room to an group
      Parameters:
      sid - - The SID of the User. This SID must be marked as Loggedin
      id - - Id of group that the room is being paired with
      roomid - - Id of room to be added
      Returns:
      ServiceResult with result type
      Throws:
      ServiceException
    • getUsers

      @GET @Path("/users/{id}") public UserSearchResult getUsers(@QueryParam("sid") String sid, @PathParam("id") long id, @QueryParam("start") int start, @QueryParam("max") int max, @QueryParam("orderby") String orderby, @QueryParam("asc") boolean asc) throws ServiceException
      Search users and return them
      Parameters:
      sid - The SID from getSession
      id - the group id
      start - first record
      max - max records
      orderby - orderby clause
      asc - asc or desc
      Returns:
      - users found
      Throws:
      ServiceException
    • delete

      @DELETE @Path("/{id}") public ServiceResult delete(@QueryParam("sid") String sid, @PathParam("id") long id) throws ServiceException
      Deletes a group
      Parameters:
      sid - The SID of the User. This SID must be marked as Loggedin
      id - the id of the group
      Returns:
      ServiceResult with result type
      Throws:
      ServiceException