Productstyle icon link Locaties

Omdat de alarmafhandeling voor elke locatie anders kan zijn, voegt u elke locatie toe aan de REST API koppeling. Hierdoor kunnen ze onafhankelijk rapporteren.

API elementen met hun beschrijving

ElementBeschrijving
custom_idUnieke locatie ID gedefinieerd door de klant
enabledfalse wanneer het systeem is uitgeschakeld, bijvoorbeeld wanneer er onderhoud gepleegd moet worden
idUnieke locatie database ID, gegenereerd door de Octalarm alarmmelder
nameNaam van de locatie. Wordt gebruikt:
1. bij het genereren van alarmen;
2. in het alarmrapport (spraak of tekst);
3. in het logboek en op het display.

U kunt alle elementen, behalve het element id, achteraf wijzigen met behulp van de custom_id en de PUT methode.

API methoden

In de situatieschets zijn twee locaties: Tomaten en Paprika's.

"Post: /Locations"

{
  "custom_id": "loc_01",
  "enabled": true,
  "name": "Tomatoes"
}

cURL code:

curl -X 'POST' \
  'http://192.168.10.72/rest_api/1/Locations' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTI1MzQ0ODgsIm5iZiI6MTYxMjUzNDQ4OCwianRpIjoiNjY0NzI2NzAtYTRkMi00N2ZmLWFiMjUtNzAyMGYwOTkwNWJhIiwiZXhwIjoxNjEyNTM3OTg4LCJpZGVudGl0eSI6IlJFU1QtQVBJXzAwMDUiLCJmcmVzaCI6ZmFsc2UsInR5cGUiOiJhY2Nlc3MiLCJ1c2VyX2NsYWltcyI6eyJ1c2VyX2lkIjo1LCJyb2xlX2lkIjo1LCJsYW5ndWFnZSI6Im5sLU5MIn19.6xlCrMjNsKd9Eyq5ieS-MScZe6P1idstMCKPs5dfOd8' \
  -H 'Content-Type: application/json' \
  -d '{
  "custom_id": "loc_01",
  "enabled": true,
  "name": "Tomatoes"
}'

Respons:

{
"id": 3,
"name": "Tomatoes",
"custom_id": "loc_01",
"enabled": true
}

Wanneer alle locaties zijn toegevoegd, kunt u deze locaties opvragen met de API "GET: /Locations".

"GET: /Locations"

cURL code:

curl -X 'GET' \
  'http://192.168.10.72/rest_api/1/Locations' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTI1MzQ0ODgsIm5iZiI6MTYxMjUzNDQ4OCwianRpIjoiNjY0NzI2NzAtYTRkMi00N2ZmLWFiMjUtNzAyMGYwOTkwNWJhIiwiZXhwIjoxNjEyNTM3OTg4LCJpZGVudGl0eSI6IlJFU1QtQVBJXzAwMDUiLCJmcmVzaCI6ZmFsc2UsInR5cGUiOiJhY2Nlc3MiLCJ1c2VyX2NsYWltcyI6eyJ1c2VyX2lkIjo1LCJyb2xlX2lkIjo1LCJsYW5ndWFnZSI6Im5sLU5MIn19.6xlCrMjNsKd9Eyq5ieS-MScZe6P1idstMCKPs5dfOd8'

Respons:

{
  "locations": [
    {
      "id": 3,
      "name": "Tomatoes",
      "custom_id": "loc_01",
      "enabled": true
    },
    {
      "id": 4,
      "name": "Peppers",
      "custom_id": "loc_02",
      "enabled": true
    }
  ]
}

"PUT: /Locations/CusomId/loc_01"

{
  "name": "Cucumber"
}

cURL code:

curl -X 'PUT' \
  'http://192.168.10.72/rest_api/1/Locations/CustomId/loc_01' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTI1MzQ0ODgsIm5iZiI6MTYxMjUzNDQ4OCwianRpIjoiNjY0NzI2NzAtYTRkMi00N2ZmLWFiMjUtNzAyMGYwOTkwNWJhIiwiZXhwIjoxNjEyNTM3OTg4LCJpZGVudGl0eSI6IlJFU1QtQVBJXzAwMDUiLCJmcmVzaCI6ZmFsc2UsInR5cGUiOiJhY2Nlc3MiLCJ1c2VyX2NsYWltcyI6eyJ1c2VyX2lkIjo1LCJyb2xlX2lkIjo1LCJsYW5ndWFnZSI6Im5sLU5MIn19.6xlCrMjNsKd9Eyq5ieS-MScZe6P1idstMCKPs5dfOd8' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Cucumber"
}'

Respons:

{
  "id": 3,
  "name": "Cucumber",
  "custom_id": "loc_01",
  "enabled": true
}