Collections et Filtres

Paramètres

D'une manière générale, les requêtes GET /<ressources>/ acceptent des paramètres :

	valeur par défaut	Description paramètre
page	1 (Première page)	No de Page de résultats - index base 1
per_page	10	Nombre d'éléments par page
limit	10000	Nombre d'éléments total de la recherche
per_page	10	Nombre d'éléments par page
search	N/A	Texte de recherche optionnel
filter	N/A	Filtrage par attribut optionnel
sort	N/A	Tri par attribut optionnel

Ces éléments optionnels sont facultatifs, si ces éléments sont absents, la valeur par défaut sera appliquée.

Si par exemple, le nombre page dépasse le nombre total de pages, la dernère sera alors affichée.

Exemple en représentation JSON:

{
  "page": 2,
  "per_page": 20,
  "limit": 50, 
  "search": "whatever",
  "filter": {""},
  "sort": {"created_at": "desc"}
}

Filtres

Les filtres sont des paramètres particuliers

Réponses

Pour les collections, les réponses sont paginées

	Type valeur	Description
total	Int	Nombre de résultats au total
resource	Array	Tableau d'objets du resource : users,parcels, sites ...
pagination	Object	Nombre d'éléments par page, urls, ...

exemple:

{
  "total": 31,
  "resource": [

  ],
  "pagination": {
        "count": 31,
        "page": 1,
        "items": 2,
        "last": 16,
        "prev_url": "http://url/path/version/resource?per_page=2&page=",
        "next_url": "http://url/path/version/resource?per_page=2&page=2",
        "last_url": "http://url/path/version/resource?per_page=2&page=16",
        "from": 1,
        "to": 2
    }
}