REST API version 1 - Revision history

DonCruickshank at 15:50, 24 November 2025

2025-11-24T15:50:14Z

← Older revision		Revision as of 15:50, 24 November 2025
Line 1:		Line 1:
	''This REST API is for managing an intervention as a whole. A key provides API access to all participants and so it is		''This REST API is for managing an intervention as a whole. A key provides API access to all participants and so it is
	not suitable for participant devices to hold the key. For that scenario, see [[Participant ~~REST~~ API version 1]] for the		not suitable for participant devices to hold the key. For that scenario, see [[Participant API version 1]] for the
	API that provides access to a specific participant.''		API that provides access to a specific participant.''

DonCruickshank at 11:37, 24 November 2025

2025-11-24T11:37:52Z

← Older revision		Revision as of 11:37, 24 November 2025
Line 1:		Line 1:
			''This REST API is for managing an intervention as a whole. A key provides API access to all participants and so it is
			not suitable for participant devices to hold the key. For that scenario, see [[Participant REST API version 1]] for the
			API that provides access to a specific participant.''

	LifeGuide provides a REST API to manage parts of an intervention. The API follows the GitHub API specification where possible.		LifeGuide provides a REST API to manage parts of an intervention. The API follows the GitHub API specification where possible.

DonCruickshank: Copied changes from old wiki.

2023-01-19T15:41:02Z

Copied changes from old wiki.

← Older revision		Revision as of 15:41, 19 January 2023
Line 1:		Line 1:
	LifeGuide provides a REST API to manage parts of an intervention~~. This API is a work-in-progress and so will not be complete~~. The API follows the GitHub API specification where possible.		LifeGuide provides a REST API to manage parts of an intervention. The API follows the GitHub API specification where possible.

	~~<i>The REST~~ API ~~is not deployed~~ on ~~the live servers yet! It is available for testing on https://beta.lifeguideonline~~.~~org/</i>~~		To obtain an API key, go to your intervention and then click on "Configure API keys" and then "New API Key".

	__TOC__		__TOC__
Line 16:		Line 16:
	curl -i -X GET \		curl -i -X GET \
	--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \		--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
	"https://~~beta.~~lifeguideonline.org/api/v1/intervention_user?per_page=5"		"https://lifeguideonline.org/api/v1/intervention_user?per_page=5"
	</pre>		</pre>

Line 26:		Line 26:
	Server: Apache-Coyote/1.1		Server: Apache-Coyote/1.1
	X-Total: 13		X-Total: 13
	Link: <https://~~beta.~~lifeguideonline.org/api/v1/intervention_user?page=2&per_page=5>; rel="next"		Link: <https://lifeguideonline.org/api/v1/intervention_user?page=2&per_page=5>; rel="next"
	Content-Type: application/json;charset=utf-8		Content-Type: application/json;charset=utf-8
	Transfer-Encoding: chunked		Transfer-Encoding: chunked

	[{ "id": 1, "enabled": true, "username": "username1", "uri": "https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/1"},		[{ "id": 1, "enabled": true, "username": "username1", "uri": "https://lifeguideonline.org/api/v1/intervention_user/1"},
	{ "id": 2, "enabled": true, "username": "username2", "uri": "https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/2"},		{ "id": 2, "enabled": true, "username": "username2", "uri": "https://lifeguideonline.org/api/v1/intervention_user/2"},
	{ "id": 3, "enabled": true, "username": "username3", "uri": "https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/3"},		{ "id": 3, "enabled": true, "username": "username3", "uri": "https://lifeguideonline.org/api/v1/intervention_user/3"},
	{ "id": 4, "enabled": true, "username": "username4", "uri": "https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/4"},		{ "id": 4, "enabled": true, "username": "username4", "uri": "https://lifeguideonline.org/api/v1/intervention_user/4"},
	{ "id": 5, "enabled": true, "username": "username5", "uri": "https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/5"}]		{ "id": 5, "enabled": true, "username": "username5", "uri": "https://lifeguideonline.org/api/v1/intervention_user/5"}]
	</pre>		</pre>

Line 46:		Line 46:
	--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \		--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
	--data '{"username"="john.smith","password"="123456"}' \		--data '{"username"="john.smith","password"="123456"}' \
	"https://~~beta.~~lifeguideonline.org/api/v1/intervention_user"		"https://lifeguideonline.org/api/v1/intervention_user"
	</pre>		</pre>
	Example response:		Example response:
Line 54:		Line 54:
	Date: Mon, 01 Jan 2018 00:00:00 GMT		Date: Mon, 01 Jan 2018 00:00:00 GMT
	Server: Apache-Coyote/1.1		Server: Apache-Coyote/1.1
	Content-Location: https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/20		Content-Location: https://lifeguideonline.org/api/v1/intervention_user/20
	Content-Type: text/html;charset=utf-8		Content-Type: text/html;charset=utf-8
	Transfer-Encoding: chunked		Transfer-Encoding: chunked
