AsyncAPI Dokumentation

Nachrichtensystem - Eventing / ASyncApi documentation

Dies ist die Event-Dokumenation für das Nachrichtensystem. Die Events sind nach der in der Global Decision Event Structure festgelegten Struktur aufgebaut.

Weitere Erläuterungen zum Projekt können dem Domain Vision Statement des Nachrichtensystems entnommen werden.

Table of Contents

• Channels

Channels

Channel Parameters

publish team-3/ausnahmesituation

Message

Headers

Name	Type	Description	Accepted values
id	string		Any
key	string		Any
version	integer		Any
timestamp	string		Any
type	string		Any

Example of headers (generated)

{
  "id": "65cf7091-e3ac-48e7-8553-c329490aae5c",
  "key": "65cf7091-e3ac-48e7-8553-c329490aae5c",
  "version": 42,
  "timestamp": "2019-09-13T23:30:52.123Z",
  "type": "ausnahmesituation-passiert"
}

Payload

Name	Type	Description	Accepted values
ausnahmesituationId	string		Any
positionssenderId	string		Any
text	string		Any
position	object		Any
position.laengengrad	number		Any
position.breitengrad	number		Any
nachrichten	array(object)		Any
nachrichten.nachrichtenId	string		Any
nachrichten.kontaktperson	object		Any
nachrichten.kontaktperson.id	string		Any
nachrichten.kontaktperson.name	string		Any
nachrichten.kontaktperson.vorname	string		Any
nachrichten.kontaktperson.telefonnummer	string		Any
nachrichten.kontaktperson.aktiv	boolean		Any
nachrichten.antwort	object		Any
nachrichten.antwort.antwortId	string		Any
nachrichten.antwort.antwortTyp	string		KANN_HELFEN, KANN_NICHT_HELFEN

Example of payload (generated)

{
  "ausnahmesituationId": "f33c6cd8-1697-11ea-8d71-362b9e155667",
  "positionssenderId": "f33c6cd8-1697-11ea-8d71-362b9e155667",
  "text": "Alarmknopf Herbert wurde gedrückt.",
  "position": {
    "laengengrad": 51.02363,
    "breitengrad": 7.563658
  },
  "nachrichten": [
    {
      "nachrichtenId": "f33c6cd8-1697-11ea-8d71-362b9e155667",
      "kontaktperson": {
        "id": "6cc4e03-4437-4efa-b78d-47defe26e1bd",
        "name": "Maria",
        "vorname": "Mustermaria",
        "telefonnummer": "987654321",
        "aktiv": true
      },
      "antwort": {
        "antwortId": "6cc4e03-4437-4efa-b78d-47defe26e1bd",
        "antwortTyp": "KANN_HELFEN"
      }
    }
  ]
}

Channel Parameters

publish team-3/nachricht

Message

Headers

Name	Type	Description	Accepted values
id	string		Any
key	string		Any
version	integer		Any
timestamp	string		Any
type	string		Any

Example of headers (generated)

{
  "id": "65cf7091-e3ac-48e7-8553-c329490aae5c",
  "key": "65cf7091-e3ac-48e7-8553-c329490aae5c",
  "version": 42,
  "timestamp": "2019-09-13T23:30:52.123Z",
  "type": "ausnahmesituation-passiert"
}

Payload

Name	Type	Description	Accepted values
nachrichtenId	string		Any
kontaktperson	object		Any
kontaktperson.id	string		Any
kontaktperson.name	string		Any
kontaktperson.vorname	string		Any
kontaktperson.telefonnummer	string		Any
kontaktperson.aktiv	boolean		Any
antwort	object		Any
antwort.antwortId	string		Any
antwort.antwortTyp	string		KANN_HELFEN, KANN_NICHT_HELFEN

Example of payload (generated)

{
  "nachrichtenId": "f33c6cd8-1697-11ea-8d71-362b9e155667",
  "kontaktperson": {
    "id": "6cc4e03-4437-4efa-b78d-47defe26e1bd",
    "name": "Maria",
    "vorname": "Mustermaria",
    "telefonnummer": "987654321",
    "aktiv": true
  },
  "antwort": {
    "antwortId": "6cc4e03-4437-4efa-b78d-47defe26e1bd",
    "antwortTyp": "KANN_HELFEN"
  }
}

Channel Parameters

publish team-3/antwort

Message

Headers

Name	Type	Description	Accepted values
id	string		Any
key	string		Any
version	integer		Any
timestamp	string		Any
type	string		Any

Example of headers (generated)

{
  "id": "65cf7091-e3ac-48e7-8553-c329490aae5c",
  "key": "65cf7091-e3ac-48e7-8553-c329490aae5c",
  "version": 42,
  "timestamp": "2019-09-13T23:30:52.123Z",
  "type": "ausnahmesituation-passiert"
}

Payload

Name	Type	Description	Accepted values
antwortId	string		Any
antwortTyp	string		KANN_HELFEN, KANN_NICHT_HELFEN

Example of payload (generated)

{
  "antwortId": "6cc4e03-4437-4efa-b78d-47defe26e1bd",
  "antwortTyp": "KANN_HELFEN"
}