Get the historic log of filter maintenances for a booth.

GET /api/booths/{id}/filter_maintenance_history

Allows you to retrieve the full log of past filter maintenances that have happened on a booth.

Path parameters

  • id string Required

    id of the booth

Query parameters

  • filter string

    criteria to filter by

  • sort string

    criteria to sort by

  • limit string

    amount of results per page to return

  • page string

    page number

Responses

  • OK

    Hide response attribute Show response attribute object
    • data array[object]

      List of past filter maintenances for a booth

      Hide data attributes Show data attributes object
      • Total active spray time the booth had when the filter was in place

      • Total in-use time of the booth when the filter was in place

      • duration number

        Number of days the filter was on the booth

      • Type of the filter. One of intake_filter | pre_filter | exhaust_filter

      • ISO8601 encoded date for when the filter was removed from the booth

      • overuse number

        Total number of days the booth spent in overuse

  • Bad request

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code

  • Unauthorized

    Hide response attribute Show response attribute object
    • error string

      Human readable version of the error status code

GET /api/booths/{id}/filter_maintenance_history
curl \
 --request GET http://localhost:4000/api/booths/{id}/filter_maintenance_history \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "data": [
    {
      "active_spray_time": 42.0,
      "booth_in_use_time": 42.0,
      "duration": 42.0,
      "filter_type": "string",
      "maintenance_date": "string",
      "overuse": 42.0
    }
  ]
}
Response examples (400)
{
  "error": "Error Reason"
}
Response examples (400)
{
  "error": "Error Reason"
}
Response examples (401)
{
  "error": "Error Reason"
}
Response examples (401)
{
  "error": "Error Reason"
}