Alarm rapportage

Alarmen worden verzonden met alle informatie die nodig is om een rapport te starten. De API "POST: /Categories /Alarm" start een alarm op basis van een categorie onderwerp (category_topic).

API elementen met hun beschrijving

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:

1. actieve alarmen worden opgeslagen in het vluchtige geheugen. Dit betekent dat deze actieve alarmen verdwijnen als de Octalarm alarmmelder opnieuw opstart;

2. de Octalarm alarmmelder gebruikt:
2.1. de alarmafhandeling van het systeemalarm onbekende locatie bij een alarm uit een onbekende locatie ID;
2.2. de standaard categorie van een specifieke locatie bij een alarm van een onbekend categorie onderwerp (category_topic).

Let op: alle alarmen van externe apparaten moeten een eigen unieke ID (unique_id) hebben. Het externe apparaat:

1. gebruikt deze unieke ID om een alarmmelding via de REST API te starten.

2. moet de unieke ID's opslaan. Als het alarm wordt hersteld, of als het alarm opnieuw actief wordt, gebruikt de melder deze unieke ID opnieuw.

3. is verantwoordelijk voor het synchroon houden van locaties en categorieën met de locaties en categorieën die in de melder zijn aangemaakt. Dit betekent dat het externe apparaat:
3.1. moet kunnen synchroniseren door de locaties en categorieën op te halen (GET-methode);
3.2. de nieuwe locaties en categorieën naar behoefte moet kunnen toevoegen of wijzigen (POST- of POST-methode).