API - Formats

Formats de données

L’API ClicRDV permet de récupérer les données dans divers formats : XML, JSON ou CSV.

format

string - valeur dans ['json','xml','csv']

XML

• https://www.clicrdv.com/api/v1/fiches?format=xml&apikey=xxxx
• https://www.clicrdv.com/api/v1/fiches/12?format=xml&apikey=xxxx

JSON

• Les champs boolean seront traduits par true/false
• Les valeurs NULL seront représentées par la constante JSON null

Exemples :

• https://www.clicrdv.com/api/v1/fiches?format=json&apikey=xxxx
• https://www.clicrdv.com/api/v1/fiches/12?format=json&apikey=xxxx

CSV

Important : Le format CSV est accessible uniquement en lecture.

• La première ligne de l’export indique les noms des champs.
• Les champs sont séparés par des virgules
• Les informations de pagination de sont pas présentes dans la réponse.

Les requêtes devront comporter le paramètre results=all, sinon, la réponse ne contiendra que les 25 premiers éléments. (voir chapitre suivant pour les options de pagination.)

Exemples :

• https://www.clicrdv.com/api/v1/fiches?format=csv&apikey=xxxx
• https://www.clicrdv.com/api/v1/fiches/12?format=csv&apikey=xxxx