The 'Return to Ritherdon' project, by Nicola Ellis, is a two year art residency at Ritherdon & Co Ltd, a manufacturer of metal enclosures based in Darwen, Lancashire U.K. This website is part of the many outcomes produced throughout the duration of project.
The 'Return to Ritherdon' project, by Nicola Ellis, is a two year art residency at Ritherdon & Co Ltd, a manufacturer of metal enclosures based in Darwen, Lancashire U.K. This website is part of the many outcomes produced throughout the duration of project.
version:"1.0.0 - Alpha"
version:"1.0.0 - Beta"
title:Return to Ritherdon Project A.P.I.
title:Return to Ritherdon Project A.P.I.
consumes:
consumes:
- application/json
- application/json
@ -69,10 +69,21 @@ paths:
This represents the amount of light the light meter
This represents the amount of light the light meter
recorded. This is the most important piece of data
recorded. This is the most important piece of data
you will post in this data-object.
you will post in this data-object.
token:
type:string
example:it-is-not-password-if-you-are-wondering
description:>-
This is basically a token to check the info. sent to
the server is from a valid machine.
responses:
responses:
201:
201:
description:>-
description:>-
The reading was successfully added to the database.
The reading was successfully added to the database.
400:
description:>-
The data sent to the sever was invalid or incorrectly
formatted. The most likely reasons are invalid light-meter
Id. specified and incorrect datetime format used.
/readings/latest/{light_meter}:
/readings/latest/{light_meter}:
get:
get:
@ -126,6 +137,9 @@ paths:
This is the actual reading taken from the specified
This is the actual reading taken from the specified
light meter, at the time specified in this response
light meter, at the time specified in this response
body (I.E. JSON object).
body (I.E. JSON object).
400:
description:>-
The light-meter Id. specified in invalid.
/readings/all/{light_meter}:
/readings/all/{light_meter}:
get:
get:
@ -177,6 +191,9 @@ paths:
This is the actual reading taken from the specified
This is the actual reading taken from the specified
light meter, at the time specified in this response
light meter, at the time specified in this response
body (I.E. JSON object).
body (I.E. JSON object).
400:
description:>-
The light-meter Id. specified in invalid.
/readings/all:
/readings/all:
get:
get:
@ -249,10 +266,21 @@ paths:
description:>-
description:>-
The current status of the device you would like to log.
The current status of the device you would like to log.
The two status types are "on" and "off".
The two status types are "on" and "off".
token:
type:string
example:it-is-not-password-if-you-are-wondering
description:>-
This is basically a token to check the info. sent to
the server is from a valid machine.
responses:
responses:
201:
201:
description:>-
description:>-
The status update was successfully added to the database.
The status update was successfully added to the database.
400:
description:>-
The data sent to the sever was invalid or incorrectly
formatted. The most likely reasons are invalid device Id.
specified and incorrect datetime format used.
/status/latest/{device}:
/status/latest/{device}:
get:
get:
@ -304,6 +332,9 @@ paths:
type:string
type:string
example:on
example:on
description:The current status of the device.
description:The current status of the device.
400:
description:>-
The device Id. specified in invalid.
/status/all/{device}:
/status/all/{device}:
get:
get:
@ -311,7 +342,7 @@ paths:
tags:
tags:
- Request Device Status
- Request Device Status
summary:>-
summary:>-
Returns every status changed logged by the specified device.
Returns every status change logged by the specified device.
description:>-
description:>-
Use this U.R.L. to retrieve every change in the specified
Use this U.R.L. to retrieve every change in the specified
devices state. At the time of writing, the project has six
devices state. At the time of writing, the project has six
@ -354,6 +385,9 @@ paths:
example:off
example:off
description:>-
description:>-
The status of the device after the change occurred.
The status of the device after the change occurred.