Categorieën
Goed om te weten: werkt u met MinimalConfig? Dan voegt het systeem locaties en categorieën automatisch toe. U kunt deze stap dan overslaan.
Let op: controleer of de hardware en software geschikt zijn voordat u locaties en categorieën aanmaakt. zie versiecontroles voor de API-methoden.
U verdeelt alarmen in de praktijk vaak over verschillende oproeplijsten of servicegroepen. Daarom maakt u meerdere categorieën aan.
Beschrijving van de API-elementen
| Element | Beschrijving |
|---|---|
| auto_repeat_delay | U stelt de vertraging in voordat het alarm opnieuw wordt aangeboden. |
| auto_repeat_times | U geeft het aantal herhalingen op na de eerste alarmacceptatie. |
| buzzer | U schakelt de zoemer voor dit alarm in of uit. |
| call_list_id | U selecteert de gewenste oproeplijst of servicegroep via dit ID. |
| category_id | Dit is de uniek gegenereerde ID voor de categorie. |
| continue_after_restore | U schakelt het doormelden aan of uit nadat het alarm is hersteld. |
| critical | U schakelt het maximale app-volume voor deze categorie in of uit. |
| disabled_until | U schakelt het alarm uit tot het opgegeven UTC-tijdstip (YYYY-MM-DDTHH:MM:SSZ). |
| enabled | U schakelt de alarmmelding voor deze categorie in of uit. |
| location_custom_id | U vult een unieke locatie-ID in die u zelf bepaalt (optioneel als alternatief voor location_id). |
| location_id | Dit is de uniek gegenereerde ID voor de locatie. |
| name | U geeft de categorie een naam. |
| report_during_daytime | U schakelt de alarmmelding overdag in of uit. |
| report_during_nighttime | U schakelt de alarmmelding 's nachts in of uit. |
| report_during_weekend | U schakelt de alarmmelding tijdens het weekend in of uit. |
| topic | Dit is de unieke, aangepaste ID voor de categorie. |
Let op: via de REST API koppelt u geen specifieke oproeplijsten of servicegroepen direct aan een categorie. Gebruik call_list_id 1 bij het aanmaken van een categorie.
Goed om te weten: door in de melder specifieke oproeplijsten of servicegroepen te maken, koppelt u deze daarna aan een categorie.
- Lees hoe u een oproeplijst of servicegroep maakt.
- Lees hoe u een oproeplijst aan een ingang (categorie) koppelt.
API-methoden
In de situatieschets van het praktijkvoorbeeld staan 4 categorieën: Teelt urgent, Teelt niet-urgent, Technisch urgent en Technisch niet-urgent. Voor het toevoegen van categorieën gebruikt u de API POST: /Categories.
POST: /Categories
{
"auto_repeat_delay": 300,
"auto_repeat_times": 3,
"buzzer": true,
"call_list_id": 1,
"continue_after_restore": false,
"critical": true,
"enabled": true,
"location_custom_id": "loc_01",
"name": "Cult. Urgent",
"report_during_daytime": true,
"report_during_nighttime": true,
"report_during_weekend": true,
"topic": "cultivation_urg"
}
cURL-code:
curl -X 'POST' \
'http://192.168.10.72/rest_api/1/Categories' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTI1MzQ0ODgsIm5iZiI6MTYxMjUzNDQ4OCwianRpIjoiNjY0NzI2NzAtYTRkMi00N2ZmLWFiMjUtNzAyMGYwOTkwNWJhIiwiZXhwIjoxNjEyNTM3OTg4LCJpZGVudGl0eSI6IlJFU1QtQVBJXzAwMDUiLCJmcmVzaCI6ZmFsc2UsInR5cGUiOiJhY2Nlc3MiLCJ1c2VyX2NsYWltcyI6eyJ1c2VyX2lkIjo1LCJyb2xlX2lkIjo1LCJsYW5ndWFnZSI6Im5sLU5MIn19.6xlCrMjNsKd9Eyq5ieS-MScZe6P1idstMCKPs5dfOd8' \
-H 'Content-Type: application/json' \
-d '{
"auto_repeat_delay": 300,
"auto_repeat_times": 3,
"buzzer": true,
"call_list_id": 1,
"continue_after_restore": false,
"critical": true,
"enabled": true,
"location_custom_id": "loc_01",
"name": "Cult. Urgent",
"report_during_daytime": true,
"report_during_nighttime": true,
"report_during_weekend": true,
"topic": "cultivation_urg"
}'
Respons:
{
"id": 35,
"location_id": 3,
"topic": "cultivation_urg",
"enabled": true,
"name": "Cult. Urgent",
"report_during_daytime": true,
"report_during_nighttime": true,
"report_during_weekend": true,
"continue_after_restore": false,
"call_list_id": 1,
"auto_repeat_times": 3,
"auto_repeat_delay": 300,
"buzzer": true,
"critical": true,
"location_custom_id": "loc_01"
}
Nadat u de locaties en categorieën hebt aangemaakt, kunt u de REST API gebruiken voor alarmering. U leest meer over het alarmeringsproces in Alarmrapportage.