Line 66:		Line 66:
	curl -i -X DELETE \		curl -i -X DELETE \
	--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \		--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
	"https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/20"		"https://lifeguideonline.org/api/v1/intervention_user/20"
	</pre>		</pre>

Line 88:		Line 88:
	curl -i -X GET \		curl -i -X GET \
	--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \		--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
	"https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/2/data"		"https://lifeguideonline.org/api/v1/intervention_user/2/data"
	</pre>		</pre>

Line 121:		Line 121:
	--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \		--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
	--data '"string value"' \		--data '"string value"' \
	"https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/2/data/variable1"		"https://lifeguideonline.org/api/v1/intervention_user/2/data/variable1"
	</pre>		</pre>

Line 130:		Line 130:
	Date: Mon, 01 Jan 2018 00:00:00 GMT		Date: Mon, 01 Jan 2018 00:00:00 GMT
	Server: Apache-Coyote/1.1		Server: Apache-Coyote/1.1
	Content-Location: https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/2/data/variable1		Content-Location: https://lifeguideonline.org/api/v1/intervention_user/2/data/variable1
	Content-Type: text/html;charset=utf-8		Content-Type: text/html;charset=utf-8
	</pre>		</pre>
Line 141:		Line 141:
	curl -i -X GET \		curl -i -X GET \
	--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \		--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
	"https://~~beta.~~lifeguideonline.org/api/v1/intervention_user/2/data/variable1"		"https://lifeguideonline.org/api/v1/intervention_user/2/data/variable1"
	</pre>		</pre>

Line 167:		Line 167:
	curl -i -X GET \		curl -i -X GET \
	--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \		--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
	"https://~~beta.~~lifeguideonline.org/api/v1/messagebox/mailto:person@example.com/message"		"https://lifeguideonline.org/api/v1/messagebox/mailto:person@example.com/message"
	</pre>		</pre>

