Web Services - Les plannings courants

View the English version.

Description

Chaque personne a une collection avec ses plannings courants. Chaque ressource est le planning courant le plus avancé de la personne.

On récupère le planning de la dernière version de planning en cours s’il est disponible sur la semaine complète (tous workflows de plannings confondus) afin de pouvoir gérer les durées hebdomadaires. Par exemple :

• S’il existe des plannings réalisés sur un des jours de la semaine complète, le Web Service renvoie les plannings réalisés (si le workflow contient du REA), sinon le Web Service renvoie les plannings modifiables.
• S’il existe des plannings modifiables sur un des jours de sur la semaine complète, le Web Service renvoie les plannings modifiables (si le workflow contient du MOD), sinon le Web Service renvoie les plannings initiaux.
• S'il n'existe pas de plannings initiaux sur la semaine complète, le Web Service renvoie vide.

URI	<url_de_base>/api/feed/plannings_courants
Catégorie	http://schemas.holydis.com/tsq/2010#plannings_courants
Disponible en écriture	Non

Paramètres spécifiques

Paramètre	Description
datetime-min	Filtre les plannings disponibles après la date spécifiée ou le même jour.
datetime-max	Filtre les plannings disponibles avant la date spécifiée ou le même jour.

Eléments

Elément	Description
periode	La période de temps couverte par le planning. Cette période de 24h indique l'horodatage de début et de fin. Elle indique également l'heure de changement de jour associée au calendrier auquel la personne est affectée pour la date du planning. Si la personne n'a pas d'affectation de calendrier pour cette date, c'est l'heure de changement de jour du calendrier par défaut de la structure à laquelle la personne est affectée. Toutes les périodes pour lesquelles il existe un planning sont dans le fuseau horaire du calendrier de la personne sur la période.
jourFixe	Indique si la journée de planning est fixe (true) ou pas (false).
publie	Indique si la journée planning est publiée (true) ou pas (false).
valide	Indique si la journée de planning est validée (true) ou pas (false).
composantsPlanning?	Les composants (le contenu) du planning. Si l'élément n'est pas présent c'est qu'il n'y a pas de composant et qu'aucun ne peut être ajouté. Ça arrive si la personne est hors contrat (elle n'a pas d'affectation de contrat pour la date du début de la période du planning) ou qu'elle a un jour fermé dans son calendrier pour la date.
dateValidation?	La date de la validation si le planning est validé.
dateEchange?	La date d'échange enregistrée s'il y a eu un échange depuis My Timesquare.
planningOrigineEchange?	Si le jour de planning est issu d'un échange, le jour de planning de la personne avec laquelle l'échange a été effectué.
dureeQuotidienne?	La durée quotidienne du planning. Exemple : PT8H30M en XML pour une durée quotidienne de 5h30. L'élément n'est pas présent si elle n'a pas de valeur et dans ce cas on a une durée hebdomadaire à la place. Cette propriété est calculée, elle va être ignorée par le serveur lors d'une modification. La durée comprend les pauses quel que soit le paramétrage en base.
dureeBonification	La durée de la bonification pour cette journée du planning. Exemple : PT0H15M en XML pour une durée de bonification de 15 minutes. S'il n'y a pas de bonification, la balise n'apparaît pas.
dureeHebdo?	La durée hebdomadaire. C'est la durée de la semaine qui contient ce planning au cas où la durée quotidienne n'a pas de valeur. Cette propriété est calculée, elle va être ignorée par le serveur lors d'une modification.
timeZoneId	L’identifiant de fuseau horaire. Exemple : Europe/Paris. Pour lire les données en fonction du fuseau horaire de Europe/Lisbonne, il faut ajouter en en-tête de la requête le paramètre User-TimeZoneId avec comme valeur l’identifiant du fuseau de Lisbonne, en l’occurrence Europe/Lisbonne. En l’absence du paramètre en en-tête, les données sont renvoyées brutes (dans le fuseau horaire de la ressource).
typejour	Le type de jour.
versionPlanning	La version de planning.

Exemples de requêtes

Lecture

Lire le planning courant d’une personne dont l'identifiant en base est 16000 pour la semaine contenant une date donnée (le 23/06/2022)

GET /[URI_de_base]/api/feed/personnes/16000/plannings_courants/2022-06-23

Lire les plannings courants de la personne dont l’identifiant en base est 16004 sur une période donnée (du 13/02/2023 au 19/02/2023)

GET /[URI_de_base]/api/feed/personnes/16004/plannings_courants?datetime-min=2023-02-13&datetime-max=2023-02-19

Exemple de résultat XML de la requête

Exemple de résultat JSON de la requête