Zum Hauptinhalt springen

Public API – Termine

Termine eines Trauerfalls auflisten, anlegen, ändern und löschen – frei oder an einen Prozessschritt gebunden.

Verfasst von Support Team

Termine hängen an einem Trauerfall, zum Beispiel das Trauergespräch oder die Trauerfeier. Öffentliche Termine sehen Angehörige im Link. Termine sind reine Planung: Sie schalten den Prozess nie weiter.

Methode

Pfad

Zweck

GET

/cases/{uuid}/dates

Termine eines Trauerfalls auflisten

POST

/cases/{uuid}/dates

Termin anlegen

PATCH

/dates/{uuid}

Termin ändern

DELETE

/dates/{uuid}

Termin löschen

Es gibt zwei Arten von Terminen:

  • Freie Termine haben eine eigene Bezeichnung, zum Beispiel „Trauergespräch“.

  • Schritt-Termine gehören zu einem Prozessschritt, zum Beispiel Trauerfeier. Pro Schritt und Fall gibt es höchstens einen. Die Schritte mit Termin erkennst du am Trauerfall in steps an collect_date: 1.

Das Termin-Objekt

Feld

Typ

Beschreibung

uuid

String

Eindeutige Kennung. Nutze sie für PATCH und DELETE.

id

Integer

Interne ID

case_id

Integer

Interne ID des Trauerfalls (id im Trauerfall)

step_id

Integer oder null

Prozessschritt bei Schritt-Terminen, sonst null

step_name

String oder null

Name des Schritts

step_position

Integer oder null

Position des Schritts

label

String oder null

Bezeichnung. Bei freien Terminen immer gesetzt.

scheduled_at

String

Zeitpunkt, YYYY-MM-DD HH:MM:SS, Ortszeit

has_time

Integer

1 = Uhrzeit ist relevant, 0 = nur das Datum zählt

is_public

Integer

1 = im Link für Angehörige sichtbar

location_address

String oder null

Ort als Text

location_latitude, location_longitude

Number oder null

Koordinaten des Orts

location_place_id

String oder null

Google-Places-ID, falls vorhanden

advance_on_date

Integer

Veraltet, immer 0

created_at, updated_at

String

Angelegt bzw. geändert am

Bei has_time: 0 zählt nur das Datum. Die Uhrzeit in scheduled_at hat dann keine Bedeutung (meist 00:00:00) – zeige nur das Datum an.

Termine auflisten

GET /cases/{uuid}/dates

Liefert alle Termine des Trauerfalls, sortiert nach Zeitpunkt – freie und Schritt-Termine gemeinsam.

curl https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47/dates \
  -H "Authorization: Bearer $RIP_API_KEY"

Antwort 200 OK

{
  "success": true,
  "count": 2,
  "data": [
    {
      "id": 5521,
      "uuid": "7b1e4d2a-9c3f-4a8e-b5d6-0f2c8e1a4b93",
      "case_id": 1287,
      "step_id": null,
      "label": "Trauergespräch",
      "scheduled_at": "2026-11-12 10:00:00",
      "has_time": 1,
      "is_public": 0,
      "advance_on_date": 0,
      "location_address": "Bestattungen Berger, Lindenallee 12, 14050 Berlin",
      "location_latitude": null,
      "location_longitude": null,
      "location_place_id": null,
      "created_at": "2026-11-10 14:40:12",
      "updated_at": "2026-11-10 14:40:12",
      "step_name": null,
      "step_position": null
    },
    {
      "id": 5524,
      "uuid": "c8d2f1a4-6e3b-4c9a-a7f5-3b1e9d0c2a68",
      "case_id": 1287,
      "step_id": 44,
      "label": null,
      "scheduled_at": "2026-11-20 11:00:00",
      "has_time": 1,
      "is_public": 1,
      "advance_on_date": 0,
      "location_address": "Kapelle Waldfriedhof Lindenhain, Am Hain 3, 14055 Berlin",
      "location_latitude": 52.50412,
      "location_longitude": 13.25876,
      "location_place_id": null,
      "created_at": "2026-11-11 09:05:31",
      "updated_at": "2026-11-11 09:05:31",
      "step_name": "Trauerfeier",
      "step_position": 3
    }
  ]
}

Code

error

Ursache

404

Sterbefall nicht gefunden

UUID des Falls unbekannt

Termin anlegen

POST /cases/{uuid}/dates

Body-Parameter

Parameter

Typ

Pflicht

Beschreibung

scheduled_at

String

ja

YYYY-MM-DD, YYYY-MM-DD HH:MM oder YYYY-MM-DD HH:MM:SS. Statt des Leerzeichens ist auch T erlaubt. Ortszeit, ohne Zeitzone.

label

String

ja, ohne step_id

Bezeichnung, max. 255 Zeichen

step_id

Integer

nein

