org.phenotips.data.permissions.rest

Interface CollaboratorsResource

@Role
 @Relation(value="https://phenotips.org/rel/collaborators")
 @ParentResource(value=PermissionsResource.class)
 @RelatedResources(value=org.phenotips.data.rest.PatientResource.class)
public interface CollaboratorsResource

Resource for working with entity record collaborators, in bulk, where entities are identified by entity record's internal PhenoTips identifier.

Since:

1.3M2

Version:

$Id: dd60a29029a6c5a45f32b977ba604c6ab42f8849 $

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addCollaborators(CollaboratorsRepresentation collaborators, String entityId, String entityType) Add new collaborators, or update the permission levels of existing collaborators.
javax.ws.rs.core.Response	addCollaborators(String entityId, String entityType) Add new collaborators, or update the permission levels of existing collaborators.
javax.ws.rs.core.Response	deleteAllCollaborators(String entityId, String entityType) Delete all collaborators.
CollaboratorsRepresentation	getCollaborators(String entityId, String entityType) Retrieve information about the collaborators.
javax.ws.rs.core.Response	setCollaborators(CollaboratorsRepresentation collaborators, String entityId, String entityType) Update all collaborators, replacing all previous collaborators.

Method Detail

getCollaborators

CollaboratorsRepresentation getCollaborators(String entityId,
                                             String entityType)

Retrieve information about the collaborators. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to view the target entity record, an error is returned.

Parameters:

entityId - internal identifier of an entity record

entityType - the type of entity (either "patients" or "families")

Returns:

REST representation of a collection of collaborators

addCollaborators

@PATCH
javax.ws.rs.core.Response addCollaborators(CollaboratorsRepresentation collaborators,
                                                  String entityId,
                                                  String entityType)

Add new collaborators, or update the permission levels of existing collaborators. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to manage the target entity record, no change is performed and an error is returned.

Parameters:

collaborators - a list of collaborators to modify, each of which must have id and level properties

entityId - internal identifier of an entity record

entityType - the type of entity (either "patients" or "families")

Returns:

a status message

addCollaborators

@PATCH
javax.ws.rs.core.Response addCollaborators(String entityId,
                                                  String entityType)

Add new collaborators, or update the permission levels of existing collaborators. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to manage the target entity record, no change is performed and an error is returned. The request data must contain properties "collaborator" and "level". Multiple values are accepted, if an equal number of values is received for both properties, and they are paired in the order that they appear in the request. Data can be sent both in the request body and in the query string, with the latter taking precedence over the former. If an unequal number of parameter values is received, then no change is performed and an error is returned.

Parameters:

entityId - internal identifier of an entity record

entityType - the type of entity (either "patients" or "families")

Returns:

a status message

setCollaborators

javax.ws.rs.core.Response setCollaborators(CollaboratorsRepresentation collaborators,
                                           String entityId,
                                           String entityType)

Update all collaborators, replacing all previous collaborators. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to manage the target entity record, no change is performed and an error is returned.

Parameters:

collaborators - a list of collaborators, each of which must have id and level properties

entityId - internal identifier of an entity record

entityType - the type of entity (either "patients" or "families")

Returns:

a status message

deleteAllCollaborators

javax.ws.rs.core.Response deleteAllCollaborators(String entityId,
                                                 String entityType)

Delete all collaborators. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to manage the target entity record, no change is performed and an error is returned.

Parameters:

entityId - internal identifier of an entity record

entityType - the type of entity (either "patients" or "families")

Returns:

a status message