Utilisation de la documentation intégrée à l'application

GTF intègre une documentation API interactive.

Ce qui vous permet d'utiliser les requêtes directement via la documentation.

Chaque route décrite est précédée d'une description qui vous donnera les pré-requis (s'il y en a).

Format générique des réponses

{
   "data" : [],
   "status" : 1
}

La clé data peut référencer un tableau d'objets ou un objet (en fonction du type de requête).

La clé status prendra comme valeur 0 ou 1 (1 tout se passe bien, 0 il y a une erreur avec les paramètres).

Utilisation des filtres JSON

Tous les filtres json de l'application ont la même structure.

Ils peuvent être imbriqués récursivement (une structure relation/opérateurs est aussi un opérateur).

{
   "relation" : "AND",
   "operators" : [{
      "column" : "champ1",
      "compare_operator" : "LIKE",
      "value" : "%Ma_valeur%",
      "compare_operator_options": {
         "case_insensitive":true
         }
   },
   {
      "column":"champ2",
      "compare_operator":"=",
      "value":"val_2"}]
}

La clé relation peut prendre une des valeurs suivantes :

• OR

• AND

Les opérateurs ont une structure plus ou moins dynamique, au minimum on retrouvera trois champs column, compare_operator, value, puis en fonction de l'opérateur il pourra y avoir des informations complémentaires (le plus souvent non obligatoire).

Les opérateurs de comparaison acceptés par l'application sont :

• LIKE

• =

• < et <=

• > et >=

• IN