org.phenotips.data.rest

Interface PatientResource

public interface PatientResource

Resource for working with patient records, identified by their internal PhenoTips identifier.

Since:

1.2M5

Version:

$Id: 03ec5c21ea7d54d47365aa5c3b0ab5d52e0bc122 $

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deletePatient(String id) Delete a patient record, identified by its internal PhenoTips identifier.
javax.ws.rs.core.Response	getPatient(String id) Retrieve a patient record, identified by its internal PhenoTips identifier, in its JSON representation.
javax.ws.rs.core.Response	updatePatient(String json, String id) Update a patient record, identified by its internal PhenoTips identifier, from its JSON representation.

Method Detail

getPatient

javax.ws.rs.core.Response getPatient(String id)

Retrieve a patient record, identified by its internal PhenoTips identifier, in its JSON representation. If the indicated patient record doesn't exist, or if the user sending the request doesn't have the right to view the target patient record, an error is returned.

Parameters:

id - the patient's internal identifier, see Patient.getId()

Returns:

the JSON representation of the requested patient, or a status message in case of error

updatePatient

javax.ws.rs.core.Response updatePatient(String json,
                                      String id)

Update a patient record, identified by its internal PhenoTips identifier, from its JSON representation. If the indicated patient record doesn't exist, or if the user sending the request doesn't have the right to edit the target patient record, no change is performed and an error is returned. If a field is set in the patient record, but missing in the JSON, then that field is not changed.

Parameters:

json - the JSON representation of the new patient to add

id - the patient's internal identifier, see Patient.getId()

Returns:

a status message

deletePatient

javax.ws.rs.core.Response deletePatient(String id)

Delete a patient record, identified by its internal PhenoTips identifier. If the indicated patient record doesn't exist, or if the user sending the request doesn't have the right to delete the target patient record, no change is performed and an error is returned.

Parameters:

id - the patient's internal identifier, see Patient.getId()

Returns:

a status message