Sign in

v1

latestOpenAPI 3.0.32026-07-171140286.6 KB
Api\InspectionsController

api/inspections/hive/{hive_id} GET List all inspections linked to Hive id. The 'inspections' object contains a descending date ordered list of general inspection data. The 'items_by_date' object contains a list of (rows of) inspection items that can be placed (in columns) under the inspections by created_at date (table format). NB: Use 'Accept-Language' Header (default nl_NL) to provide localized category names (anc, name) in items_by_date.

get/api/inspections/hive/{hive_id}

Headers

Authorizationstring
Content-Typestring
Acceptstring
Accept-languagestring

Request body

searchstring

Filter inspections on text inside notes, reminder, created_at, reminder_date, inspection item names/values. Example: test bodyParam id integer If provided, select single inspection.

impressionstring

Filter by one or more impression values 1-3 (smileys). Default: null.

attentionboolean

Filter by having attention set (0-1). Default: null.

reminderboolean

Filter by having a reminder set (0-1). Default: null.

startstring

Date >= (YYYY-MM-DD HH:mm:ss) to filter inspections from. Default: null.

endstring

Date <= (YYYY-MM-DD HH:mm:ss) to filter inspections to. Default: null.

Example request

{
  "search": "15",
  "impression": "2,3",
  "attention": true,
  "reminder": true,
  "start": "2024-02-14 00:00:00",
  "end": "2024-02-18 00:00:00"
}

Response

inspectionsobject[]
items_by_dateobject[]

Example response

{
  "inspections": [
    {
      "id": 93,
      "notes": null,
      "reminder": null,
      "reminder_date": null,
      "impression": 1,
      "attention": null,
      "created_at": "2020-05-18 12:34:00",
      "checklist_id": 829,
      "image_id": null,
      "owner": true,
      "thumb_url": null,
      "hive_id": 42
    },
    {
      "id": 91,
      "notes": null,
      "reminder": null,
      "reminder_date": null,
      "impression": 3,
      "attention": 0,
      "created_at": "2020-05-18 11:43:00",
      "checklist_id": 829,
      "image_id": null,
      "owner": true,
      "thumb_url": null,
      "hive_id": 42
    }
  ],
  "items_by_date": [
    {
      "anc": null,
      "name": "Bee colony",
      "items": null
    },
    {
      "anc": "Bee colony > Brood > ",
      "name": "Pattern consistency",
      "type": "score",
      "range": "min: 1 - max: 5",
      "items": [
        {
          "id": 138,
          "value": "3",
          "inspection_id": 93,
          "category_id": 279,
          "val": "3",
          "unit": null,
          "type": "score"
        },
        ""
      ]
    },
    {
      "anc": "Bee colony > Brood > Status > ",
      "name": "All stages",
      "type": "boolean",
      "range": null,
      "items": [
        "",
        {
          "id": 77,
          "value": "1",
          "inspection_id": 91,
          "category_id": 868,
          "val": "Yes",
          "unit": null,
          "type": "boolean"
        }
      ]
    },
    {
      "anc": "Bee colony > Brood > Status > ",
      "name": "Eggs",
      "type": "boolean",
      "range": null,
      "items": [
        "",
        {
          "id": 308,
          "value": "1",
          "inspection_id": 91,
          "category_id": 270,
          "val": "Yes",
          "unit": null,
          "type": "boolean"
        }
      ]
    }
  ]
}