Naar hoofdinhoud gaan
GET
Geeft een gepagineerde catalogus terug van de biomarkers die je API-sleutel voor één herkomst kan bestellen. Koppel ze aan afspraken of aan thuistestkits. Gearchiveerde biomarkers worden uitgesloten. Een biomarker verschijnt in de lijst als een aanvraag bij een lab dat je sleutel mag gebruiken deze levert, en de aanvraag alleen afnamematerialen gebruikt die beschikbaar zijn voor deze herkomst. De monsterbuisjes zijn bepalend, niet het type analyt. Vereist de scope panels_access. Het pricing-object vereist ook de scope prices_view.

Verzoek

Queryparameters

De herkomst heeft één van twee vormen: een testlocatie of een thuistestkit. Stuur er precies één mee. Geen of beide geeft 400 terug.
string
vereist
De locatie waar de bloedafnames voor de afspraken plaatsvinden. Een biomarker verschijnt in de lijst als de aanvraag alleen afnamematerialen gebruikt die deze locatie heeft. Koppel dit aan Locaties weergeven.
string
Overschrijf welke tariefkaart price_cents gebruikt: retail, of het id van een tariefkaart die je sleutel mag gebruiken. Tariefkaart ophalen geeft dat id terug. Standaard wordt de kaart van het factuuraccount van je API-sleutel gebruikt, anders retail. retail_cents gebruikt altijd de retail-tariefkaart.
number
Maximaal aantal resultaten om terug te geven (1–1.000). Laat dit weg om de hele overeenkomende catalogus terug te geven — deze is begrensd (hooguit enkele duizenden rijen). Wanneer weggelaten, geeft pagination.limit de waarde van total terug.
number
standaard:"0"
Paginerings-offset. Moet ≥ 0 zijn.

Respons

Biomarker[]
Array van biomarkers die overeenkomen met de query.
object

Prijsobjecten

Prijzen hebben overal waar ze voorkomen dezelfde structuur — biomarkers, panels, de voorvertoning van een afspraak en een offerte. Prijzen legt het model erachter uit; dit is het veldoverzicht. Elk bedrag is een geheel aantal centen.
integer | null
Wat dit kost op jouw tariefkaart. 0 is een echte prijs van nul — het item wordt niet los verkocht, en het requires- of positions-blok ernaast geeft aan hoe het wel wordt verkocht. null is anders: Aniva heeft geen prijs ingesteld, het is niet kosteloos, het kan niet worden besteld en het telt niet mee in een totaal.
integer | null
Hetzelfde bedrag volgens de aanbevolen retail-tariefkaart. Altijd aanwezig; gelijk aan price_cents wanneer je sleutel al op de retail-tariefkaart staat.
"routine" | "specialty"
Welk van de twee Aniva-tarieven van je kaart de prijs van deze marker bepaalt. Alleen aanwezig wanneer de marker een eigen prijs heeft.
object[]
De commerciële aanbiedingen die deze biomarker bevatten, goedkoopste eerst. Bij price_cents: 0 zijn dit de enige manieren om de biomarker te bestellen; bij een positieve price_cents zijn dit de bundels waar deze ook deel van uitmaakt. Een positie wordt één keer in rekening gebracht en altijd volledig geleverd.
string
Stabiele positie-ID. Koppelt aan via_position op een afspraakfactuur.
string
Positienaam voor partners.
integer | null
Wat de hele positie op jouw tariefkaart kost, eenmalig gefactureerd. retail_cents staat ernaast.
number[]
Elke biomarker die de positie levert, inclusief degene die je opvroeg.
number[]
De onderdelen naast de biomarker die je opvroeg — wat je erbij krijgt als je deze koopt.
object[]
Aanwezig wanneer deze biomarker een ratio is. Als je deze bestelt, komen deze onderdelen tegen hun eigen prijs in het winkelmandje, en een onderdeel betaal je één keer per winkelmandje, ongeacht hoeveel ratio’s ervan afhankelijk zijn. De eigen price_cents van de ratio wordt naast de onderdelen gefactureerd. De meeste ratio’s kosten 0. Elk item bevat id, name, price_cents en retail_cents.Een ratio waarvan niet alle onderdelen een prijs hebben, ontbreekt helemaal in de catalogus — deze verschijnt nooit met price_cents: null.
Panels hebben alleen price_cents en retail_cents: een panel heeft één catalogusprijs en geen posities of onderdelen.

Foutresponsen