Zum Hauptinhalt springen

Public API – Prozess, Pause und Abschluss

Prozessschritte setzen, die Automatik pausieren, Trauerfälle archivieren und abschließen.

Verfasst von Support Team

Jeder Trauerfall durchläuft die Prozessschritte seiner Bestattungsart. Viele Schritte schaltet die Automatik selbst weiter, zum Beispiel wenn der RIP Tag verbunden wird oder an der Abholadresse ankommt. Mit diesen Endpunkten steuerst du den Ablauf von außen.

Methode

Pfad

Zweck

POST

/cases/{uuid}/step

Prozessschritt setzen

PATCH

/cases/{uuid} mit paused

Automatik pausieren oder fortsetzen

POST

/cases/{uuid}/archive

Trauerfall archivieren

PATCH

/cases/{uuid} mit status

Archivierten Trauerfall wiederherstellen

POST

/cases/{uuid}/complete

Trauerfall abschließen

Alle Endpunkte antworten mit dem vollständigen Trauerfall – siehe Trauerfälle.

Prozessschritt setzen

POST /cases/{uuid}/step

Setzt den erreichten Prozessschritt von Hand – wie das Abhaken eines Schritts in Web oder App. Die möglichen Schritte stehen im Trauerfall unter steps. current_step_index ist der Index in dieser Liste (0 = erster Schritt).

Body-Parameter

Parameter

Typ

Pflicht

Beschreibung

current_step_index

Integer oder null

ja

Index des erreichten Schritts. null setzt den Fortschritt zurück.

curl -X POST https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47/step \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "current_step_index": 3 }'

Im Beispiel ist damit der Schritt Trauerfeier erreicht.

Antwort 200 OK mit dem Trauerfall in data.

Was dabei passiert:

  • Der Schritt wird im Protokoll des Falls als manuell gesetzt vermerkt – mit dir als handelnder Person.

  • Webhooks, die an diesem Schritt hängen, werden ausgelöst. Das gilt auch, wenn du denselben Schritt erneut setzt oder zu einem früheren Schritt zurückgehst. Siehe Webhooks.

  • Danach prüft die Automatik, ob folgende Schritte schon erfüllt sind, und schaltet gegebenenfalls sofort weiter. Die Antwort zeigt den Stand danach – current_step_index kann also höher sein als der Wert, den du geschickt hast.

  • Du kannst Schritte auch setzen, wenn die Automatik pausiert ist. Weitergeschaltet wird dann nichts.

Denselben Effekt hat current_step_index in PATCH /cases/{uuid}.

Code

error

Ursache

400

current_step_index ist erforderlich

Feld fehlt im Body

400

Keine Bestattungsart zugewiesen

Der Fall hat keine Bestattungsart

400

Ungueltiger Schrittindex

Index kleiner als 0 oder größer als der letzte Schritt

404

Sterbefall nicht gefunden

UUID unbekannt

Automatik pausieren und fortsetzen

PATCH /cases/{uuid}

Entspricht Automatik pausieren im Menü des Falls. Sinnvoll, wenn der RIP Tag vorübergehend an einem Ort ist, der keine Schritte auslösen soll.

Body-Parameter

Parameter

Typ

Pflicht

Beschreibung

paused

Boolean

ja

true pausiert, false setzt fort

Schicke paused allein. Enthält der Body paused, werden alle anderen Felder ignoriert.

curl -X PATCH https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47 \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "paused": true }'

Antwort 200 OK mit dem Trauerfall. is_paused ist jetzt 1.

Während der Pause:

  • schaltet die Automatik keine Schritte weiter – weder über den RIP Tag noch über Adressen oder Orte,

  • bleibt die Position des RIP Tags auf dem letzten Stand vor der Pause, im Fall und im Link für Angehörige,

  • kannst du Schritte weiterhin von Hand setzen.

