Endpoints / modifyAppointment

modifyAppointment

Termin ändern

Ändert einen bestehenden Termin. Die appointmentid liefert createAppointment.

HTTP Request

POST https://dev.vitabyte.ch/v1/agenda/modifyAppointment

Auth basicAuth apiKey

Request Parameters

⚠ Kein PATCH — der Datensatz wird überschrieben. Nach der Prüfung der appointmentid läuft dieselbe Logik wie bei createAppointment: nicht mitgeschickte Felder werden mit Leerwerten überschrieben (Termintext, Kommentar, sichtbare Dauer, Status) bzw. auf 0 gesetzt (patid, deleted). Deshalb immer den vollständigen Feldsatz senden. Einzige Ausnahme: calendar = 0 lässt den Kalender unverändert.

Parameter	Pflicht	Typ	Beispiel / Default
`appointmentid` Muss existieren, sonst kommt "The appointment id is invalid".	required	integer	12345
`calendar` 0 = Kalender bleibt unverändert.	optional	integer	default: `0` 2
`date` Beginn. Alternative zu dateTs.	optional	string	2026-06-01 10:00:00
`end` Ende. Alternative zu endTs.	optional	string	2026-06-01 10:30:00
`patid` Wird ohne Angabe auf 0 zurückgesetzt.	optional	integer	default: `0` 789
`appointment` Termintext.	optional	string	Konsultation
`comment` Kommentar zum Termin.	optional	string
`displayedduration` Sichtbare Dauer in Minuten.	optional	string
`state` Terminstatus wie bei createAppointment.	optional	string enum: P \| W \| 1 \| 2 \| -1 \| -2
`deleted` 1 markiert den Termin als gelöscht.	optional	integer enum: 0 \| 1	default: `0`

Response Parameters

⚠ Im Update-Fall ist result immer null — es kommt keine appointmentid zurück. Fehler kommen mit HTTP 200.

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/agenda/modifyAppointment Erfolgsfall

Payload

{
    "appointmentid": 12345,
    "patid": 789,
    "calendar": 0,
    "date": "2026-06-01 10:00:00",
    "end": "2026-06-01 10:30:00",
    "appointment": "Konsultation (verschoben)",
    "comment": "via API verschoben",
    "state": "",
    "displayedduration": "",
    "deleted": 0
}

Response

{
    "status": true,
    "msg": "Success",
    "result": null
}

POST https://dev.vitabyte.ch/v1/agenda/modifyAppointment Fehlerfall — unbekannte appointmentid

Payload

{
    "appointmentid": 99999,
    "calendar": 2,
    "date": "2026-06-01 10:00:00",
    "end": "2026-06-01 10:30:00"
}

Response

{
    "status": false,
    "msg": "The appointment id is invalid"
}