Calendarset API

L’objet CalendarSet représente une catégorie d'agendas. Il est utile lorsqu’un Groupe comporte un grand nombre d'agendas qui peuvent être regroupés via une thématique commune.

Par exemple, on peut créer un CalendarSet «Épilation» qui comportera la liste de tous les agendas de personnes faisant cette prestation

Les catégories d'agendas sont optionnelles. Un groupe peut comporter plusieurs catégories d'agendas, et les agendas peuvent appartenir à l'une ou l'autre de ces catégories, ou n'appartenir à aucune catégorie.

Ajout d'une catégorie d'agendas

POST /api/v1/groups/:group_id/calendarsets?apikey=xxxxxx
{
   "calendarset": {
      "group_id": 4,
      "name": "Calendarset de test"
   }
}

Liste des catégories d'agendas pour un groupe

GET /api/v1/groups/:group_id/calendarsets

Champs standard:

Champ	Type	Description
id	integer	ID unique de la catégorie d'agendas
group_id	integer	ID unique de l'objet de type « Group » auquel la catégorie d'agendas est liée
name	string(255)	Nom de la catégorie d'agendas
preposition	string(255)	Une préposition permettant de former un vocable avec le nom de la catégorie d'agendas pour affichage dans le module de prise de RDV.
address	string(255)	(optionnel) Adresse si différente de celle du groupe.
zipcode	string(16)	(optionnel) Code postal si différent de celui du groupe.
city	string(64)	(optionnel) Ville si différente de celle du groupe.
sort	integer	(optionnel) Entier permettant de gérer l'ordre des catégories d'agendas (ordre d'affichage dans l'interface Pro et dans l'interface de prise de RDV par internet).
externid	string(32)	(optionnel) Un identifiant client permettant de lier la catégorie d'agendas à un objet spécifique défini du côté client. Utile pour effectuer des statistiques croisées.
hidden	boolean	(optionnel) Indique si la catégorie d'agendas est composée d'agendas cachés. Ce champ est déprécié car concernant une fonctionnalité qui n'est plus disponible à l'activation (remplacée par le mode ressource), il est cependant encore présent pour d'anciens groupes.

Modification d'un calendarset

PUT /api/v1/groups/:group_id/calendarsets/:calendarset_id?apikey=xxxxxx
{
   "calendarset": {
      "publicname": "Calendarset ouvert à Internet"
   }
}

Supprimer un calendarset

DELETE /api/v1/groups/:group_id/calendarsets/:calendarset_id

Récupérer les interventionsets d'un calendarset

GET /api/v1/groups/:group_id/calendarsets/:calendarset_id/interventionsets

Récupérer les interventions d'un calendarset

GET /api/v1/groups/:group_id/calendarsets/:calendarset_id/interventions