Group API

Chez ClicRDV, un Groupe représente un magasin, un cabinet médical, etc…

Le processus de prise de RDV est personnalisé pour chaque groupe. Les interfaces permettant la prise de RDV doivent respecter les paramètres spécifiques à la prise de RDV du groupe, en particulier les attributs inactive, open, openData, calendarChoice, anyCalendar, validateEmail, display_intervention_length, display_intervention_price et max_multirdvs.

Récupérer les propriétés d’un groupe

GET /api/v1/groups/:id?format=json&apikey=xxxxxx

Structure de données / paramètres de prise de RDV

name

string(255) - Nom de l’activité, de la société, du magasin ...

preposition

string(32) - Préposition du nom de l'activité/société (ex: chez Eric Plomberie)

phone

string(20) - Numéro de téléphone

address

string(255) - Adresse postale

city

string(64) - Ville

zipcode

string(6) - Code postal

country

string(255) - Pays

inactive

boolean - Indique si la prise de RDV par Internet est désactivée

open

boolean - Indique si tout le monde peut prendre RDV par Internet, ou si seuls les clients ayant déjà une Fiche comportant leur adresse e-mail peuvent prendre RDV (Permet par exemple de limiter la prise de RDV aux personnes déjà venues et qui ont donné leur adresse e-mail)

openData

boolean - Indique si le groupe ouvre ses disponibilités à des utilisateurs non-identifiés (Permet aux gens de choisir un RDV avant de s'authentifier, ou de les obliger à s'authentifier pour choisir)

calendarChoice

integer - Spécifie le déroulement de la prise de RDV par Internet, soit l'utilisateur choisit :

- d'abord le type de RDV, puis l'Agenda (valeur : 2 , valeur par défaut)

- d'abord l'Agenda, puis le type de RDV (valeur : 1 )

- le type de RDV seulement, pas le choix de l'Agenda (valeur : 0 )

anyCalendar

boolean - Spécifie si il y aura une option 'sans préférence' au moment de choisir d'Agenda (si on laisse le choix de l'Agenda)

validateEmail

boolean - Indique si l’adresse doit être validée avant de confirmer un nouveau RDV. (défaut true)

display_intervention_length

boolean - Indique si les durées des prestations doivent être indiquées sur l’interface de prise de RDV

display_intervention_price

boolean - Indique si les prix des prestations doivent être indiquées sur l’interface de prise de RDV

max_multirdvs

integer - Nombre maximum de prestations cumulables lors de la prise de RDV.