Paramètres des points d'entrée (Endpoint)
Paramètres des points d'entrés via le verbe GET
Afin de permettre de filtrer le résultat des appels en GET deux solutions vous sont proposées.
Paramètre de type "Valeur"
Il est possible de rechercher un enregistrement sur sa clé en passant un paramètre avec comme clé Valeur.
La clé de chaque structure sera indiquée dans la définition de la structure.
Exemple pour un appel à l'API client, la clé est le code client : V1/Client?Valeur=17546
Paramètre de type "Requête"
Afin de répondre à des besoins plus évolués de recherche il est possible, sur certains points d'entrée, de réaliser une requête via la clé Requete.
La possibilité sera indiqué au niveau du point d'entrée.
Exemple pour un appel à l'API client : Requete=[{"op":"egale ","rub":"CodePostal","valeur":["06000"]}]
La valeur de la requête est un tableau de JSON contenant un objet de type Requete :
{"op": "Opérateur","rub": "Nom de la rubrique","valeur": ["Valeur"]}
Opérateurs
Ci-dessous la liste de tous les opérateurs disponibles, pour chaque opérateurs plusieurs syntaxes sont disponibles.
|
Nom de l'opérateur |
Explication de l'opérateur |
|
egale;equal;= |
La valeur du champ correspond aux valeurs en paramètre |
|
nonegale;notequal;<> |
La valeur du champ ne correspond pas aux valeurs en paramètre |
|
superieur;greater;> |
La valeur du champ est supérieure à la valeur en paramètre |
|
superieur_ou_egale;greater_or_equal;>= |
La valeur du champ est supérieure ou égale à la valeur en paramètre |
|
inferieur;less;< |
La valeur du champ est inférieure à la valeur en paramètre |
|
inferieur_ou_egale;less_or_equal;<= |
La valeur du champ est inférieure ou égale à la valeur en paramètre |
|
contient;contains;~ |
La Valeur du champ contient la valeur en paramètre (Uniquement Chaîne) |
|
entre;between; |
Compris entre les deux valeurs en paramètre (Uniquement date ,entier et numérique) |
|
existe;exists; |
La valeur du champ n'est pas null |
|
nonexiste;notexists; |
La valeur du champ est null |
Rubrique
Les rubriques disponibles sont fonction du point d'entrée et de la structure correspondante.
Valeur
La valeur est toujours un tableau de chaîne , même si la rubrique ne permet de passer qu'une valeur dans le tableau.