Package com.symphony.api.pod

Interface DisclaimerApi

@Path("/")
public interface DisclaimerApi

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 Summary

Modifier and Type	Method	Description
Disclaimer	v1AdminDisclaimerDidGet(String sessionToken, String did)	Get a disclaimer by disclaimer id
UserIdList	v1AdminDisclaimerDidUsersGet(String sessionToken, String did)	List all users assigned to this disclaimer
DisclaimerList	v1AdminDisclaimerListGet(String sessionToken)	List all disclaimers for the company (pod)

Method Detail

v1AdminDisclaimerDidGet

@GET
@Path("/v1/admin/disclaimer/{did}")
@Produces("application/json")
Disclaimer v1AdminDisclaimerDidGet(@HeaderParam("sessionToken")
                                   String sessionToken,
                                   @PathParam("did")
                                   String did)

Get a disclaimer by disclaimer id

v1AdminDisclaimerDidUsersGet

@GET
@Path("/v1/admin/disclaimer/{did}/users")
@Produces("application/json")
UserIdList v1AdminDisclaimerDidUsersGet(@HeaderParam("sessionToken")
                                        String sessionToken,
                                        @PathParam("did")
                                        String did)

List all users assigned to this disclaimer

v1AdminDisclaimerListGet

@GET
@Path("/v1/admin/disclaimer/list")
@Produces("application/json")
DisclaimerList v1AdminDisclaimerListGet(@HeaderParam("sessionToken")
                                        String sessionToken)

List all disclaimers for the company (pod)