org.phenotips.data.rest

Interface PatientByExternalIdResource

public interface PatientByExternalIdResource

Resource for working with patient records, identified by their given "external" identifier.

Since:

1.2M5

Version:

$Id: 429a57be9cf83dd263a7a5544a1cdf2a20562cd7 $

Method Summary

Methods

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

Method Detail

getPatient

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

Retrieve a patient record, identified by its given "external" 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. If multiple records exist with the same given identifier, a list of links to each such record is returned.

Parameters:

eid - the patient's given "external" identifier, see Patient.getExternalId()

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 eid)

Update a patient record, identified by its given "external" 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 multiple records exist with the same given identifier, no change is performed, and a list of links to each such record 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

eid - the patient's given "external" identifier, see Patient.getExternalId()

Returns:

a status message

deletePatient

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

Delete a patient record, identified by its given "external" identifier. 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 multiple records exist with the same given identifier, no change is performed, and a list of links to each such record is returned.

Parameters:

eid - the patient's given "external" identifier, see Patient.getExternalId()

Returns:

a status message