Alarmrapportage
Alarminformatie bevat alle gegevens die u nodig heeft om een rapport te starten. Met de API POST: /Categories /Alarm start u een alarm op basis van een categorie (category_topic).
Beschrijving van de API-elementen
| Element | Beschrijving |
|---|---|
| alarm_value | true voor een alarm, false als het alarm is hersteld. |
| category_topic | Uniek categorie-ID dat u als klant heeft opgegeven. |
| location_custom_id | Uniek locatie-ID dat u als klant heeft opgegeven. |
| location_id | Uniek locatie-ID uit de database, aangemaakt door de Octalarm alarmmelder. |
| message | Tekst van de alarmmelding (spraak, sms, app-bericht, enzovoort). |
| name | Korte naam voor de alarmmelding, zichtbaar op het display en in het logboek. |
| unique_id | Aangepast alarm-ID. |
API-methoden
POST: /Categories /Alarm
{
"alarm_value": true,
"category_topic": "cultivation_urg",
"location_custom_id": "loc_01",
"message": "dept. 2 temperature too high",
"name": "dept. 2 temperature",
"unique_id": "loc_01_alrm_01a1b4"
}
cURL-code:
curl -X 'POST' \
'http://192.168.10.72/rest_api/1/Categories/Alarm' \
-H 'accept: application/json' \
-H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTI1MzQ0ODgsIm5iZiI6MTYxMjUzNDQ4OCwianRpIjoiNjY0NzI2NzAtYTRkMi00N2ZmLWFiMjUtNzAyMGYwOTkwNWJhIiwiZXhwIjoxNjEyNTM3OTg4LCJpZGVudGl0eSI6IlJFU1QtQVBJXzAwMDUiLCJmcmVzaCI6ZmFsc2UsInR5cGUiOiJhY2Nlc3MiLCJ1c2VyX2NsYWltcyI6eyJ1c2VyX2lkIjo1LCJyb2xlX2lkIjo1LCJsYW5ndWFnZSI6Im5sLU5MIn19.6xlCrMjNsKd9Eyq5ieS-MScZe6P1idstMCKPs5dfOd8' \
-H 'Content-Type: application/json' \
-d '{
"alarm_value": true,
"category_topic": "cultivation_urg",
"location_custom_id": "loc_01",
"message": "dept. 2 temperature too high",
"name": "dept. 2 temperature",
"unique_id": "loc_01_alrm_01a1b4"
}'
Respons:
{
"unique_id": "loc_01_alrm_01a1b4",
"name": "dept. 2 temperature",
"message": "dept. 2 temperature too high",
"category_topic": "cultivation_urg",
"alarm_value": true,
"location_id": 3,
"location_custom_id": "loc_01",
"category_id": 35
}
Rapportage
Goed om te weten:
- De melder slaat actieve alarmen op in het tijdelijke geheugen. Na een herstart verdwijnen deze alarmen.
- Ontvangt de melder een alarm van een onbekende locatie-ID, dan gebruikt de melder de alarmafhandeling van het systeemalarm onbekende locatie.
- Ontvangt de melder een alarm van een bekende locatie maar met een onbekend categorie-onderwerp (category_topic), dan gebruikt hij de standaardcategorie van die specifieke locatie.
Let op: alle alarmen van externe apparaten moeten een unieke ID (unique_id) hebben. Het externe apparaat:
- gebruikt deze unieke ID om een alarmmelding via de REST API te starten.
- slaat de unieke ID's op. Als het alarm wordt hersteld of opnieuw actief wordt, gebruikt de melder dezelfde unieke ID opnieuw.
- houdt locaties en categorieën synchroon met de locaties en categorieën die u in de melder aanmaakt. Dit betekent dat het externe apparaat:
- de locaties en categorieën kan ophalen via de GET-methode;
- locaties en categorieën naar behoefte kan toevoegen of wijzigen via de POST-methode.