Structure des ressources

Comment interpréter les représentations des ressources.

Sur les pages des différentes api vous sont présentés des ressources, ce sont les représentation d'un élément de l'api tel qu'il vous sera transmis et tel que vous devrez le transmettre (totalement ou partiellement). Ici vous trouverez les détails de comment lire ces tableaux.

Types

Sur les tableaux vous trouverez une colonne type qui vous indique le type du champ. Ces types sont les types JSON [EN].

Type

Description

string

Une chaine de caractères

int

Un nombre entier naturel (pas de virgules)

float

Un nombre réel (peut potentiellement avoir des virgules)

bool

Un état logique (vrai ou faux).

object

Un objet, généralement fourni avec un référence vers le détail de son contenu

Status additionnels

Liste d'éléments

Parfois vous verrez le type écris comme ceci: string[]. Ceci signifie que la valeur est une liste d'éléments du type indiqué (ici une liste de chaines de caractères).

Nullables

D'autres fois vous verrez le type écris comme ceci: ?string. Cela veut dire que la valeur du champs peut être soit null, soit du type indiqué (ici chaine de caractères).

Champs optionnels

Parfois, il peut arriver que le nom certains champs soit préfixé d'un ? cela signifie que le champs est optionnel et qu'il ne sera pas nécessairement présent sur la réponse. La plupart du temps des indications supplémentaires sont disponibles dans la description du champs.