/
BE
beepnl
/
BEEP
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v1
latest
OpenAPI 3.0.3
2026-07-17
114
0
286.6 KB
Api\AlertController
api/alerts GET List all user alerts that are not deleted.
get
/api/alerts
Headers
Authorization
string
Content-Type
string
Accept
string
Accept-language
string
All 114 operations
get
api/alerts GET List all user alerts that are not deleted.
post
api/alerts/{id} POST Create the specified user alert.
get
api/alerts/{id} GET Display the specified user alert.
put
api/alerts/{id} PATCH Update the specified user alert.
delete
api/alerts/{id} DELETE Delete the specified user alert, or all if id === 'all', or specific id's when provided &alert_ids=1,4,7
get
api/alert-rules GET List all user alert rules that are not deleted.
post
api/alert-rules/{id} POST Create the specified user alert rule.
get
api/alert-rules/{id} GET Display the specified user alert rules.
put
api/alert-rules/{id} PATCH Update the specified user alert rule.
delete
api/alert-rules/{id} DELETE Delete the specified user alert rule.
get
api/alert-rules-default GET List all default alert rules that are available.
get
api/categories Display a listing of the inspection categories.
get
api/categories/{id} Display the specified category.
get
api/categoryinputs List of all available input types of the inspection categories
get
Display a listing of the resource.
post
get
put
delete
get
api/checklist-svg GET Show your list of stored SVG inspections
post
api/checklist-svg POST Store an SVG inspection
get
api/checklist-svg/{id} GET Show an SVG inspection
put
api/checklist-svg/{id} PATCH Edit an SVG inspection
delete
api/checklist-svg/{id} DELETE Delete an SVG inspection
get
api/dashboard/{sode} GET Get public user Dashboard groups
get
api/dashboardgroups GET List all user Dashboard groups
post
get
put
delete
post
api/devices/multiple POST Store/update multiple Devices in an array of Device objects
get
api/devices/ttn/{dev_id} GET Get a BEEP TTS Cloud Device by Device ID (BEEP hardware_id)
post
api/devices/ttn/{dev_id} POST Create a BEEP TTS Cloud Device by Device ID, lorawan_device.dev_eui, and lorawan_device.app_key
get
api/devices GET List all user Devices
post
api/devices POST Create or Update a Device
get
api/devices/{id} GET List one Device by id
put
api/devices PUT/PATCH Update an existing Device
post
api/export/csv POST Generate a CSV measurement data export from InfluxDB. Make sure not to load a too large timespan (i.e. > 30 days), because the call will not succeed due to memory overload.
get
api/export GET Generate an Excel file with all user data and send by e-mail or as download link
get
api/flashlogs GET Provide a list of the available flashlogs
get
api/flashlogs/{id} GET Provide the contents of the log_file_parsed property of the flashlog
post
api/flashlogs/{id} POST Fill the missing database values with Flashlog values that match
delete
api/flashlogs/{id} DELETE Delete a block of data (block_id filled), or the whole Flashlog file
post
api/groups/checktoken POST Check a token for a group id, and accept or decline the invite
get
post
get
put
delete
delete
get
api/hives GET Display a listing of user hives.
post
api/hives POST Store a newly created Hive in storage for the authenticated user.
get
api/hives/{id} GET Display the specified resource.
put
api/hives/{id} PATCH Update the specified user Hive in storage.
delete
api/hives/{id} DELETE Remove the specified user Hive from storage.
get
Display a listing of the resource.
post
Store a newly created resource in storage.
delete
Remove the specified resource from storage.
get
Display the specified resource.
put
Update the specified resource in storage.
get
api/inspections GET Show the 'inspections' list with objects reflecting only the general inspection data.
get
api/inspections/lists GET List checklists and its 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/{id} GET Show the 'inspection' object. The object reflects only the general inspection data.
delete
Remove the specified resource from storage.
get
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.
post
api/inspections POST Register a new hive inspection the 'inspection' object. The object reflects only the general inspection data.
get
Display a listing of the resource.
post
Store a newly created resource in storage.
get
Display the specified resource.
put
Update the specified resource in storage.
delete
Remove the specified resource from storage.
post
api/sensors POST Store sensor measurement data (see BEEP sensor data API definition) from API, or TTN. See /sensors/measurement_types?locale=en which measurement types can be used to POST data to.
post
api/lora_sensors POST Store sensor measurement data (see BEEP sensor data API definition) from TTN or KPN (Simpoint) When Simpoint payload is supplied, the LoRa HEX to key/value pairs decoding is done within function $this->parse_ttn_payload() When TTN payload is supplied, the TTN HTTP integration decoder/converter is assumed to have already converted the payload from LoRa HEX to key/value conversion
get
api/sensors/measurement_types GET Request all currently available sensor measurement types that can be POSTed to
post
api/sensors POST Store sensor measurement data (see BEEP sensor data API definition) from API, or TTN. See /sensors/measurement_types?locale=en which measurement types can be used to POST data to.
post
api/lora_sensors POST Store sensor measurement data (see BEEP sensor data API definition) from TTN or KPN (Simpoint) When Simpoint payload is supplied, the LoRa HEX to key/value pairs decoding is done within function $this->parse_ttn_payload() When TTN payload is supplied, the TTN HTTP integration decoder/converter is assumed to have already converted the payload from LoRa HEX to key/value conversion
get
api/sensors/measurements GET Request all sensor measurements from a certain interval (hour, day, week, month, year) and index (0=until now, 1=previous interval, etc.)
get
api/sensors/lastvalues GET Request last measurement values of all sensor measurements from a Device
get
api/sensors/lastweight GET Request last weight related measurement values from a sensor (Device), used by legacy webapp to show calibration data: ['w_fl', 'w_fr', 'w_bl', 'w_br', 'w_v', 'weight_kg', 'weight_kg_corrected', 'calibrating_weight', 'w_v_offset', 'w_v_kg_per_val', 'w_fl_offset', 'w_fr_offset', 'w_bl_offset', 'w_br_offset']
post
api/sensors/calibrateweight Legacy method, used by legacy webapp to store weight calibration value e.g.[w_v_kg_per_val] in Influx database, to lookup and calculate [weight_kg] at incoming measurement value storage
post
get
post
api/sensors/flashlog POST data from BEEP base fw 1.5.0+ FLASH log (with timestamp), interpret data and store in InlfuxDB (overwriting existing data). BEEP base BLE cmd: when the response is 200 OK and erase_mx_flash > -1, provide the ERASE_MX_FLASH BLE command (0x21) to the BEEP base with the last byte being the HEX value of the erase_mx_flash value (0 = 0x00, 1 = 0x01, i.e.0x2100, or 0x2101, i.e. erase_type:"fatfs", or erase_type:"full")
get
get
api/sensors/comparemeasurements GET Request mean measurements for multiple hives from a certain interval (hour, day, week, month, year) and index (0=until now, 1=previous interval, etc.)
get
Display a listing of the resource.
post
research/{id}/add_consent POST
post
patch
delete
get
api/researchdata GET List all available Researches
get
api/researchdata/{id} GET List one Research by id with list of consent_users
get
api/researchdata/{id}/user/{user_id}/{item} GET List all user 'item' data within the consent=1 periods of a specific user within a Research. The 'item' field indicates the type of user data (apiaries/locations/hives/devices/flashlogs/inspections/measurements/weather) to request within the research (which the user gave consent for to use). Example: inspectionsResponse: api/researchdata/1/user/1/inspections.
get
api/researchdata/{id}/data/{item} GET List all research 'item' data within the consent=1 periods within a Research. The 'item' field indicates the type of data (apiaries/locations/devices/inspections/measurements/weather) to request within the research (which the user gave consent for to use). Example: inspectionsResponse: api/researchdata/1/inspections.
get
Display a listing of the resource.
post
api/samplecode POST Create a sample code for lab results
delete
Remove the specified resource from storage.
get
Show not used
put
Update not used
get
api/sensordefinition GET Display a listing of all sensordefinitions that belong to a device
post
api/sensordefinition POST Store a newly created sensordefinition
get
api/sensordefinition/{id} GET Display the specified sensordefinition
put
api/sensordefinition/{id} PATCH Update the specified sensordefinition
delete
api/sensordefinition/{id} DELETE Remove the specified sensordefinition
get
api/taxonomy/lists List of current state of the standard categories.
get
api/taxonomy/taxonomy List of current state of the standard categories, translated, unordered/ordered in hierachy/flat.
post
api/login Login via login form
post
api/authenticate Authorize a user and login with an api_token. Used for persistent login in webapp.
patch
api/userlocale PATCH Edit the user locale only, do not update api_key
get
Display a listing of the resource.
post
Store a newly created resource in storage.
get
Display the specified resource.
put
Update the specified resource in storage.
delete
Remove the specified resource from storage.