org.phenotips.data.permissions.rest

Interface CollaboratorResource

@Relation(value="https://phenotips.org/rel/collaborator")
 @ParentResource(value=CollaboratorsResource.class)
 @RelatedResources(value={PermissionsResource.class,org.phenotips.data.rest.PatientResource.class})
public interface CollaboratorResource

Resource for working with entity record collaborators, one at a time. Collaborators are found by both the internal entity identifier and the internal collaborator identifier.

Since:

1.3M2

Version:

$Id: 3e0e7a434898adc6b22981a6f7a2f6e39659a3a8 $

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteCollaborator(String entityId, String entityType, String collaboratorId) Remove a particular collaborator from an entity record.
CollaboratorRepresentation	getCollaborator(String entityId, String entityType, String collaboratorId) Retrieve information about a particular collaborator.
javax.ws.rs.core.Response	setLevel(CollaboratorRepresentation collaborator, String entityId, String entityType, String collaboratorId) Update the access level of a collaborator.
javax.ws.rs.core.Response	setLevel(String entityId, String entityType, String collaboratorId) Update the access level of a collaborator.

Method Detail

getCollaborator

CollaboratorRepresentation getCollaborator(String entityId,
                                           String entityType,
                                           String collaboratorId)

Retrieve information about a particular collaborator. If the indicated entity record doesn't exist, or if the indicated principal is not a collaborator, 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")

collaboratorId - internal id of a principal, ideally fully qualified, (ex. xwiki:XWiki.JohnDoe)

Returns:

REST representation of a single collaborator

setLevel

javax.ws.rs.core.Response setLevel(CollaboratorRepresentation collaborator,
                                   String entityId,
                                   String entityType,
                                   String collaboratorId)

Update the access level of a collaborator. If the targeted principal wasn't a collaborator before, then it is added as one. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to edit the target entity record, or if no access level is sent, or if the requested access level isn't valid, then no change is performed and an error is returned.

Parameters:

collaborator - a collaborator representation, must contain the "level" property, with a value which is a valid access level; all other properties are ignored

entityId - internal identifier of an entity record

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

collaboratorId - internal id of a principal, ideally fully qualified, (ex. xwiki:XWiki.JohnDoe)

Returns:

a status message

setLevel

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

Update the access level of a collaborator. If the targeted principal wasn't a collaborator before, then it is added as one. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to edit the target entity record, or if no access level is sent, or if the requested access level isn't valid, then no change is performed and an error is returned. The request must contain a "level" property, with a value which is a valid access level.

Parameters:

entityId - internal identifier of an entity record

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

collaboratorId - internal id of a principal, ideally fully qualified, (ex. xwiki:XWiki.JohnDoe)

Returns:

a status message

deleteCollaborator

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

Remove a particular collaborator from an entity record. If the indicated entity record doesn't exist, or if the user sending the request doesn't have the right to edit the target entity record, or if the requested collaborator isn't actually a collaborator, 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")

collaboratorId - internal id of a principal, ideally fully qualified, (ex. xwiki:XWiki.JohnDoe)

Returns:

a status message