ID eines Schritts aus steps des Trauerfalls. Macht den Termin zum Schritt-Termin.

has_time

0 oder 1

nein

Uhrzeit relevant. Standard: 0

is_public

0 oder 1

nein

Im Link für Angehörige sichtbar. Standard: 1

location_address

String

nein

Ort als Text, max. 500 Zeichen

location_latitude

Number

nein

Breitengrad (−90 bis 90)

location_longitude

Number

nein

Längengrad (−180 bis 180)

location_place_id

String

nein

Google-Places-ID

Koordinaten außerhalb des gültigen Bereichs werden ohne Fehlermeldung verworfen. advance_on_date wird noch angenommen, aber immer als 0 gespeichert.

Freier Termin

curl -X POST https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47/dates \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Trauergespräch",
    "scheduled_at": "2026-11-12 10:00",
    "has_time": 1,
    "is_public": 0,
    "location_address": "Bestattungen Berger, Lindenallee 12, 14050 Berlin"
  }'

Schritt-Termin

curl -X POST https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47/dates \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "step_id": 44,
    "scheduled_at": "2026-11-20 11:00",
    "has_time": 1,
    "location_address": "Kapelle Waldfriedhof Lindenhain, Am Hain 3, 14055 Berlin",
    "location_latitude": 52.50412,
    "location_longitude": 13.25876
  }'

Antwort 201 Created mit dem Termin in data.

Schritt-Termine werden ersetzt. Hat der Fall für diesen Schritt schon einen Termin, überschreibt der Request ihn und behält seine uuid. Die Antwort ist trotzdem 201. Felder, die du dabei weglässt, fallen auf den Standard zurück (has_time: 0, is_public: 1, keine Bezeichnung). Den Ort behält der Termin nur, wenn du keine Ort-Felder schickst. Für Teiländerungen nutze PATCH.

Code

error

Ursache

400

Ungueltiger oder fehlender Termin

scheduled_at fehlt oder hat ein falsches Format

400

Bitte eine Bezeichnung fuer den Termin angeben

Freier Termin ohne label

400

Bezeichnung darf maximal 255 Zeichen lang sein

label zu lang

400

Prozess-Schritt nicht gefunden

step_id gehört zu keiner Bestattungsart deines Unternehmens

404

Sterbefall nicht gefunden

UUID des Falls unbekannt

Termin ändern

PATCH /dates/{uuid}

Ändert die Felder, die du mitschickst. Die Art des Termins (frei oder Schritt) und der Fall lassen sich nicht ändern.

Body-Parameter

Parameter

Typ

Beschreibung

scheduled_at

String

Neuer Zeitpunkt, Formate wie beim Anlegen

label

String

Neue Bezeichnung. Bei freien Terminen darf sie nicht leer sein.

has_time

0 oder 1

Uhrzeit relevant

is_public

0 oder 1

Im Link für Angehörige sichtbar

location_address, location_latitude, location_longitude, location_place_id

wie beim Anlegen

Ort

Ort immer vollständig schicken. Sobald eines der vier Ort-Felder im Body steht, ersetzt die API den ganzen Ort. Fehlende Ort-Felder werden geleert. Schickst du alle vier leer oder null, entfernst du den Ort.

curl -X PATCH https://de.rip-app.business/api/public/v1/dates/c8d2f1a4-6e3b-4c9a-a7f5-3b1e9d0c2a68 \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "scheduled_at": "2026-11-20 13:30", "has_time": 1 }'

Antwort 200 OK mit dem geänderten Termin in data.

Code

error

Ursache

400

Keine Änderungen angegeben

Kein bekanntes Feld im Body

400

Ungueltiger Termin

scheduled_at im falschen Format

400

Bitte eine Bezeichnung fuer den Termin angeben

Leere Bezeichnung bei einem freien Termin

404

Termin nicht gefunden

UUID unbekannt

Termin löschen

DELETE /dates/{uuid}

Löscht den Termin endgültig.

curl -X DELETE https://de.rip-app.business/api/public/v1/dates/7b1e4d2a-9c3f-4a8e-b5d6-0f2c8e1a4b93 \
  -H "Authorization: Bearer $RIP_API_KEY"

Antwort 200 OK

{ "success": true, "message": "Termin geloescht" }

Code

error

Ursache

404

Termin nicht gefunden

UUID unbekannt oder schon gelöscht

Gut zu wissen

  • Termine bleiben erhalten, wenn du die Bestattungsart wechselst. Schritt-Termine der alten Bestattungsart werden dabei zu freien Terminen mit dem Schrittnamen als Bezeichnung.

  • Archivierte und abgeschlossene Fälle können weiterhin Termine haben und bekommen.

  • Webhooks gibt es für Termine nicht. Sie reagieren nur auf erreichte Prozessschritte.

Hat dies deine Frage beantwortet?