Project

General

Profile

Documentation #58693

Chrono: documenter les params du endpoint agendas/datetimes

Added by Lauréline Guérin about 1 year ago. Updated about 1 year ago.

Status:
Nouveau
Priority:
Normal
Assignee:
-
Category:
-
Target version:
-
Start date:
18 November 2021
Due date:
% Done:

0%

Estimated time:
Patch proposed:
No
Planning:
No

Description

https://doc-publik.entrouvert.com/dev/api-agendas/chrono-datetimes/#Agenda-%C3%A9v%C3%A8nement-obtenir-lensemble-des-%C3%A9v%C3%A8nements-de-plusieurs-agendas

pas mal de params sont disponibles pour l'api de récupération des créneaux de plusieurs agendas de type event, mais ils ne sont pas documentés pour le moment

notamment:
  • user_external_id (pour savoir si un event a été réservé par un user_id; usage: cellule calendrier hebdomadaire utilisé pour affichage du calendrier perisco)
  • exclude_user_external_id (pour marquer comme disabled un event déjà réservé par un user_id)
  • show_past_events (pour remonter - en disabled - les events passés; usage: affichage du calendrier scolaire sur une année scolaire complète, même pour les jours passés)
  • bypass_delays (pour ignorer les délais de prévenance, pour un usage en backoffice)
  • date_start
  • date_end

(bypass_delays #57961 est aussi utilisable dans le endpoint datetimes habituel, et les api fillslots, uniquement pour les events)


Related issues

Related to Chrono - Development #57961: API datetimes/fillslot: Pouvoir bypasser les délais de prévenanceFermé18 October 2021

Actions
Related to Chrono - Development #58286: api datetimes multi agendas: remonter les events hors délai de prévenanceFermé29 October 2021

Actions

History

#1

Updated by Lauréline Guérin about 1 year ago

  • Related to Development #57961: API datetimes/fillslot: Pouvoir bypasser les délais de prévenance added
#2

Updated by Lauréline Guérin about 1 year ago

  • Related to Development #58286: api datetimes multi agendas: remonter les events hors délai de prévenance added
#3

Updated by Valentin Deniaud about 1 year ago

C'est normalement sous-entendu par la phrase sous le tableau : « Ce paramètre est obligatoire et vient s’ajouter à la liste des paramètres acceptés par l’API de récupération des évènements classique. »
L'idée est de noter juste les différences par rapport à /datetimes/, ici l'ajout du paramètre ?agendas=, et maintenant bypass_delays.

(side note, le projet chrono a un tracker « Documentation » à côté de « Bug » et « Développement », peut-être que les tickets pourraient aller là plutôt que dans le projet Publik ?)

#4

Updated by Lauréline Guérin about 1 year ago

C'est normalement sous-entendu par la phrase sous le tableau : « Ce paramètre est obligatoire et vient s’ajouter à la liste des paramètres acceptés par l’API de récupération des évènements classique. »
L'idée est de noter juste les différences par rapport à /datetimes/, ici l'ajout du paramètre ?agendas=, et maintenant bypass_delays.

Ok, alors ajouter bypass_delays pour plusieurs endpoints, et show_past_events pour /agendas/datetimes/

(side note, le projet chrono a un tracker « Documentation » à côté de « Bug » et « Développement », peut-être que les tickets pourraient aller là plutôt que dans le projet Publik ?)

on a dit lors d'un atelier qu'on ouvrait des tickets documentation dans le projet publik, non ?

#5

Updated by Valentin Deniaud about 1 year ago

  • Project changed from Publik to Chrono
  • Club deleted (No)

Lauréline Guerin a écrit :

Ok, alors ajouter bypass_delays pour plusieurs endpoints, et show_past_events pour /agendas/datetimes/

Yup

on a dit lors d'un atelier qu'on ouvrait des tickets documentation dans le projet publik, non ?

Vu à l'instant en réu dev, les tickets doc fonctionnelle vont dans le projet publik, par contre les tickets doc technique comme celui-ci vont dans le projet technique.

Also available in: Atom PDF