Produits directs

GET

/v1/equides/{id}/descendance

const url = 'https://api-equides.org/v1/equides/Z4ogLhlkS2CeUdq0bZ0YFw/descendance?limite=50&offset=0';
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/equides/Z4ogLhlkS2CeUdq0bZ0YFw/descendance";

    let querystring = [
        ("limite", "50"),
        ("offset", "0"),
    ];

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

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

    dbg!(results);
}

curl --request GET \
  --url 'https://api-equides.org/v1/equides/Z4ogLhlkS2CeUdq0bZ0YFw/descendance?limite=50&offset=0'

Réponse symétrique au pedigree, servie par un index inverse bâti au chargement.

Ne renvoie que les produits directs : la descendance complète se parcourt en suivant les identifiants de proche en proche.

Parameters

Path Parameters

required

string

Example

Z4ogLhlkS2CeUdq0bZ0YFw

Query Parameters

limite

integer

default: 50 >= 1 <= 100

Produits par page (1 à 100, défaut 50). Une valeur hors bornes est ramenée au plafond, non refusée.

Example

offset

integer

Décalage dans la liste des produits. Un décalage au-delà du total renvoie une page vide, total restant le compte réel.

Example

Responses

200

Descendance directe, page courante.

application/json

object

donnees

required

Array<object>

Renvoi vers un autre équidé du jeu de données.

object

fiche_disponible

Faux si la fiche du parent est absente du jeu de données.

boolean

string

nom

string

race

string

limite

required

integer

offset

required

integer

parent

required

Renvoi vers un autre équidé du jeu de données.

object

fiche_disponible

Faux si la fiche du parent est absente du jeu de données.

boolean

string

nom

string

race

string

total

required

Produits directs connus, avant découpage.

integer

Example

{
  "donnees": [
    {
      "id": "gecpqPj6Rc2vy_Hz_Y1DmQ",
      "nom": "BOOSTER WINNER"
    }
  ],
  "parent": {
    "id": "gecpqPj6Rc2vy_Hz_Y1DmQ",
    "nom": "BOOSTER WINNER"
  }
}

304

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

400

Paramètre inconnu ou non entier.

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"
}

404

Identifiant 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"
}