Endpoints / getCustomerById

getCustomerById

Patient anhand der ID abrufen

Voller Patient-Datensatz inkl. Adresse, Mandant, Versicherung, Tags. Optional Felder-Filter via 'fields'.

HTTP Request

POST https://dev.vitabyte.ch/v1/system/getCustomerById

Auth basicAuth apiKey

Request Parameters

Parameter	Pflicht	Typ	Beispiel / Default
`patid`	required	integer	789

Response Parameters

⚠ Envelope-Sonderfall: status ist der String "ok", kein Boolean. language wird aus dem internen Sprachcode gemappt. Fehlende oder ungültige patid: { "status": false, "msg": "Please provide a valid patid" } mit HTTP 200; ohne Treffer msg: "No matches" und result: null.

Field	Typ	Beschreibung
`patid`	integer	Patienten-ID
`lastname`	string	Nachname
`firstname`	string	Vorname
`gender`	string	`male` oder `female`
`dob`	string	Geburtsdatum
`title`	string	Anrede/Titel
`street`	string	Strasse
`zip`	string	PLZ
`city`	string	Ort
`country`	string	Land
`countrycode`	string	Ländercode
`mobile`	string	Mobilnummer
`mail`	string	Mailadresse
`AHV`	string	AHV-Nummer (Feldname in Grossbuchstaben)
`language`	string	ISO 639-1, gemappt aus dem internen Sprachcode
`deleted`	string	Löschflag als String

Demo

Parameter und Beispiele stammen aus der internen API-Collection; die OpenAPI-Spec weicht für diesen Endpoint davon ab.

POST https://dev.vitabyte.ch/v1/system/getCustomerById

Payload

{
    "patid": 789
}

Response

{
    "status": "ok",
    "msg": "1 match",
    "result": {
        "patid": 789,
        "lastname": "Mustermann",
        "firstname": "Max",
        "gender": "male",
        "dob": "1980-02-21",
        "title": "Herr",
        "street": "Musterstrasse 1",
        "zip": "8000",
        "city": "Zürich",
        "country": "Schweiz",
        "countrycode": "CH",
        "mobile": "+41 79 000 00 00",
        "mail": "max@example.com",
        "AHV": "756.0000.0000.00",
        "language": "de",
        "deleted": "0"
    }
}