REST API

This page details the interface between the Client software (running in the patients/carers home) and the server software.

The following REST APIs will be available on the server:

URI	HTTP Method	Data	Operation	Description
/users/register	POST	User	create	Create a new user
/users	GET	User	retrieve	Get all users
/users/user_email={useremail}	GET	User	retrieve	Get information about user {useremail}
/users	POST	User	update	Update a users details
/users/connect/	POST	User Connect	create	Connect two users via their email addresses
/users/connect/user_email={useremail}	GET	User Connect	retrieve	Get a list of the users connected to the user {useremail}
/alerts/send	POST	Alert	create	Send an alert
/alerts/respond	POST		create	Send a response to an alert
/alerts/to/user_email={useremail}	GET	Alert	retrieve	get all alerts sent to user {useremail}
/alerts/from/user_email={useremail}	GET	Alert	retrieve	get all alerts sent from user {useremail}
/sensors/reading	POST	Sensor Reading	create	create a new sensor reading
/sensors/reading/user_email={useremail}	GET	Sensor Reading	retrieve	gets the sensor readings for user {useremail}

---

To pass objects to or retrieve objects from the server, the objects will be encoded as JSON objects. The advantage of JSON over XML is that it is slightly smaller and therefore the amount of data that needs to be distributed over the network is lessened.

---

Each object will have a JSON Schema to define how it will be converted to/from JSON.

---