La liste des réservations d’un utilisateur est accessible à l’adresse /api/bookings/
via la méthode HTTP GET
.
Nom | Description | Exemple |
user_external_id | Identifiant unique de l’utilisateur (obligatoire). | {{form_user_nameid}} |
agenda | Restreindre les réservations à un agenda. | Slug d’un agenda. |
category | Restreindre les réservations à une catégorie d’agenda. | Slug d’une catégorie. |
date_start | Filtrer les réservations selon leur date de début. | 2021-09-15 |
date_end | Filtrer les réservations selon leur date de fin. | 2021-09-20 |
GET /api/bookings/?user_external_id=xxx { "err": 0, "data": [ { "id": 4, "in_waiting_list": false, "user_was_present": true, "user_absence_reason": "", "extra_data": null }, { "id": 11, "in_waiting_list": false, "user_was_present": null, "user_absence_reason": "", "extra_data": null } ] }
Les informations sur une réservation sont accessibles à l’adresse /api/booking/ID-DE-LA-RESERVATION/
via la méthode HTTP GET
.
GET /api/booking/4/ { "err": 0, "data": { "booking_id": 4, "in_waiting_list": false, "user_was_present": true, "user_absence_reason": "", "extra_data": null } }
{ "err": 1, "err_class": "booking is cancelled" }
Les informations sur une réservation sont modifiables à l’adresse /api/booking/ID-DE-LA-RESERVATION/
via la méthode HTTP PATCH
.
Nom | Description | Exemple |
user_was_present | Information de pointage témoignant de la présence de l’utilisateur. | true |
user_absence_reason | Motif d’absence |
Il est possible de passer n’importe quel paramètre en plus de ceux ci-dessus : ils seront enregistrés et apparaîtront dans la clé extra_data
de l’API qui retourne les informations d’une réservation.
PATCH /api/booking/4/ { "err": 0, "booking_id": 4, }
{ "err": 1, "err_class": "booking is cancelled" }
{ "err": 3, "err_class": "booking is in waiting list" }
{ "err": 5, "err_class": "event is marked as checked" }
Il est possible d’annuler une réservation grâce à un appel à l’adresse /api/booking/ID-DE-LA-RESERVATION/cancel/
via la méthode HTTP POST
.
POST /api/booking/4/cancel/ { "err": 0, "booking_id": 4, }
{ "err": 1, "err_class": "already cancelled" }
Il est possible de déplacer une réservation de la liste d’attente vers la liste principale grâce à un appel à l’adresse /api/booking/ID-DE-LA-RESERVATION/accept/
via la méthode HTTP POST
.
POST /api/booking/4/accept/ { "err": 0, "booking_id": 4, "overbooked_places": 0 }
{ "err": 1, "err_class": "booking is cancelled" }
{ "err": 3, "err_class": "booking is not in waiting list" }
Inversement, il est possible de déplacer une réservation de la liste principale vers la liste d’attente grâce à un appel à l’adresse /api/booking/ID-DE-LA-RESERVATION/suspend/
via la méthode HTTP POST
.
POST /api/booking/4/accept/ { "err": 0, "booking_id": 4, }
{ "err": 1, "err_class": "booking is cancelled" }
{ "err": 3, "err_class": "booking is already in waiting list" }
Il est possible de modifier le nombre de places prises par une réservation grâce à un appel à l’adresse /api/booking/ID-DE-LA-RESERVATION/resize/
via la méthode HTTP POST
.
Nom | Description | Exemple |
count |
Nombre de places. | 2 |
POST /api/booking/4/resize/ { "err": 0, "booking_id": 4, }
{ "err": 1, "err_class": "booking is cancelled" }
{ "err": 3, "err_class": "sold out" }
Il est possible d’anonymiser une réservation grâce à un appel à l’adresse /api/booking/ID-DE-LA-RESERVATION/anonymize/
via la méthode HTTP POST
.
POST /api/booking/4/anonymize/ { "err": 0, "booking_id": 4, }
Il est possible de supprimer une réservation grâce à un appel à l’adresse /api/booking/ID-DE-LA-RESERVATION/
via la méthode HTTP DELETE
.
DELETE /api/booking/4/ { "err": 0, "booking_id": 4, }
{ "err": 1, "err_class": "booking is cancelled" }