Endpoints / getCustomerByAHV

getCustomerByAHV

Patient anhand AHV-Nummer suchen

Match auf tblPatienten.ahvnummer (13-stellige Schweizer AHV-Nummer). Für Versicherungs-Integrationen.

HTTP Request

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

Auth basicAuth apiKey

Request Parameters

Parameter	Pflicht	Typ	Beispiel / Default
`ahv` Exact-Match, genau in der Schreibweise wie im Patientenstamm hinterlegt (inklusive Punkte).	required	string	756.0000.0000.00

Response Parameters

⚠ Envelope-Sonderfall: status ist der String "ok", kein Boolean. result ist ein Array mit 0..N Treffern, Felder wie bei getCustomerById. Leerer Wert: { "status": false, "msg": "Please provide an ahv number" }, HTTP 200.

Field	Typ	Beschreibung
`patid`	integer	Patienten-ID
`lastname`	string	Nachname
`firstname`	string	Vorname
`gender`	string	`male` oder `female`
`dob`	string	Geburtsdatum
`AHV`	string	AHV-Nummer (Feldname in Grossbuchstaben)
`language`	string	ISO 639-1
`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/getCustomerByAHV

Payload

{
    "ahv": "756.0000.0000.00"
}

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"
        }
    ]
}