org.phenotips.data.rest

Interface PatientsResource

public interface PatientsResource

Root resource for working with patient records.

Since:

1.2M5

Version:

$Id: 2081e417bc01fcc1d2838d828c4b2c9538626271 $

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addPatient(String json) Import a new patient from its JSON representation.
Patients	listPatients(Integer start, Integer number, String orderField, String order)

Method Detail

addPatient

javax.ws.rs.core.Response addPatient(String json)

Import a new patient from its JSON representation.

Parameters:

json - the JSON representation of the new patient to add

Returns:

the location of the newly created patient if the operation was successful, or an error report otherwise

listPatients

Patients listPatients(Integer start,
                    Integer number,
                    String orderField,
                    String order)

Parameters:

start - for large result set paging, the index of the first patient to display in the returned page

number - for large result set paging, how many patients to display in the returned page

orderField - field used for ordering the patients, can be one of id (default) or eid

order - the sorting order, can be one of asc (default) or desc

Returns:

a list of patient records