> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Iegūt biomarķieru sarakstu

> Pārlūkot biomarķieru katalogu

Atgriež pa lapām sadalītu katalogu ar biomarķieriem, kurus tava API atslēga var pasūtīt vienam avotam. Pievieno tos [pierakstiem](https://docs.anivahealth.com/lv/api/appointments/add-individual-biomarkers.md) vai [mājas testa komplektiem](https://docs.anivahealth.com/lv/api/home-kit-orders/add-individual-biomarkers.md). Arhivētie biomarķieri nav iekļauti.

Biomarķieris tiek iekļauts sarakstā, ja to nodrošina pasūtījums laboratorijā, kuru tava atslēga drīkst izmantot, un pasūtījumam paraugus ņem tikai šim avotam pieejamajos trauciņos. Izšķirošie ir paraugu stobriņi, nevis analīta veids.

Nepieciešams `panels_access` tvērums. Objektam `pricing` nepieciešams arī `prices_view` tvērums.

## Pieprasījums

### Vaicājuma parametri

Avotam ir divi varianti: analīžu vieta vai mājas testa komplekts. Nosūti tieši vienu. Ja nenorādīsi nevienu vai norādīsi abus, tiks atgriezts `400`.

> [tab] Analīžu vieta
>
> **location\_id** `string` *required*
>
> Atrašanās vieta, kurā notiek pierakstu asins paņemšana. Biomarķieris tiek iekļauts sarakstā, ja tā pasūtījumam paraugus ņem tikai
> šajā atrašanās vietā pieejamajos trauciņos. Sasaisti ar [Atrašanās vietu sarakstu](https://docs.anivahealth.com/lv/api/locations/list-locations.md).

> [tab] Mājas testa komplekts
>
> **home\_kit** `boolean` *required*
>
> Iestati uz `true`. Biomarķieris tiek iekļauts sarakstā, ja pasūtījumam mājas testa komplektu laboratorijā paraugus ņem tikai
> trauciņos, kas ir komplektā: kapilārais serums un EDTA, sausais asins piliens, urīns un uztriepe.
> Tikai venozo asiņu biomarķieri netiek iekļauti.

**rate\_card** `string`

Aizstāj cenrādi, kuru izmanto `price_cents`: `retail` vai tāda cenrāža `id`, kuru tava atslēga drīkst izmantot. Šo `id` atgriež [Iegūt cenrādi](https://docs.anivahealth.com/lv/api/pricing/get-rate-card.md). Pēc noklusējuma tiek izmantots tavas API atslēgas norēķinu konta cenrādis, pretējā gadījumā — mazumtirdzniecības cenrādis.
`retail_cents` vienmēr izmanto mazumtirdzniecības cenrādi.

**limit** `number`

Maksimālais atgriežamo rezultātu skaits (1–1 000). Izlaid, lai atgrieztu visu atbilstošo katalogu — tā apjoms ir ierobežots (ne
vairāk kā daži tūkstoši rindu). Ja šis parametrs ir izlaists, `pagination.limit` atgriež `total` vērtību.

**offset** `number` (default: 0)

Lapošanas nobīde. Jābūt ≥ 0.

## Atbilde

**data** `Biomarker[]`

Vaicājumam atbilstošo biomarķieru masīvs.

**Biomarķiera lauki**

**id** `number`

Nemainīgs biomarķiera identifikators — nodod to pieprasījumam [Pievienot pielāgotus
biomarķierus](https://docs.anivahealth.com/lv/api/appointments/add-individual-biomarkers.md).

**slug** `string`

URL drošs identifikators.

**name** `string`

Attēlojamais nosaukums.

**description** `string | null`

Detalizēts apraksts, ja pieejams.

**primary\_category** `string | null`

Galvenā kategorija (piemēram, `Hormones`, `Vitamins`).

**secondary\_category** `string | null`

Sekundārā kategorija.

**type** `"clinical" | "genetic"`

Vai šis biomarķieris ir klīnisks mērījums vai ģenētisks marķieris.

**material** `string | null`

Nepieciešamais parauga materiāls (piemēram, `serum`, `whole_blood`).

**unit** `object | null`

Noklusējuma mērvienība. Izmanto `id`, lai to atrastu [Mērvienību sarakstā](https://docs.anivahealth.com/lv/api/units/list-units.md),
ja nepieciešama nemainīga identifikācija arī pēc nosaukuma maiņas.

**Mērvienības lauki**

**id** `number`

Nemainīgs mērvienības identifikators.

**title** `string`

Kanoniskais mērvienības nosaukums (piemēram, `nmol/L`).

**display\_title** `string | null`

Lietotājam draudzīgs attēlojamais nosaukums.

**pricing** `object | null`

Cik šis biomarķieris maksā un kā tas tiek pārdots — skati [cenu objektus](#cenu-objekti). `null` ir
**tikai** tad, kad tavai atslēgai trūkst `prices_view` tvēruma; biomarķieris, kuram Aniva nav noteikusi cenu,
tik un tā tiek atgriezts ar `pricing.price_cents: null`.

**pagination** `object`

**Lapošanas lauki**

**total** `number`

Kopējais vaicājumam atbilstošo rindu skaits visās lapās.

**limit** `number`

Šai lapai piemērotais limits. Atkārto `total`, ja `limit` vaicājuma parametrs tika izlaists (tika
atgriezts viss katalogs).

**offset** `number`

Šai lapai piemērotā nobīde.

**has\_more** `boolean`

`true`, ja ir pieejamas vēl lapas.

## Cenu objekti

Cenu struktūra ir vienāda visur, kur tā parādās — biomarķieros, paneļos, pieraksta
[priekšskatījumā](https://docs.anivahealth.com/lv/api/appointments/preview-containers.md) un [cenas aprēķinā](https://docs.anivahealth.com/lv/api/pricing/quote-cart.md). [Cenu noteikšana](https://docs.anivahealth.com/lv/concepts/pricing.md) skaidro tās
pamatā esošo modeli; šī ir lauku uzziņa.

Katra summa ir izteikta veselos centos.

**price\_cents** `integer | null`

Cik tas maksā pēc **tava** cenrāža. `0` ir reāla nulles cena — šī vienība netiek pārdota atsevišķi,
un blakus esošais `requires` vai `positions` bloks norāda, kā tā tiek pārdota. `null` nozīmē ko
citu: Aniva tam nav noteikusi cenu, tas nav par brīvu, to nevar pasūtīt, un tas neko nepievieno
nevienai kopsummai.

**retail\_cents** `integer | null`

Tā pati summa pēc ieteicamā mazumtirdzniecības cenrāža. Vienmēr iekļauts; vienāds ar `price_cents`, ja tava
atslēga jau izmanto mazumtirdzniecības cenrādi.

**tier** `"routine" | "specialty"`

Kura no divām tava cenrāža Aniva likmēm noteica šī marķiera cenu. Iekļauts tikai tad, ja tam ir sava
cena.

**positions** `object[]`

Komerciālie piedāvājumi, kuros ietilpst šis biomarķieris, sākot ar lētāko. Ja `price_cents: 0`, tas ir
vienīgais veids, kā to pasūtīt; ja `price_cents` ir pozitīvs, tie ir komplekti, kuros tas arī ietilpst.
Par pozīciju rēķins tiek izrakstīts **vienu reizi**, un tā vienmēr tiek nodrošināta pilnā apjomā.

**id** `string`

Pastāvīgs pozīcijas identifikators. Sasaistās ar `via_position` pieraksta rēķinā.

**name** `string`

Partnerim redzamais pozīcijas nosaukums.

**price\_cents** `integer | null`

Visas pozīcijas cena tavā cenrādī, kas tiek iekasēta vienreiz. Blakus atrodas `retail_cents`.

**biomarker\_ids** `number[]`

Visi biomarķieri, ko pozīcija nodrošina, ieskaitot to, kuru pieprasīji.

**includes** `number[]`

Pārējie elementi, izņemot pieprasīto biomarķieri — tas, kas nāk līdzi, kad to pērc.

**requires** `object[]`

Norādīts, kad šis biomarķieris ir **attiecība**. To pasūtot, šie komponenti nonāk grozā par
savām cenām, un par katru komponentu grozā maksā vienreiz neatkarīgi no tā, cik attiecību uz to balstās.
Pašas attiecības `price_cents` tiek iekasēts papildus tās komponentiem. Lielākā daļa attiecību maksā `0`.
Katram ierakstam ir `id`, `name`, `price_cents` un `retail_cents`.

Attiecība, kurai ne visiem komponentiem ir cena, katalogā vispār nav atrodama — tā nekad
neparādās ar `price_cents: null`.

Paneļiem ir tikai `price_cents` un `retail_cents`: panelim ir viena kataloga cena, un tam nav
pozīciju vai komponentu.

## Kļūdu atbildes

| Statuss | Apraksts |
| - | - |
| `400` | Validācijas kļūda — piem., nav izcelsmes vai ir divas izcelsmes, `limit` ārpus diapazona vai nezināms/neautorizēts `rate_card`. |
| `403` | Aizliegts — trūkst `panels_access` darbības jomas. |
| `404` | `location_id` neatbilst nevienai analīžu vietai. |
| `500` | Iekšēja servera kļūda. |

```bash cURL theme={null}
curl --url 'https://anivahealth.com/api/v1/biomarkers?home_kit=true&limit=5' \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "data": [
    {
      "id": 42,
      "slug": "vitamin-d-25-oh",
      "name": "Vitamin D (25-OH)",
      "description": "Serum 25-hydroxyvitamin D …",
      "primary_category": "Vitamins",
      "secondary_category": null,
      "type": "clinical",
      "material": "serum",
      "unit": { "id": 1, "title": "nmol/L", "display_title": null },
      "pricing": {
        "price_cents": 3952,
        "retail_cents": 4549,
        "tier": "specialty",
        "positions": [
          {
            "id": "b7d4c2e1-9a3f-4c8b-91d2-5e6f7a8b9c0d",
            "name": "Vitamin panel",
            "price_cents": 6900,
            "retail_cents": 7935,
            "biomarker_ids": [42, 43, 44],
            "includes": [43, 44]
          }
        ]
      }
    }
  ],
  "pagination": { "total": 17, "limit": 5, "offset": 0, "has_more": true }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.