Message

Estimated reading: 4 minutes 96 views

GET

https://app.smartdme.de/api/public/v1/message

Alle Meldungen (der letzten 24 Stunden) einer Organisation empfangen. Optional kann über den Group-Identifier (z.B. E85L320ZX) die Rückgabe auf diese Gruppe beschränkt werden. Mehrere Gruppen durch ein Semikolon trennen.

Example Request

curl --location --request GET 'https://app.smartdme.de/api/public/v1/message' \ 
--header 'X-API-KEY: APIKEY_HIER_EINFÜGEN' \ 
--form 'GroupIdentifier="E85L320ZX;J1DX5H50D"'

Example Response

[
    {
        "id": 427,
        "departmentName": "Ortsfeuerwehr Musterstadt",
        "groupId": 28,
        "groupPreMessageText": "Alle",
        "keyword": null,
        "text": "Testmeldung",
        "locationPlain": null,
        "locationStreet": null,
        "locationZip": null,
        "locationCity": null,
        "locationFloor": null,
        "locationResidentName": null,
        "locationLat": 0,
        "locationLng": 0,
        "locationObject": null,
        "locationObjectIdentifier": null,
        "referenceNumber": null,
        "responseRequired": false,
        "information": false,
        "createdOn": "2021-02-03T13:44:36",
        "location": ""
    },
    {
        "id": 426,
        "departmentName": "Ortsfeuerwehr Musterstadt",
        "groupId": 27,
        "groupPreMessageText": "Probealarm",
        "keyword": "Sirenenprobe",
        "text": "Testmeldung",
        "locationPlain": null,
        "locationStreet": null,
        "locationZip": null,
        "locationCity": null,
        "locationFloor": null,
        "locationResidentName": null,
        "locationLat": 0,
        "locationLng": 0,
        "locationObject": null,
        "locationObjectIdentifier": null,
        "referenceNumber": null,
        "responseRequired": false,
        "information": true,
        "createdOn": "2021-02-03T13:15:45",
        "location": ""
    },
    {
        "id": 425,
        "departmentName": "Ortsfeuerwehr Musterstadt",
        "groupId": 28,
        "groupPreMessageText": "Alle",
        "keyword": "Verkehrsunfall",
        "text": "auslaufende Betriebsstoffe",
        "locationPlain": "B247, Musterstadt",
        "locationStreet": "B247",
        "locationZip": null,
        "locationCity": "Musterstadt",
        "locationFloor": null,
        "locationResidentName": null,
        "locationLat": 54.1234,
        "locationLng": 13.45678,
        "locationObject": null,
        "locationObjectIdentifier": null,
        "referenceNumber": null,
        "responseRequired": ´true,
        "information": false,
        "createdOn": "2021-02-03T13:15:04",
        "location": ""
    }
]

GET/{id}

https://app.smartdme.de/api/public/v1/message/{id}

Meldung einer Organisation mit sämtlichen Rückmeldungen empfangen (max. 24 Stunden).

Response (int)

0	keine Reaktion
1	gelesen
2	sofort verfügbar (grün)
3	später verfügbar (gelb)
4	nicht verfügbar (rot)

Example Request

curl --location --request GET 'https://app.smartdme.de/api/public/v1/message/512' \ 
--header 'X-API-KEY: APIKEY_HIER_EINFÜGEN'

Example Response

