API Disponibilités (AvailableTimeSlots)
Récupérer les disponibilités
GET /api/v1/groups/:group_id/availabletimeslots?apikey=:apikey&\
intervention_ids[]=:intervention_id&\
calendar_id=:calendar_id&\
start=:start
| Champ |
Type |
Description |
| group_id |
integer |
Identifiant du groupe |
| intervention_ids |
array of integers |
Liste des identifiants des prestations sélectionnées |
| calendarset_ids |
array of integers |
(optionnel) Liste des identifiants de catégorie d'agenda sélectionnées |
| calendar_id |
integer |
(optionnel) Identifiant d'agenda selectionné, laisser vide pour "sans préférence" |
| calendar_ids |
array of integers |
(optionnel) Liste des identifiants d'agendas sélectionnées |
| resource_id |
integer |
(optionnel) Filtrer les dispos par rapport à un identifiant d'un agenda ressource |
| start |
datetime |
Date de début du calcul de disponibilités (ex : "2010-10-23 14:00:00") |
| end |
datetime |
(optionnel) Date de fin du calcul de disponibilités (ex : "2010-10-23 18:00:00") |
| nDays |
integer |
(optionnel) Nombre de jours suivants start sur lequel le calcul est fait (alternative à end) |
| cal_qty |
integer |
(optionnel) Filtrer les dispos qui ont un nombre minimum d'agendas (par défaut = 1) |
| min_capacity |
integer |
(optionnel) Filtrer les dispos qui ont une capacité donnée minimum de rdv (par défaut = 1) |
Si on n'indique pas le paramêtre "end" dans l'appel, le résultat sera par défault les disponibilités de la période "start" + 7 jours.
Structure de la réponse
| Champ |
Type |
Description |
group_id |
integer |
Identifiant du groupe |
| firstSlot |
datetime |
Premier créneau disponible |
| intervention_ids |
array of integers |
Liste des identifiants des prestations sélectionnées |
| calendar_id |
integer |
Identifiant d'agenda, vide si "sans préférence" |
| calendar_ids |
array of integers |
Liste des identifiants d'agendas sélectionnées |
| availabletimeslots |
array |
Liste des disponibilités ayant pour chaque dispo la date de début (start), la capacité (capacity) et les agendas concernés (calendar_ids) pour cette dispo |
Exemple d'appel
$ curl "https://sandbox.clicrdv.com/api/v1/groups/4/availabletimeslots.json?apikey=xxxxxx&\
intervention_ids[]=1026&\
cal_qty=3&\"
Exemple de réponse
{
"group_id":4,
"firstSlot":"2017-02-28 11:35:00",
"calendar_id":null,
"calendar_ids":[314681,314682,627149,314683],
"intervention_ids":[1026],
"availabletimeslots":[
{"start":"2017-02-28 11:35:00","capacity":2,"calendar_ids":[314681,314682,627149]},
{"start":"2017-02-28 12:15:00","capacity":1,"calendar_ids":[627149]},
...
{"start":"2017-03-06 21:50:00","capacity":1,"calendar_ids":[627149]}
]
}
