Eine oder mehrere Kontaktpersonen erstellen¶

Note

Diese Anfrage steht nur Administratoren der Root-Gruppe der Organisation zur Verfügung.

Senden einer POST-Anfrage an den Endpunkt /organization/contacts.

Beschreibung¶

Mit der Create-Organization-Contacts-Anfrage erstellen Sie eine oder mehrere Kontaktpersonen für die Organisation.

Voraussetzungen¶

Werte der Anfrage: keine Objekte: OrganizationContactVO

Anfrage¶

Um Kontaktpersonen zu erstellen, senden Sie eine POST-Anfrage an den Endpunkt. Anders als bei den meisten anderen Create-Anfragen ist der Body kein einzelnes Objekt, sondern ein einfaches JSON-Array mit einem oder mehreren OrganizationContactVO-Objekten, zum Beispiel [{...}, {...}]. Jedes Objekt darf das Attribut id nicht enthalten und muss die folgenden Attribute definieren:

Attribut	Beschreibung	Werte
`email`	Die E-Mail-Adresse der Kontaktperson.	`string`
`receiveSSLReminders`	Legt fest, ob die Kontaktperson Benachrichtigungen über ablaufende Zertifikate erhält.	`true` `false`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`userId`	Die ID des Nutzers, der mit diesem Eintrag verknüpft ist, falls die Kontaktperson ein Nutzer der Myra App ist.	`integer`
`name`	Der Name der Kontaktperson.	`string`
`phone`	Die Telefonnummer der Kontaktperson.	`string`
`technicalPriority`	Legt die Priorität der Kontaktperson für technische Anliegen fest.	`integer` (1-6)
`escalationPriority`	Legt die Priorität der Kontaktperson für Eskalationen fest.	`integer` (1-6)

Das System gibt die erstellten OrganizationContactVO-Objekte zurück, jeweils erweitert um die vom Server gesetzten Attribute id, created und modified. Jede erstellte Kontaktperson wird automatisch mit der Organisation des authentifizierten Nutzenden verknüpft; das Objekt bietet kein Attribut, um die Organisation explizit festzulegen.

Beispiel¶

Beispiel-Request-Body:

[
  {
    "userId": 123,
    "name": "Jane Doe",
    "email": "jane.doe@example.com",
    "phone": "+49 30 1234567",
    "receiveSSLReminders": true,
    "technicalPriority": 1,
    "escalationPriority": 1
  }
]

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
201	Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt.
400	Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.