Line 175:		Line 175:
	[		[
	{		{
	"uri": "https://~~beta.~~lifeguideonline.org/api/v1/messagebox/mailto:person@example.com/message/14"		"uri": "https://lifeguideonline.org/api/v1/messagebox/mailto:person@example.com/message/14"
	"id": 14,		"id": 14,
	"body": "Content",		"body": "Content",
Line 196:		Line 196:
	curl -i -X DELETE \		curl -i -X DELETE \
	--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \		--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
	"https://~~beta.~~lifeguideonline.org/api/v1/messagebox/mailto:person@example.com/message/14"		"https://lifeguideonline.org/api/v1/messagebox/mailto:person@example.com/message/14"
	</pre>		</pre>

DonCruickshank at 11:43, 6 June 2018

2018-06-06T11:43:21Z

← Older revision		Revision as of 11:43, 6 June 2018
Line 1:		Line 1:
	LifeGuide provides a REST API to manage parts of an intervention. This API is a work-in-progress and so will not be complete. The API follows the GitHub API specification where possible.		LifeGuide provides a REST API to manage parts of an intervention. This API is a work-in-progress and so will not be complete. The API follows the GitHub API specification where possible.

			<i>The REST API is not deployed on the live servers yet! It is available for testing on https://beta.lifeguideonline.org/</i>

	__TOC__		__TOC__

DonCruickshank: Added information on the error responses.

2018-06-06T11:16:59Z

Added information on the error responses.

← Older revision		Revision as of 11:16, 6 June 2018
Line 237:		Line 237:
	2018-05-16T23:15:00Z		2018-05-16T23:15:00Z
	</pre>		</pre>

			== Error responses ==

			For create and update operations that fail internal validation tests, the LifeGuide REST API will return a status code of 400 with a JSON formatted error object, e.g.:

			<pre>
			{
			"errors":
			[
			{
			"field": "username",
			"validation": "unique",
			"value": "john.smith"
			}
			]
			}
			</pre>


			Each error has three fields:

			* <tt>field</tt> is the name of the field with the validation error.
			* <tt>validation</tt> is the type of validation test that failed. Known values are "unique" for fields that are set to be unique and "blank" for fields that must have a value.
			* <tt>value</tt> is the value that was given in the request.

DonCruickshank: Added create / update intervention user data

2018-06-06T11:08:01Z

Added create / update intervention user data

@@ Line 106: / Line 106: @@
    "variable6": 6
+}
 </pre>

DonCruickshank: Added notes and the message API endpoints.

2018-05-31T15:40:24Z

Added notes and the message API endpoints.

@@ Line 1: / Line 1: @@
-LifeGuide provides a REST API to manage parts of an intervention. This API is a work-in-progress and so will not be complete.
+LifeGuide provides a REST API to manage parts of an intervention. This API is a work-in-progress and so will not be complete. The API follows the GitHub API specification where possible.
 __TOC__
-= Intervention Users (participants) =
+= REST API endpoints =
-== List Intervention Users ==
+== Intervention Users (participants) ==
 Example cURL command:
@@ Line 33: / Line 35: @@
 </pre>
-== Create an Intervention User ==
+=== Create an Intervention User ===
 Example cURL command:
@@ Line 55: / Line 57: @@
 </pre>
-== Delete an Intervention User ==
+=== Delete an Intervention User ===
 Example cURL command:
@@ Line 75: / Line 77: @@
 </pre>
-= Intervention User Data =
+== Intervention User Data ==
-== List Intervention User Data ==
+=== List Intervention User Data ===
 Example cURL command:
@@ Line 106: / Line 108: @@
 </pre>
-== Read Intervention User Data ==
+=== Read Intervention User Data ===
 Example cURL command:
@@ Line 128: / Line 130: @@
    "variable1": "value1"
+}
 </pre>

DonCruickshank: Added Intervention User Data

2018-05-31T12:05:14Z

Added Intervention User Data

@@ Line 26: / Line 26: @@
 Transfer-Encoding: chunked
-[{"id":1,"enabled":true,"username":"user1","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/1"},
+[{ "id": 1, "enabled": true, "username": "username1", "uri": "https://beta.lifeguideonline.org/api/v1/intervention_user/1"},
-  {"id":2,"enabled":true,"username":"user2","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/2"},
+  { "id": 2, "enabled": true, "username": "username2", "uri": "https://beta.lifeguideonline.org/api/v1/intervention_user/2"},
-  {"id":3,"enabled":true,"username":"user3","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/3"},
+  { "id": 3, "enabled": true, "username": "username3", "uri": "https://beta.lifeguideonline.org/api/v1/intervention_user/3"},
-  {"id":4,"enabled":true,"username":"user4","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/4"},
+  { "id": 4, "enabled": true, "username": "username4", "uri": "https://beta.lifeguideonline.org/api/v1/intervention_user/4"},
-  {"id":5,"enabled":true,"username":"user5","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/5"}]
+  { "id": 5, "enabled": true, "username": "username5", "uri": "https://beta.lifeguideonline.org/api/v1/intervention_user/5"}]
 </pre>
@@ Line 73: / Line 73: @@
 Content-Type: text/html;charset=utf-8
 Content-Length: 0
 </pre>

DonCruickshank: Created page with "LifeGuide provides a REST API to manage parts of an intervention. This API is a work-in-progress and so will not be complete. TOC = Intervention Users (participants) = ..."

2018-05-31T11:46:12Z

Created page with "LifeGuide provides a REST API to manage parts of an intervention. This API is a work-in-progress and so will not be complete. __TOC__ = Intervention Users (participants) = ..."

New page

LifeGuide provides a REST API to manage parts of an intervention. This API is a work-in-progress and so will not be complete.

__TOC__

= Intervention Users (participants) =

== List Intervention Users ==

Example cURL command:

<pre>
curl -i -X GET \
--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
"https://beta.lifeguideonline.org/api/v1/intervention_user?per_page=5"
</pre>

Example response:

<pre>
HTTP/1.1 200 OK
Date: Mon, 01 Jan 2018 00:00:00 GMT
Server: Apache-Coyote/1.1
X-Total: 13
Link: <https://beta.lifeguideonline.org/api/v1/intervention_user?page=2&per_page=5>; rel="next"
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked

[{"id":1,"enabled":true,"username":"user1","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/1"},
{"id":2,"enabled":true,"username":"user2","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/2"},
{"id":3,"enabled":true,"username":"user3","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/3"},
{"id":4,"enabled":true,"username":"user4","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/4"},
{"id":5,"enabled":true,"username":"user5","uri":"https://beta.lifeguideonline.org/api/v1/intervention_user/5"}]
</pre>

== Create an Intervention User ==

Example cURL command:

<pre>
curl -i -X POST \
--header "Content-Type: application/json" \
--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
--data '{"username"="john.smith","password"="123456"}' \
"https://beta.lifeguideonline.org/api/v1/intervention_user"
</pre>
Example response:

<pre>
HTTP/1.1 201 Created
Date: Mon, 01 Jan 2018 00:00:00 GMT
Server: Apache-Coyote/1.1
Content-Location: https://beta.lifeguideonline.org/api/v1/intervention_user/20
Content-Type: text/html;charset=utf-8
Transfer-Encoding: chunked
</pre>

== Delete an Intervention User ==

Example cURL command:

<pre>
curl -i -X DELETE \
--header "Authorization: Token cOrNDlXtHTH17lFYUF5ixo8e5w7myXxM" \
"https://beta.lifeguideonline.org/api/v1/intervention_user/20"
</pre>

Example response:

<pre>
HTTP/1.1 204 No Content
Date: Mon, 01 Jan 2018 00:00:00 GMT
Server: Apache-Coyote/1.1
Content-Type: text/html;charset=utf-8
Content-Length: 0
</pre>