Nach dem Fortsetzen zählen nur neue Sichtungen. Was während der Pause passiert ist, wird nicht nachgeholt. Pause und Fortsetzen erscheinen im Protokoll des Falls. Ist der Fall schon pausiert, ändert ein weiteres "paused": true nichts.

Code

error

Ursache

404

Sterbefall nicht gefunden

UUID unbekannt

409

Abgeschlossene Trauerfälle können nicht pausiert werden

Fall ist abgeschlossen

Trauerfall archivieren

POST /cases/{uuid}/archive

Archiviert den Trauerfall. Ein Body ist nicht nötig.

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

Antwort 200 OK mit dem Trauerfall. status ist jetzt archived.

Ein archivierter Trauerfall:

  • erscheint nicht mehr in GET /cases, nur noch mit ?status=archived,

  • ist über den Link für Angehörige nicht mehr erreichbar,

  • wird von der Automatik nicht mehr weitergeschaltet,

  • kann keinen neuen RIP Tag bekommen.

Archivieren schließt den Fall nicht ab und trennt keinen RIP Tag. Wiederholst du den Aufruf, bleibt der Fall archiviert.

Wiederherstellen

curl -X PATCH https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47 \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "active" }'

Trauerfall abschließen

POST /cases/{uuid}/complete

Entspricht Trauerfall abschließen in Web und App: Du hinterlegst die letzte Ruhestätte, und der Fall gilt als erledigt.

Body-Parameter

Parameter

Typ

Pflicht

Beschreibung

burial_latitude

Number

ja

Breitengrad der Ruhestätte. 0 ist nicht erlaubt.

burial_longitude

Number

ja

Längengrad der Ruhestätte. 0 ist nicht erlaubt.

burial_address

String

nein

Adresse oder Beschreibung, zum Beispiel der Friedhof

burial_note

String

nein

Notiz zur Ruhestätte, zum Beispiel die Grabnummer. Angehörige sehen sie. Max. 500 Zeichen.

curl -X POST https://de.rip-app.business/api/public/v1/cases/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47/complete \
  -H "Authorization: Bearer $RIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "burial_latitude": 52.50431,
    "burial_longitude": 13.25912,
    "burial_address": "Waldfriedhof Lindenhain, Am Hain 3, 14055 Berlin",
    "burial_note": "Urnengrab, Feld C, Nr. 14"
  }'

Antwort 200 OK

{
  "success": true,
  "data": {
    "uuid": "3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47",
    "deceased_name": "Gisela Neumann",
    "completed_at": "2026-11-21 15:04:37",
    "burial_latitude": "52.50431000",
    "burial_longitude": "13.25912000",
    "burial_address": "Waldfriedhof Lindenhain, Am Hain 3, 14055 Berlin",
    "burial_note": "Urnengrab, Feld C, Nr. 14",
    "tag_uuid": null,
    "tag_startcode": null,
    "status": "active",
    "customer_link_url": "https://de.rip-app.business/t/3f8c2a91-6d4e-4b7a-9c15-8e2f0b6d1a47"
  }
}

Das Beispiel ist gekürzt.

Was beim Abschließen passiert:

  • completed_at wird gesetzt.

  • Der RIP Tag wird vom Fall getrennt und als verwendet markiert. Er lässt sich danach für keinen anderen Fall mehr aktivieren. tag_uuid und tag_startcode sind null.

  • Der Link für Angehörige zeigt statt der Live-Position die Ruhestätte und die Notiz.

  • Die Automatik schaltet nicht mehr weiter, und der Fall lässt sich nicht mehr pausieren.

  • Der Fall bleibt in GET /cases, bis du ihn archivierst.

burial_note kannst du auch nach dem Abschluss mit PATCH /cases/{uuid} ändern.

Code

error

Ursache

400

Bestattungsort (Koordinaten) ist erforderlich

Koordinaten fehlen oder sind 0

404

Sterbefall nicht gefunden

UUID unbekannt

409

Dieser Trauerfall ist bereits abgeschlossen.

Fall wurde schon abgeschlossen

Hat dies deine Frage beantwortet?