Interface RoomMembershipApi


  • @Path("/")
    public interface RoomMembershipApi
    Pod API

    This document refers to Symphony API calls that do not need encryption or decryption of content. - sessionToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have made no change to the system even if ome subset of the request would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X.

    • Method Detail

      • v1AdminRoomIdMembershipAddPost

        @POST
        @Path("/v1/admin/room/{id}/membership/add")
        @Consumes("application/json")
        @Produces("application/json")
        SuccessResponse v1AdminRoomIdMembershipAddPost​(UserId body,
                                                       @HeaderParam("sessionToken")
                                                       String sessionToken,
                                                       @PathParam("id")
                                                       String id)
        Add a member to an existing room.
      • v1AdminRoomIdMembershipListGet

        @GET
        @Path("/v1/admin/room/{id}/membership/list")
        @Produces("application/json")
        MembershipList v1AdminRoomIdMembershipListGet​(@PathParam("id")
                                                      String id,
                                                      @HeaderParam("sessionToken")
                                                      String sessionToken,
                                                      @QueryParam("includePastMembers")
                                                      Boolean includePastMembers)
        Lists current and previous members of an existing room.
      • v1AdminRoomIdMembershipRemovePost

        @POST
        @Path("/v1/admin/room/{id}/membership/remove")
        @Consumes("application/json")
        @Produces("application/json")
        SuccessResponse v1AdminRoomIdMembershipRemovePost​(UserId body,
                                                          @HeaderParam("sessionToken")
                                                          String sessionToken,
                                                          @PathParam("id")
                                                          String id)
        Remove a member from a room.
      • v1RoomIdMembershipAddPost

        @POST
        @Path("/v1/room/{id}/membership/add")
        @Consumes("application/json")
        @Produces("application/json")
        SuccessResponse v1RoomIdMembershipAddPost​(UserId body,
                                                  @HeaderParam("sessionToken")
                                                  String sessionToken,
                                                  @PathParam("id")
                                                  String id)
        Adds new member to an existing room.
      • v1RoomIdMembershipDemoteOwnerPost

        @POST
        @Path("/v1/room/{id}/membership/demoteOwner")
        @Consumes("application/json")
        @Produces("application/json")
        SuccessResponse v1RoomIdMembershipDemoteOwnerPost​(UserId body,
                                                          @HeaderParam("sessionToken")
                                                          String sessionToken,
                                                          @PathParam("id")
                                                          String id)
        Demotes room owner.
      • v1RoomIdMembershipListGet

        @GET
        @Path("/v1/room/{id}/membership/list")
        @Produces("application/json")
        MembershipList v1RoomIdMembershipListGet​(@PathParam("id")
                                                 String id,
                                                 @HeaderParam("sessionToken")
                                                 String sessionToken)
        Lists the members of an existing room. Lists the members of an existing room. If the requesting user is an administrator, lists current and previous members. If the requesting user is a regular user, lists only current members.
      • v1RoomIdMembershipPromoteOwnerPost

        @POST
        @Path("/v1/room/{id}/membership/promoteOwner")
        @Consumes("application/json")
        @Produces("application/json")
        SuccessResponse v1RoomIdMembershipPromoteOwnerPost​(UserId body,
                                                           @HeaderParam("sessionToken")
                                                           String sessionToken,
                                                           @PathParam("id")
                                                           String id)
        Promotes user to owner.
      • v1RoomIdMembershipRemovePost

        @POST
        @Path("/v1/room/{id}/membership/remove")
        @Consumes("application/json")
        @Produces("application/json")
        SuccessResponse v1RoomIdMembershipRemovePost​(UserId body,
                                                     @HeaderParam("sessionToken")
                                                     String sessionToken,
                                                     @PathParam("id")
                                                     String id)
        Removes member from an existing room.
      • v2RoomIdMembershipListGet

        @GET
        @Path("/v2/room/{id}/membership/list")
        @Produces("application/json")
        MembershipList v2RoomIdMembershipListGet​(@PathParam("id")
                                                 String id,
                                                 @HeaderParam("sessionToken")
                                                 String sessionToken)
        Lists current members of an existing room.