API Documentation

Last updated: 25 May 2019

Retrieving Latest Sensors Information

Link

Perform GET request to https://lapsscentral.azurewebsites.net/api/sensors

This operation will retrieve the latest information the server has on each sensor.

Response

HTTP status code: 200 OK

A JSON with a following structure

Field Type Description
id String Internal ID for the node
name String The name of the node
pm25Level Integer Level of PM 2.5
pm10Level Integer Level of PM 10
pm1Level Integer Level of PM 1
temp Float The temperature
humidity Float The humidity
recordedOn String ISO 8601-formatted datetime of when the node was created

Note: Only id, name, and recordedOn are guaranteed to be present. The others property may not appear if the node does not have that sensor. I.E. If a node does not have the humidity and temperature sensor then those two properties will not be present.

Example request body
{
  id: "5cf0cb68174f1556fc80c02e",
  name: "Node 2",
  pm25Level: 4,
  pm10Level: 4,
  pm1Level: 4,
  temp: 28.5,
  humidity: 66,
  recordedOn: "2019-05-31T06:36:24.974Z"
}
JavaScript
Copy

Retrieving Detailed Sensor Information History

Link

Perform GET request to https://lapsscentral.azurewebsites.net/api/sensors/history/{optional-slug}

This operation will retrieve sensor information as specified in the query string.

Response

HTTP status code: 200 OK

Use query string to specify the following parameters (all optional):

Query String Description
?from={datetime} Only query for the sensor information after this time
?to={datetime} Only query for the sensor information before this time
?limit={integer} Specify number of sensor information per page
Default: 50
?page={integer} Specify page
Default: 0

Retrieving Node Information

Link

Perform GET request to https://lapsscentral.azurewebsites.net/api/nodeinfos

This operation will retrieve information that the server has about each node.

Response

HTTP status code: 200 OK

A JSON with a following structure

Field Type Description
id String Internal ID for the node
name String The name of the node
latitude Float The latitude location of the node
longitude Float The longitude location of the node
active Boolean Whether the node is active (still sending data) or not
Example request body
{
  id: "5ccfa725fad29149b0cbecda",
  name: "Node 1",
  latitude: 13.730319,
  longitude: 100.774829,
  active: true                    
}
JavaScript
Copy

Sending Sensor Information

Perform POST request to https://lapsscentral.azurewebsites.net/api/sensors

Response

HTTP status code: 201

Example request body
{
  "name": "Sample Input",
  "pm25Level": 42,
  "pm10Level": 10,
  "pm1Level": 8,
  "humidity": 44,
  "temp": 36 
}
JavaScript
Copy