Endpoints / getDocuments

getDocuments

Dokumente eines Patienten auflisten

Listet alle Dateien im Patientenordner rekursiv mit Metadaten — ohne Inhalt. Den Inhalt liefert getAttachment anhand des md5.

HTTP Request

POST https://dev.vitabyte.ch/v1/dc/getDocuments

Auth basicAuth apiKey

Request Parameters

Parameter	Pflicht	Typ	Beispiel / Default
`patid` 0 führt zum Fehler "PATID is missing.".	required	integer	789

Response Parameters

⚠ Envelope-Sonderfall: die Liste steht in results (Plural), nicht in result.
⚠ Das Ergebnis wird 30 Sekunden gecacht — eine gerade per uploadAttachment hochgeladene Datei kann kurz fehlen.

Field	Typ	Beschreibung
`name`	string	Dateiname
`date`	string	Dokumentendatum
`md5`	string	Datei-Identifier für getAttachment
`folder`	string	Pfad relativ zum Patientenordner; leer = direkt darin
`size`	integer	Grösse in Bytes
`type`	string	Dateiendung

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/dc/getDocuments

Payload

{
    "patid": 789
}

Response

{
    "status": true,
    "results": [
        {
            "name": "befund.pdf",
            "date": "2026-07-28",
            "md5": "a3f5effbaf4b369f085809cac9c42845",
            "folder": "Berichte",
            "size": 12345,
            "type": "pdf"
        },
        {
            "name": "anmeldung.pdf",
            "date": "2026-03-17",
            "md5": "9fdddb5b0c2cba64c96108e5e1c41ab6",
            "folder": "",
            "size": 723033,
            "type": "pdf"
        }
    ]
}