Endpoints / getRecalls

getRecalls

Recalls abfragen

Recall-Liste, verjoint mit den Kontaktdaten des Patienten. Ohne Filter kommen alle Recalls ausser Vorlagen.

HTTP Request

POST https://dev.vitabyte.ch/v1/recall/getRecalls
Auth basicAuth apiKey

Request Parameters

⚠ Auf Instanzen ohne den Fix aus dem Branch fix/api-broken-endpoints läuft dieser Endpoint in einen Fatal Error (HTTP 500 statt JSON) — und die Filter greifen dort ebenfalls noch nicht.

Parameter Pflicht Typ Beispiel / Default
patid

Grösser als 0 filtert auf einen Patienten.

 optional integer
default: 0
789
from

Recall-Datum ab diesem Tag.

 optional string
2026-01-01
until

Recall-Datum bis zu diesem Tag.

 optional string
2027-12-31
preset

1 liefert nur Vorlagen statt echter Recalls, sortiert nach Name.

 optional integer
enum: 0 | 1
default: 0
error

1 liefert nur fehlerhafte Recalls.

 optional integer
enum: 0 | 1
default: 0
sent

1 liefert nur einmalige Recalls.

 optional integer
enum: 0 | 1
default: 0
mandant

Behandler-Nummer; trifft den ersten, zweiten oder dritten Behandler des Recalls.

 optional integer
default: 0

Response Parameters

Field Typ Beschreibung
id integer Recall-ID
active integer Aktiv-Flag
title string Titel des Recalls
recallDate string Fälligkeit (Datum und Uhrzeit zusammengesetzt)
recallText string Inhalt der Erinnerung
recallType string brief, sms oder mail
recurring integer Wiederkehrend (0/1)
recurringFrequency string Intervall bei wiederkehrenden Recalls
patid integer Patienten-ID
internalComment string Interne Notiz
status string sent, pending oder error
errorMsg string Fehlermeldung beim Versand
customerMobile string Mobilnummer des Patienten
customerMail string Mailadresse des Patienten

Demo

Referenz und Beispiele stammen aus der internen API-Collection — die OpenAPI-Spec deckt diesen Endpoint noch nicht ab.

POST https://dev.vitabyte.ch/v1/recall/getRecalls
Payload
{
    "patid": 789,
    "from": "2026-01-01",
    "until": "2027-12-31",
    "preset": 0,
    "error": 0,
    "sent": 0,
    "mandant": 0
}
Response
{
    "status": true,
    "msg": "Success",
    "result": [
        {
            "id": 42,
            "active": 1,
            "title": "Jahreskontrolle",
            "recallDate": "2027-05-18 09:00:00",
            "recallText": "Es ist Zeit für Ihre jährliche Kontrolle.",
            "recallType": "mail",
            "recurring": 1,
            "recurringFrequency": "12",
            "patid": 789,
            "internalComment": "",
            "status": "pending",
            "errorMsg": "",
            "customerMobile": "+41 79 123 45 67",
            "customerMail": "anna.beispiel@example.ch"
        }
    ]
}