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
| Parameter | Pflicht | Typ | Beispiel / Default |
|---|---|---|---|
kinds
|
required | array | |
ispatient
Beeinflusst flags/categories/nextSteps/issues |
optional |
integer enum: 0 | 1
|
Response Parameters
| 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
POST
https://dev.vitabyte.ch/v1/sales/getReferenceData
Payload
{
"kinds": [
"sources",
"flags",
"disqualification"
],
"ispatient": 1
}
Response