modifyAppointment
Termin ändern
Ändert einen bestehenden Termin. Die appointmentid liefert createAppointment.
HTTP Request
https://dev.vitabyte.ch/v1/agenda/modifyAppointment
Request Parameters
PATCH-Semantik: nur mitgesendete Felder werden geändert, alle anderen behalten ihren gespeicherten Wert. Mitgesendete leere Werte gelten (z. B. "comment": "" leert den Kommentar). Wird nur date geschickt, wird der Termin mit gleicher Dauer verschoben. calendar = 0 lässt den Kalender unverändert.
Löschen: { "appointmentid": 12345, "deleted": 1 } genügt.locked sperrt oder entsperrt den Termin in der E-PAT-Agenda (siehe createAppointment); ohne Angabe bleibt die Sperre, wie sie ist. Termine aus anderen Quellen (abonnierte Kalender, OneDoc) lassen sich so nicht sperren.
| 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:
02
|
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
Ohne Angabe bleibt der Patient unverändert; 0 entfernt ihn. |
optional | integer |
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
|
|
color
Hintergrundfarbe; ohne Angabe bleibt die gespeicherte Farbe. |
optional | string | |
locked
1 sperrt, 0 entsperrt den Termin in der E-PAT-Agenda. Ohne Angabe unverändert. |
optional |
integer enum: 0 | 1
|
Response Parameters
⚠ Im Update-Fall ist result immer null - es kommt keine appointmentid zurück. Fehler kommen mit HTTP 200, u. a. "locked must be 0 or 1" und "The lock of this appointment cannot be changed (source '…')" für Termine aus anderen Quellen - dann wird nichts geändert.
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
{
"appointmentid": 12345,
"date": "2026-06-01 10:00:00",
"comment": "via API verschoben"
}
{
"status": true,
"msg": "Success",
"result": null
}
POST
https://dev.vitabyte.ch/v1/agenda/modifyAppointment
Sperre aufheben
{
"appointmentid": 12345,
"locked": 0
}
{
"status": true,
"msg": "Success",
"result": null
}
POST
https://dev.vitabyte.ch/v1/agenda/modifyAppointment
Fehlerfall - unbekannte appointmentid
{
"appointmentid": 99999,
"calendar": 2,
"date": "2026-06-01 10:00:00",
"end": "2026-06-01 10:30:00"
}
{
"status": false,
"msg": "The appointment id is invalid"
}