GET institution environments

Description

Retrieves a list with all records of environment measurements associated with an Institution.

Permissions:

• All users can read any information from all Environments of an Institution.

Scope

environment:read

URL

GET https://localhost/v1/institutions/{institution_id}/environments

Parameters

institution_id: string (A 24-byte hex ID)

Curl example

curl -X GET "https://localhost/v1/institutions/5a62be07de34500146d9c624/environments" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response body

• 200 Successful requisition.

  [
      {
        "id": "5a62be07de34500146d9c544",
        "institution_id": "5a62be07de34500146d9c544",
        "location": {
          "local": "indoor",
          "room": "Bloco H sala 01",
          "latitude": -7.2100766,
          "longitude": -35.9175756
        },
        "measurements": [
          {
            "type": "temperature",
            "value": 35.6,
            "unit": "°C"
          },
          {
            "type": "humidity",
            "value": 42.2,
            "unit": "%"
          },
          {
            "type": "pm1",
            "value": 0.57,
            "unit": "µm"
          },
          {
            "type": "pm2.5",
            "value": 1.9,
            "unit": "µm"
          },
          {
            "type": "pm10",
            "value": 7.9,
            "unit": "µm"
          }
        ],
        "climatized": true,
        "timestamp": "2019-11-19T14:40:00Z"
      }
  ]

• 400 Validation errors

  • Invalid institution_id
  • Institution does not exist

• 401 Unauthorized Error

• 403 Permission Error

• 429 Too Many Requests Error

• 500 Internal Server Error

Query Strings (Optional)

Query strings are used as follows: there must be a question mark following the URL and providing the parameters for the desired operations. There are four possible operations: filtering, paging, limiting, and sorting.

• Filtering

  https://localhost/v1/institutions/5a62be07de34500146d9c624/environments?timestamp=gte:2019-11-20T00:00:00.000Z&timestamp=lt:2019-11-20T23:59:59.999Z

• Pagination

  https://localhost/v1/institutions/5a62be07de34500146d9c624/environments?page=1

• Limitation

  https://localhost/v1/institutions/5a62be07de34500146d9c624/environments?limit=10

• Sorting

  https://localhost/v1/institutions/5a62be07de34500146d9c624/environments?sort=timestamp

All parameters can also be used together concatenated by the & character as follows:

https://localhost/v1/institutions/5a62be07de34500146d9c624/environments?timestamp=gte:2019-11-20T00:00:00.000Z&timestamp=lt:2019-11-20T23:59:59.999Z&sort=timestamp&page=1&limit=10

For more details about using Query Strings click here.