Interface ConnectionApi


  • @Path("/")
    public interface ConnectionApi
    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

      • v1ConnectionAcceptPost

        @POST
        @Path("/v1/connection/accept")
        @Consumes("application/json")
        @Produces("application/json")
        UserConnection v1ConnectionAcceptPost​(UserConnectionRequest body,
                                              @HeaderParam("sessionToken")
                                              String sessionToken)
        Accept the connection request for the requesting user
      • v1ConnectionCreatePost

        @POST
        @Path("/v1/connection/create")
        @Consumes("application/json")
        @Produces("application/json")
        UserConnection v1ConnectionCreatePost​(UserConnectionRequest body,
                                              @HeaderParam("sessionToken")
                                              String sessionToken)
        Sends an invitation to connect with another user
      • v1ConnectionListGet

        @GET
        @Path("/v1/connection/list")
        @Produces("application/json")
        UserConnectionList v1ConnectionListGet​(@HeaderParam("sessionToken")
                                               String sessionToken,
                                               @QueryParam("status")
                                               String status,
                                               @QueryParam("userIds")
                                               String userIds)
        List of requesting user's connection This retrieves all connections of the requesting user. (i.e. both connections in which the requesting user is the sender and those in which the requesting user is the inivtee) By default, if you haven't specified the connection status to filter on, this call will only return results for both \"pending_incoming\" and \"pending_outgoing\". You can optionally filter by userIds to further restrict the results of a specific connection status. If the users are in the same private pod, the users have an implicit connection status of \"accepted\". Those users will not be returned in the response if you don't specify the connection status as \"accepted\" (default is \"pending\") and the explicit userIds in the request.
      • v1ConnectionRejectPost

        @POST
        @Path("/v1/connection/reject")
        @Consumes("application/json")
        @Produces("application/json")
        UserConnection v1ConnectionRejectPost​(UserConnectionRequest body,
                                              @HeaderParam("sessionToken")
                                              String sessionToken)
        Reject the connection request for the requesting user. Reject the connection between the requesting user and request sender. If both users are in the same private pod, an error will be returned because both users have an implicit connection which cannot be rejected.
      • v1ConnectionUserUidRemovePost

        @POST
        @Path("/v1/connection/user/{uid}/remove")
        @Produces("application/json")
        SuccessResponse v1ConnectionUserUidRemovePost​(@HeaderParam("sessionToken")
                                                      String sessionToken,
                                                      @PathParam("uid")
                                                      Long uid)
        Removes a connection with a user.
      • v1ConnectionUserUserIdInfoGet

        @GET
        @Path("/v1/connection/user/{userId}/info")
        @Produces("application/json")
        UserConnection v1ConnectionUserUserIdInfoGet​(@HeaderParam("sessionToken")
                                                     String sessionToken,
                                                     @PathParam("userId")
                                                     String userId)
        The status of the connection invitation to another user.