Zum Hauptinhalt springen
GET
Gibt einen paginierten Katalog der Biomarker zurück, die dein API-Schlüssel für eine Herkunft bestellen kann. Füge sie zu Terminen oder Heimtest-Kits hinzu. Archivierte Biomarker sind ausgeschlossen. Ein Biomarker erscheint in der Liste, wenn eine Bestellung bei einem Labor, das dein Schlüssel nutzen darf, ihn liefert und die Bestellung ausschließlich Probengefäße nutzt, die für diese Herkunft verfügbar sind. Die Probenröhrchen entscheiden, nicht der Analyttyp. Erfordert den Scope panels_access. Für das pricing-Objekt ist zusätzlich der Scope prices_view erforderlich.

Anfrage

Query-Parameter

Die Herkunft hat eine von zwei Formen: ein Teststandort oder ein Heimtest-Kit. Sende genau eine. Keine oder beide geben 400 zurück.
string
erforderlich
Der Standort, an dem die Blutabnahmen für die Termine stattfinden. Ein Biomarker erscheint in der Liste, wenn seine Bestellung ausschließlich Probengefäße nutzt, die dieser Standort führt. Gleiche dies mit Standorte auflisten ab.
string
Überschreibe, welche Preisliste price_cents verwendet: retail oder die id einer Preisliste, die dein Schlüssel nutzen darf. Preisliste abrufen gibt diese id zurück. Standardmäßig gilt die Preisliste des Abrechnungskontos deines API-Schlüssels, sonst die Endkunden-Preisliste. retail_cents verwendet immer die Endkunden-Preisliste.
number
Maximale Anzahl zurückgegebener Ergebnisse (1–1.000). Lasse den Parameter weg, um den gesamten passenden Katalog zurückzugeben – er ist begrenzt (höchstens einige tausend Zeilen). Wenn er weggelassen wird, gibt pagination.limit den Wert von total zurück.
number
Standard:"0"
Paginierungs-Offset. Muss ≥ 0 sein.

Antwort

Biomarker[]
Array der Biomarker, die der Abfrage entsprechen.
object

Preisobjekte

Preisangaben haben überall dieselbe Struktur – bei Biomarkern, Panels, der Vorschau für Termine und einem Angebot. Preise erklärt das Modell dahinter; dies ist die Feldreferenz. Jeder Betrag wird als Ganzzahl in Cent angegeben.
integer | null
Was dies laut deiner Preisliste kostet. 0 ist ein echter Preis von null – der Artikel wird nicht einzeln verkauft, und der requires- oder positions-Block daneben gibt an, wie er stattdessen verkauft wird. null ist etwas anderes: Aniva hat keinen Preis dafür festgelegt, der Artikel ist nicht kostenfrei, kann nicht bestellt werden und fließt in keine Summe ein.
integer | null
Derselbe Betrag laut empfohlener Endkunden-Preisliste. Immer vorhanden; entspricht price_cents, wenn dein Schlüssel bereits die Endkunden-Preisliste nutzt.
"routine" | "specialty"
Welcher der beiden Aniva-Tarife deiner Preisliste diesen Marker bepreist hat. Nur vorhanden, wenn er einen eigenen Preis hat.
object[]
Die kommerziellen Angebote, die diesen Biomarker enthalten, das günstigste zuerst. Bei price_cents: 0 sind sie die einzige Möglichkeit, ihn zu bestellen; bei einem positiven price_cents sind sie die Bundles, zu denen er zusätzlich gehört. Eine Position wird einmal abgerechnet und immer vollständig geliefert.
string
Stabile Positions-ID. Verknüpft mit via_position auf einer Terminrechnung.
string
Positionsname für Partner.
integer | null
Was die gesamte Position in deiner Preisliste kostet, einmalig abgerechnet. retail_cents steht daneben.
number[]
Jeder Biomarker, den die Position liefert, einschließlich des abgefragten.
number[]
Alle weiteren Bestandteile außer dem abgefragten Biomarker – was beim Kauf mitgeliefert wird.
object[]
Vorhanden, wenn dieser Biomarker ein Verhältnis ist. Bei der Bestellung landen diese Komponenten zu ihren eigenen Preisen im Warenkorb, und jede Komponente wird pro Warenkorb nur einmal bezahlt, egal wie viele Verhältnisse sie nutzen. Die eigenen price_cents des Verhältnisses werden zusätzlich zu seinen Komponenten berechnet. Die meisten Verhältnisse kosten 0. Jeder Eintrag enthält id, name, price_cents und retail_cents.Ein Verhältnis, bei dem nicht alle Komponenten einen Preis haben, fehlt komplett im Katalog – es erscheint nie mit price_cents: null.
Panels haben nur price_cents und retail_cents: Ein Panel hat einen einzigen Katalogpreis und keine Positionen oder Komponenten.

Fehlerantworten