Passer au contenu principal
GET
Renvoie un catalogue paginé des biomarqueurs que ta clé API peut commander à une origine donnée. Associe-les à des rendez-vous ou à des kits à domicile. Les biomarqueurs archivés sont exclus. Un biomarqueur apparaît dans la liste lorsqu’une commande auprès d’un laboratoire accessible à ta clé le fournit et que son prélèvement utilise uniquement des contenants disponibles à cette origine. Ce sont les tubes de prélèvement qui décident, pas le type d’analyte. Nécessite le scope panels_access. L’objet pricing nécessite aussi le scope prices_view.

Requête

Paramètres de requête

L’origine prend l’une de ces deux formes : un lieu de prélèvement ou un kit à domicile. Envoie-en exactement une. Aucune ou les deux renvoient 400.
string
requis
Le lieu où les prises de sang des rendez-vous sont effectuées. Un biomarqueur apparaît dans la liste lorsque sa commande se prélève uniquement dans des contenants disponibles dans ce lieu. À recouper avec Lister les lieux.
string
Remplace la grille tarifaire utilisée par price_cents : retail, ou l’id d’une grille tarifaire accessible à ta clé. Obtenir une grille tarifaire renvoie cet id. Par défaut, la grille du compte de facturation de ta clé API, sinon le tarif public. retail_cents correspond toujours à la grille publique.
number
Nombre maximal de résultats à renvoyer (1–1 000). Omets ce paramètre pour renvoyer tout le catalogue correspondant — sa taille est limitée (quelques milliers de lignes tout au plus). Lorsqu’il est omis, pagination.limit reprend la valeur de total.
number
défaut:"0"
Décalage de pagination. Doit être ≥ 0.

Réponse

Biomarker[]
Tableau des biomarqueurs correspondant à la requête.
object

Objets de prix

La tarification a la même structure partout où elle apparaît — biomarqueurs, panels, aperçu de rendez-vous et devis. Tarification explique le modèle sous-jacent ; voici la référence des champs. Chaque montant est exprimé en centimes entiers.
integer | null
Ce que cela coûte sur ta grille tarifaire. 0 est un vrai prix de zéro — l’élément n’est pas vendu seul, et le bloc requires ou positions à côté indique comment il est vendu à la place. null est différent : Aniva n’a pas fixé son prix, il n’est pas gratuit, il ne peut pas être commandé et il n’ajoute rien à un total.
integer | null
Le même montant selon la grille de tarif public conseillé. Toujours présent ; égal à price_cents lorsque ta clé utilise déjà la grille publique.
"routine" | "specialty"
Lequel des deux tarifs Aniva de ta grille a fixé le prix de ce marqueur. Présent uniquement lorsqu’il a un prix propre.
object[]
Les offres commerciales contenant ce biomarqueur, de la moins chère à la plus chère. Avec price_cents: 0, elles sont le seul moyen de le commander ; avec un price_cents positif, ce sont les packs auxquels il appartient aussi. Une position est facturée une seule fois et est toujours livrée complète.
string
Identifiant stable du poste. Correspond à via_position sur la facture d’un rendez-vous.
string
Nom du poste visible par le partenaire.
integer | null
Coût de l’ensemble du poste sur ta grille tarifaire, facturé une seule fois. retail_cents figure à côté.
number[]
Tous les biomarqueurs fournis par le poste, y compris celui que tu as demandé.
number[]
Les autres éléments que le biomarqueur demandé — ce qui l’accompagne quand tu l’achètes.
object[]
Présent lorsque ce biomarqueur est un ratio. Le commander ajoute ces composants au panier à leur propre prix, et un composant n’est payé qu’une fois par panier quel que soit le nombre de ratios qui en dépendent. Le price_cents propre au ratio est facturé en plus de ses composants. La plupart des ratios coûtent 0. Chaque entrée contient id, name, price_cents et retail_cents.Un ratio dont tous les composants n’ont pas de prix est totalement absent du catalogue — il n’apparaît jamais avec price_cents: null.
Les panels comportent uniquement price_cents et retail_cents : un panel a un seul prix catalogue et aucun poste ni composant.

Réponses d’erreur