{
  "responses": [
    {
      "userId": 4,
      "userFirstName": "Daniel",
      "userLastName": "Mustermann",
      "qualificationShort": "San",
      "readOn": "2021-02-03T15:00:30",
      "respondOn": "2021-02-03T15:00:34",
      "response": 2
    },
    {
      "userId": 5,
      "userFirstName": "Oliver",
      "userLastName": "Mustermann",
      "qualificationShort": "Notarzt",
      "readOn": "0001-01-01T00:00:00",
      "respondOn": "0001-01-01T00:00:00",
      "response": 0
    },
    {
      "userId": 7,
      "userFirstName": "Stefan",
      "userLastName": "Mustermann",
      "qualificationShort": "RettSan",
      "readOn": "2021-02-03T15:00:32",
      "respondOn": "2021-02-03T15:00:32",
      "response": 2
    },
    {
      "userId": 8,
      "userFirstName": "Chiristan",
      "userLastName": "Mustermann",
      "qualificationShort": "San",
      "readOn": "2021-02-03T15:00:34",
      "respondOn": "2021-02-03T15:00:38",
      "response": 4
    },
    {
      "userId": 9,
      "userFirstName": "Frank",
      "userLastName": "Mustermann",
      "qualificationShort": "San",
      "readOn": "2021-02-03T15:00:45",
      "respondOn": "2021-02-03T15:00:48",
      "response": 2
    },
    {
      "userId": 2,
      "userFirstName": "Niklas",
      "userLastName": "Mustermann",
      "qualificationShort": "NotfallSan",
      "readOn": "2021-02-03T15:00:36",
      "respondOn": "2021-02-03T15:00:36",
      "response": 2
    },
    {
      "userId": 13,
      "userFirstName": "Thomas",
      "userLastName": "Mustermann",
      "qualificationShort": "NotfallSan",
      "readOn": "0001-01-01T00:00:00",
      "respondOn": "0001-01-01T00:00:00",
      "response": 0
    },
    {
      "userId": 14,
      "userFirstName": "Jan",
      "userLastName": "Mustermann",
      "qualificationShort": "RettSan",
      "readOn": "0001-01-01T00:00:00",
      "respondOn": "0001-01-01T00:00:00",
      "response": 0
    },
    {
      "userId": 17,
      "userFirstName": "Julia",
      "userLastName": "Musterfrau",
      "qualificationShort": "RettSan",
      "readOn": "0001-01-01T00:00:00",
      "respondOn": "0001-01-01T00:00:00",
      "response": 0
    },
    {
      "userId": 1,
      "userFirstName": "Max",
      "userLastName": "Mustermann",
      "qualificationShort": "NotfallSan",
      "readOn": "2021-02-03T15:00:58",
      "respondOn": "2021-02-03T15:00:59",
      "response": 2
    },
    {
      "userId": 408,
      "userFirstName": "Jonas",
      "userLastName": "Mustermann",
      "qualificationShort": "RettSan",
      "readOn": "2021-02-03T15:00:46",
      "respondOn": "2021-02-03T15:01:11",
      "response": 2
    }
  ],
  "id": 428,
  "departmentName": "DRK-Kreisverband Musterort e. V.",
  "groupId": 6,
  "groupPreMessageText": "ALLE",
  "keyword": "Probealarm",
  "text": "Probealarm",
  "locationPlain": null,
  "locationStreet": "1",
  "locationZip": "12345",
  "locationCity": "Musterort",
  "locationFloor": null,
  "locationResidentName": null,
  "locationLat": 52.469451,
  "locationLng": 13.37283,
  "locationObject": "Schöneberger Straße",
  "locationObjectIdentifier": null,
  "referenceNumber": null,
  "responseRequired": true,
  "information": false,
  "createdOn": "2021-02-03T15:00:20",
  "location": "Musterstraße, 1, 123345 Musterort"
}

POST

https://app.smartdme.de/api/public/v1/message

Erstellen einer Meldung. Nur der Group-Identifier wird benötigt. Übrige Felder sind optional.

Example Request

curl --location --request POST 'https://app.smartdme.de/api/public/v1/message' \
--header 'X-API-KEY: APIKEY_HIER_EINFÜGEN' \
--form 'Keyword="Brandmeldeanlage"' \
--form 'Text="Meldergrupp 3/12"' \
--form 'LocationPlain=""' \
--form 'LocationStreet="Hauptstraße 33a"' \
--form 'LocationZip="123456"' \
--form 'LocationCity="Musterort"' \
--form 'LocationFloor=""' \
--form 'LocationResidentName=""' \
--form 'LocationLat="51.588093"' \
--form 'LocationLng="10.167165"' \
--form 'LocationObject="Testfirma GmbH & Co. KG"' \
--form 'LocationObjectIdentifier="98764"' \
--form 'ReferenceNumber="21005412"' \
--form 'ResponseRequired="true"' \
--form 'Information="false"'

Example Response

{
"id": 148,
"identifier": "7ADFCC152FA3235003EA7A1E3E63262444208C85",
"departmentName": "Testorganisation",
"groupId": 7,
"groupPreMessageText": "Einsatzalarm",
"createdUserId": 0,
"keyword": "Brandmeldeanlage",
"text": "Meldergrupp 3/12",
"locationPlain": null,
"locationStreet": "Hauptstraße 33a",
"locationZip": "123456",
"locationCity": "Musterort",
"locationFloor": null,
"locationResidentName": null,
"locationLat": 51.588093,
"locationLng": 10.167165,
"locationObject": "Testfirma GmbH & Co. KG",
"locationObjectIdentifier": "98764",
"referenceNumber": "21005412",
"responseRequired": true,
"information": false,
"alarmTone": 9,
"mapboxStaticTile": null,
"createdOn": "2021-01-17T15:25:47",
"location": ""
}

Message

GET

GET/{id}

Response (int)

POST

INHALT