API - Filtrage et Pagination

Les options ci-dessous sont disponibles uniquement sur les URLs de type "collection" (cf URLs).

Options de pagination

Par défaut, l’API de ClicRDV propose une pagination de toutes les ressources « collection » limitée à 25 éléments.

results

integer ou "all" - Nombre d’éléments à renvoyer (defaut 25)

startIndex

integer - Index de départ des éléments à récupérer (startIndex/results correspond au numéro de « page », défaut 0)

Important : Si vous souhaitez récupérer tous les éléments d’une collection, vous pouvez passer « all » au lieu d’un entier. Cette méthode est déconseillée pour les collections pouvant contenir un très grand nombre d’éléments (comme fiches ou vevents).

Exemple :

GET https://www.clicrdv.com/api/v1/calendars?results=all&apikey=xxxxx

Options de tri

Les options de tri sont disponibles uniquement sur les ressources de type « Collection » :

sort

string - Champ par lequel les résultats doivent être triés, parmi ceux accessibles en lecture (aucun par défaut)

dir

string - direction du tri, "asc" ou "desc" (Ce paramètre n’est utilisé que si le paramètre sort est rempli.)

Exemple: Récupérer les calendriers par date de création décroissante :

GET https://www.clicrdv.com/api/v1/calendars.xml?sort=created_at&dir=desc&apikey=xxxxxx

Recherche

search

string - Effectue une recherche à partir d’une chaine de caractères. La recherche est spécialisée en fonction de l’objet sur laquelle elle est appelée.

Exemple :

GET https://www.clicrdv.com/api/v1/fiches?search=durand&apikey=xxxxx

Filtrage avancé

L’API ClicRDV sur les ressources « collection » permet de filtrer les résultats répondants à certains critères :

conditions

array - Liste de conditions. Si plusieurs conditions sont fournies, les résultats renvoyés respecteront toutes les conditions indépendamment. (ET logique entre les conditions)

Chaque condition est un tableau (array) de dimension fixe égale à 3, contenant exactement les paramètres suivants :

field

string - Un champ de la ressource adressée, accessible en lecture

op

string - Opérateur de la condition. Parmi : "=", ">", ">=", "<", "<=", "!=". Dans les paramètres de la requête, il convient d'encoder les caractères "<", "=" et ">" respectivement en "%3C", "%3D" et "%3E".

value

any - Valeur de comparaison (son type dépend du champ de la condition)

Exemples :

• Fiches mises à jour après le 1^er février 2010 :

Condition : updated_at >= 2010-02-01 00:00:00

GET https://www.clicrdv.com/api/v1/fiches?\
                 conditions[0][field]=updated_at&\
                 conditions[0][op]=%3E%3D&\
                 conditions[0][value]=2010-02-01 00:00:00&\
                 apikey=xxxxxx

• Récupérer les RDV uniquement (les RDV sont les vevents dont le champ intervention_id est supérieur à 0)

Condition : intervention_id > 0

GET https://www.clicrdv.com/api/v1/calendars/8/vevents.xml?\
                   conditions[0][field]=intervention_id&\
                   conditions[0][op]=%3E&\
                   conditions[0][value]=0&\
                   apikey=xxxxx

• Récupérer les RDV uniquement , modifiés depuis le 1^er février 2010

Condition : intervention_id > 0 && updated_at >= 2010-02-01 00:00:00

GET https://www.clicrdv.com/api/v1/calendars/8/vevents.xml?\
                 conditions[0][field]=intervention_id&\
                 conditions[0][op]=%3E&\
                 conditions[0][value]=0&\
                 conditions[1][field]=updated_at&\
                 conditions[1][op]=%3E%3D&\
                 conditions[1][value]=2010-02-01 00:00:00&\
                 apikey=xxxxx