Lister les valeurs admises par un filtre

GET

/v1/referentiels/{dimension}

const url = 'https://api-equides.org/v1/referentiels/races';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api-equides.org/v1/referentiels/races";

    let client = reqwest::Client::new();
    let response = client.get(url)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url https://api-equides.org/v1/referentiels/races

Sans cette liste, un intégrateur ne peut pas deviner que la source écrit Trotteur Francais sans cédille ni accent, ni que le sexe se dit Femelle et non F.

Les modalités sont rendues de la plus fréquente à la plus rare, et la liste est tronquée à 2000 entrées — nombre_de_modalites donne alors le total réel et note signale la troncature. annees_naissance fait exception : rendu en entier, par ordre chronologique.

Parameters

Path Parameters

dimension

required

string

Allowed values: races robes sexes disciplines codes_indice races_lien annees_naissance

Référentiel demandé. races_lien porte les 13 races propres déclarées sur les liens de filiation, là où races reflète un champ pollué par la source.

Example

races

Responses

200

Modalités et effectifs, du plus fréquent au plus rare.

application/json

object

dimension

required

string

donnees

required

De la modalité la plus fréquente à la plus rare, sauf pour annees_naissance, rendu par ordre chronologique.

Array<object>

Une valeur admise par un filtre, avec son effectif.

object

nombre

required

integer

valeur

required

string

nombre_de_modalites

required

Total réel, y compris les modalités écartées par la troncature.

integer

note

Présent seulement quand la liste est tronquée. Une troncature silencieuse laisserait croire à une liste exhaustive.

string

Example

{
  "dimension": "races",
  "donnees": [
    {
      "valeur": "Trotteur Francais"
    }
  ]
}

304

Contenu inchangé depuis l’ETag fourni en If-None-Match. Aucun corps, et rien n’est recalculé côté service.

400

Référentiel inconnu.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}

429

Quota de débit dépassé pour l’adresse appelante. Retry-After indique le délai.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}

503

Capacité de traitement simultané atteinte, délai maximal dépassé, ou données non chargées. Retry-After indique le délai.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}