Endpoints / getReferenceData

getReferenceData

Lookup-Listen (sources, flags, …) in einem Call

Ein Endpoint statt 6 separate Calls. Liefert nur die in 'kinds' angeforderten Lookups.

HTTP Request

POST https://dev.vitabyte.ch/v1/sales/getReferenceData

Auth basicAuth apiKey

Request Parameters

Verfügbare kinds: sources, flags, disqualification, categories, nextSteps, issues. ispatient entscheidet, welche Gruppe geladen wird — Patient- und Kontakt-Pipeline haben getrennte Listen für flags, categories, nextSteps und issues.

Parameter	Pflicht	Typ	Beispiel / Default
`kinds`	required	array
`ispatient` Beeinflusst flags/categories/nextSteps/issues	optional	integer enum: 0 \| 1

Response Parameters

Geliefert werden nur die angeforderten Listen, jeweils als Paare aus code und label. Fehler: HTTP 400 Provide a non-empty kinds array.

Field	Typ	Beschreibung
`status`	boolean	true bei Erfolg, false bei Fehler
`msg`	string	Kurzbeschreibung des Resultats / der Fehlerursache
`result`		Endpoint-spezifisches Resultat. Typ je nach Endpoint (Object, Array, Skalar oder null).
`pagination`		Nur bei Listen-Endpoints gesetzt

Demo

Beispiel-Response handgepflegt — die OpenAPI-Spec liefert für diesen Endpoint noch kein Response-Example.

POST https://dev.vitabyte.ch/v1/sales/getReferenceData

Payload

{
    "kinds": [
        "sources",
        "flags",
        "disqualification",
        "categories",
        "nextSteps",
        "issues"
    ],
    "ispatient": 1
}

Response

{
    "status": true,
    "msg": "Success",
    "result": {
        "sources": [
            {
                "code": "I",
                "label": "Internet"
            },
            {
                "code": "M",
                "label": "Marketing"
            },
            {
                "code": "T",
                "label": "Telefon"
            }
        ],
        "flags": [
            {
                "code": "VIP",
                "label": "VIP"
            },
            {
                "code": "Rueckruf",
                "label": "Rückruf gewünscht"
            }
        ],
        "disqualification": [
            {
                "code": "PRICE",
                "label": "Zu teuer"
            },
            {
                "code": "NOFIT",
                "label": "Kriterien nicht erfüllt"
            },
            {
                "code": "OTHER",
                "label": "Anderer Grund"
            }
        ],
        "categories": [
            {
                "code": "Telefon",
                "label": "Telefon"
            },
            {
                "code": "Mail",
                "label": "Mail"
            }
        ],
        "nextSteps": [
            {
                "code": "CALL",
                "label": "Telefonat vereinbaren"
            }
        ],
        "issues": [
            {
                "code": "KNEE",
                "label": "Knie"
            }
        ]
    }
}