Web Services Help Documentation

Partager ce sujet
Kelio
Langues
- Français
- English

Dézoomer la fenêtre
Texte plus grand | Texte plus petit
Masquer l'en-tête de page
Afficher le texte déroulant
Imprimer le sujet
Envoyer des commentaires par e-mail
Partager ce sujet
Enregistrer l'URL Permalink

Horaires et périodes de travail

Faire défiler Précédent Haut de page Suivant Plus

Permet de lire les affectations d’horaire journalière de chaque salarié. Il permet de lire notamment le temps théorique de travail ainsi que les périodes théoriques de travail du salarié.

Lecture des affectation d’horaires et des périodes de travail

Lien vers le WSDL : https://sandbox-ws.kelio.io/open/services/DailyScheduleAssignmentService?wsdl

Web Service : DailyScheduleAssignmentService

Méthode : exportDailyScheduleAssignmentsList

Données obligatoires

Filtre sur les salariés

Les méthodes de lecture des données liées aux salariés proposent deux options de lecture :

•Soit la lecture des données d’un salarié via un des identifiants du salarié (Matricule, n° de badge, nom/prénom). Le Matricule est l’identifiant à privilégier car il est le plus souvent invariant dans le temps.

•Soit la lecture des données d’une liste de salariés via des filtres par Population et Groupe de salariés. Ces notions sont paramétrables par le gestionnaire de Kelio (voir aide en ligne Population et Groupe).

La balise populationMode permet de définir ce mode de fonctionnement :

populationMode=1 : Lecture des données d’un salarié

Dans ce cas, l’un des identifiants suivants est obligatoire :

•Matricule du salarié : employeeIdentificationNumber

•ou Code du badge : employeeBadgeCode

•ou Nom/Prénom : employeeFirstName et employeeSurname

•ou Clé technique : employeeKey (cet identifiant est à utiliser lors du traitement par lot après avoir lu les clés des salariés via le Web Service lightEmployee)

populationMode=0 : Lecture des données d’une liste de salariés en fonction des Populations et Groupe de salariés

Dans ce cas, les notions de Population et Groupe peuvent être utilisées. Elles ne sont pas obligatoires. Si elles ne sont pas renseignées, le Web Service renvoie les données de tous les salariés. Sur des gros volumes de base, ce type de demande peut ralentir les performances du serveur Kelio. Il est donc fortement recommandé de les utiliser.

•Population : populationFilter

•Groupe : groupFilter

Filtre sur les périodes des données à extraire

Il existe deux façons de filtrer les données datées en fonction de plage de date.

•Soit en utilisant une période de date réelle : exemple du 14/05/2024 au 25/06/2024.

•Soit en utilisant une plage de date relative par rapport à la date du jour : exemple -20 jours à +10 jours.

La balise DateMode permet de définir le mode de fonctionnement :

0 : Mode date réelle

Champs à renseigner :

•startDate : date de début en date réelle

•endDate : date de fin en date réelle

1 : Mode date relative

Champs à renseigner

•startOffset : date de début en relatif. Nombre de jours en plus ou en moins par rapport à la date du jour.

•endOffset : date de fin en relatif. Nombre de jours en plus ou en moins par rapport à la date du jour.

Données en entrée

Code	Description	Type de classe
archivedEmployee	Salarié archivé	boolean (false / true)
dateMode	Mode de saisie des dates	int Valeurs possibles : 0Date à date 1Date relative de début à date relative de fin
employeeBadgeCode	Code du badge du salarié	String (max: 16)
employeeFirstName	Prénom du salarié	String (max: 24)
employeeIdentificationCode	Code matricule du salarié	String (max: 80)
employeeIdentificationNumber	Matricule du salarié	String (max: 16)
employeeKey	Clé de salarié	Int
employeeSurname	Nom du salarié	String (max: 24)
endDate	Date de fin	Date (format : yyyy-MM-dd)
endOffset	Offset de fin	Int
errorMessage	Message d'erreur	String
groupFilter	Filtre par groupe de type public	String (max: 40)
populationEndDate	Date de fin d'appartenance à la population	Date (format : yyyy-MM-dd)
populationFilter	Filtre par population	String
populationMode	Mode de saisie de la population	Int Valeurs possibles : 0Population / Groupe 1Salarié
populationStartDate	Date de début d'appartenance à la population	Date format : yyyy-MM-dd)
startDate	Date de début	Date (format : yyyy-MM-dd)
startOffset	Offset de départ	Int
technicalString	Clé technique	String

Données en sortie

Code	Description	Type de classe
afternoonContractedTime	Théorique après-midi	Double
archivedEmployee	Salarié archivé	boolean (false / true)
assignementByException	Affectation par exception	boolean (false / true)
assignmentDate	Date d'affectation	Date (format : yyyy-MM-dd)
calculationModeContractedSchedule	Mode de calcul du théorique	int Valeurs possibles : 0Issu de l'horaire 1Défini manuellement 2Issu des périodes de travail
comment	Commentaire	String (max: 255)
contractedTime	Temps théorique	Double
dailyScheduleAbbreviation	Abrégé d'horaire journalier	String (max: 5)
dailyScheduleDescription	Libellé d'horaire journalier	String (max: 40)
dailyScheduleKey	Clé d'horaire journalier	Int
employeeBadgeCode	Code du badge du salarié	String (max: 16)
employeeFirstName	Prénom du salarié	String (max: 24)
employeeIdentificationCode	Code matricule du salarié	String (max: 80)
employeeIdentificationNumber	Matricule du salarié	String (max: 16)
employeeKey	Clé de salarié	Int
employeeSurname	Nom du salarié	String (max: 24)
errorMessage	Message d'erreur	String
fifthWorkingPeriodEndTime	Heure de fin de la cinquième période de travail	Time (format : HH:mm:ss)
fifthWorkingPeriodEndTimePosition	Position de l'heure de fin de la cinquième période de travail dans la journée logique	int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
fifthWorkingPeriodStartTime	Heure de début de la cinquième période de travail	Time (format : HH:mm:ss)
fifthWorkingPeriodStartTimePosition	Position de l'heure de début de la cinquième période de travail dans la journée logique	Int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
firstWorkingPeriodEndTime	Heure de fin de la première période de travail	Time (format : HH:mm:ss)
firstWorkingPeriodEndTimePosition	Position de l'heure de fin de la première période de travail dans la journée logique	int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
firstWorkingPeriodStartTime	Heure de début de la première période de travail	Time (format : HH:mm:ss)
firstWorkingPeriodStartTimePosition	Position de l'heure de début de la première période de travail dans la journée logique	int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
fourthWorkingPeriodEndTime	Heure de fin de la quatrième période de travail	Time (format : HH:mm:ss)
fourthWorkingPeriodEndTimePosition	Position de l'heure de fin de la quatrième période de travail dans la journée logique	int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
fourthWorkingPeriodStartTime	Heure de début de la quatrième période de travail	time (format : HH:mm:ss)
fourthWorkingPeriodStartTimePosition	Position de l'heure de début de la quatrième période de travail dans la journée logique	int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
halfDayTime	Heure de demi-journée	Time (format : HH:mm:ss)
morningContractedTime	Temps théorique du matin	double
nightStartTime	Heure de début de nuit	Time (format : HH:mm:ss)
nightStartTimePosition	Position d'heure de début de nuit	short Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
scheduleAbbreviation	Abrégé d'horaire	String (max: 5)
scheduleDescription	Libellé du cycle de travail	String (max: 40)
secondWorkingPeriodEndTime	Heure de fin de la deuxième période de travail	Time (format : HH:mm:ss)
secondWorkingPeriodEndTimePosition	Position de l'heure de fin de la deuxième période de travail dans la journée logique	int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
secondWorkingPeriodStartTime	Heure de début de la deuxième période de travail	Time (format : HH:mm:ss)
secondWorkingPeriodStartTimePosition	Position de l'heure de début de la deuxième période de travail dans la journée logique	int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
technicalString	Clé technique	String
thirdWorkingPeriodEndTime	Heure de fin de la troisième période de travail	Time (format : HH:mm:ss)
thirdWorkingPeriodEndTimePosition	Position de l'heure de fin de la troisième période de travail dans la journée logique	int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit
thirdWorkingPeriodStartTime	Heure de début de la troisième période de travail	time (format : HH:mm:ss)
thirdWorkingPeriodStartTimePosition	Position de l'heure de début de la troisième période de travail dans la journée logique	int Valeurs possibles : -1 Avant 0:00 0Le jour même 1Après minuit

Exemple de requête

Nom du Web Service

Nom	Copier
DailyScheduleAssignmentService

Exemple de lecture des horaires du salarié matricule = « 00001057 » pour une période de 02/08/2024 au 03/08/2024

Code Sample

Copier Code

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ech="http://echange.service.open.bodet.com">
   <soapenv:Header/>
   <soapenv:Body>
      <ech:exportDailyScheduleAssignmentsList>
         <ech:populationFilter>
            <ech:AskedPopulationWithPeriod>
               <ech:employeeIdentificationNumber>00001057</ech:employeeIdentificationNumber>
                <ech:populationMode>1</ech:populationMode>
               <ech:startDate>2024-08-02</ech:startDate>
               <ech:endDate>2024-08-03</ech:endDate>
               <ech:dateMode>0</ech:dateMode>
            </ech:AskedPopulationWithPeriod>
         </ech:populationFilter>
      </ech:exportDailyScheduleAssignmentsList>
   </soapenv:Body>
</soapenv:Envelope>

Réponse

Réponse à la demande en exemple : la liste des affectations des horaires des 02/08/2024 et 03/08/2024 Enter text here

Code Sample

Copier Code

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns1:exportDailyScheduleAssignmentsListResponse xmlns:ns1="http://echange.service.open.bodet.com">
         <ns1:exportedDailyScheduleAssignments>
            <ns1:DailyScheduleAssignment>
               <ns1:contractedTime>7.0</ns1:contractedTime>
               <ns1:scheduleAbbreviation>C3645</ns1:scheduleAbbreviation>
               <ns1:assignmentDate>2024-08-02</ns1:assignmentDate>
               <ns1:morningContractedTime>4.0</ns1:morningContractedTime>
               <ns1:afternoonContractedTime>3.0</ns1:afternoonContractedTime>
               <ns1:comment xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:dailyScheduleKey>157</ns1:dailyScheduleKey>
               <ns1:dailyScheduleAbbreviation>Jour</ns1:dailyScheduleAbbreviation>
               <ns1:dailyScheduleDescription>Journée</ns1:dailyScheduleDescription>
               <ns1:scheduleDescription>Contrat 36h45</ns1:scheduleDescription>
               <ns1:contractedFromWorkingPeriods>true</ns1:contractedFromWorkingPeriods>
               <ns1:calculationModeContractedSchedule>2</ns1:calculationModeContractedSchedule>
               <ns1:assignementByException>true</ns1:assignementByException>
               <ns1:thirdWorkingPeriodEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:nightStartTime>20:00:00</ns1:nightStartTime>
               <ns1:secondWorkingPeriodStartTimePosition>0</ns1:secondWorkingPeriodStartTimePosition>
               <ns1:secondWorkingPeriodEndTimePosition>0</ns1:secondWorkingPeriodEndTimePosition>
               <ns1:fourthWorkingPeriodStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:thirdWorkingPeriodStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:firstWorkingPeriodStartTimePosition>0</ns1:firstWorkingPeriodStartTimePosition>
               <ns1:fourthWorkingPeriodEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fifthWorkingPeriodEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fifthWorkingPeriodStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:firstWorkingPeriodEndTimePosition>0</ns1:firstWorkingPeriodEndTimePosition>
               <ns1:firstWorkingPeriodEndTime>10:00:00</ns1:firstWorkingPeriodEndTime>
               <ns1:firstWorkingPeriodStartTime>06:00:00</ns1:firstWorkingPeriodStartTime>
               <ns1:secondWorkingPeriodEndTime>14:15:00</ns1:secondWorkingPeriodEndTime>
               <ns1:halfDayTime>10:00:00</ns1:halfDayTime>
               <ns1:thirdWorkingPeriodEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fifthWorkingPeriodStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:secondWorkingPeriodStartTime>11:15:00</ns1:secondWorkingPeriodStartTime>
               <ns1:fourthWorkingPeriodEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fifthWorkingPeriodEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fourthWorkingPeriodStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:thirdWorkingPeriodStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:nightStartTimePosition>0</ns1:nightStartTimePosition>
               <ns1:employeeIdentificationNumber>00001057</ns1:employeeIdentificationNumber>
               <ns1:employeeSurname>BLUSSEAU</ns1:employeeSurname>
               <ns1:employeeKey>332</ns1:employeeKey>
               <ns1:employeeFirstName>Tanguy</ns1:employeeFirstName>
               <ns1:employeeBadgeCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:employeeIdentificationCode>GD</ns1:employeeIdentificationCode>
               <ns1:archivedEmployee>false</ns1:archivedEmployee>
               <ns1:errorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:technicalString xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            </ns1:DailyScheduleAssignment>
            <ns1:DailyScheduleAssignment>
               <ns1:contractedTime>7.5</ns1:contractedTime>
               <ns1:scheduleAbbreviation>C3645</ns1:scheduleAbbreviation>
               <ns1:assignmentDate>2024-08-03</ns1:assignmentDate>
               <ns1:morningContractedTime>4.5</ns1:morningContractedTime>
               <ns1:afternoonContractedTime>3.0</ns1:afternoonContractedTime>
               <ns1:comment xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:dailyScheduleKey>157</ns1:dailyScheduleKey>
               <ns1:dailyScheduleAbbreviation>Jour</ns1:dailyScheduleAbbreviation>
               <ns1:dailyScheduleDescription>Journée</ns1:dailyScheduleDescription>
               <ns1:scheduleDescription>Contrat 36h45</ns1:scheduleDescription>
               <ns1:contractedFromWorkingPeriods>true</ns1:contractedFromWorkingPeriods>
               <ns1:calculationModeContractedSchedule>2</ns1:calculationModeContractedSchedule>
               <ns1:assignementByException>true</ns1:assignementByException>
               <ns1:thirdWorkingPeriodEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:nightStartTime>20:00:00</ns1:nightStartTime>
               <ns1:secondWorkingPeriodStartTimePosition>0</ns1:secondWorkingPeriodStartTimePosition>
               <ns1:secondWorkingPeriodEndTimePosition>0</ns1:secondWorkingPeriodEndTimePosition>
               <ns1:fourthWorkingPeriodStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:thirdWorkingPeriodStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:firstWorkingPeriodStartTimePosition>0</ns1:firstWorkingPeriodStartTimePosition>
               <ns1:fourthWorkingPeriodEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fifthWorkingPeriodEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fifthWorkingPeriodStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:firstWorkingPeriodEndTimePosition>0</ns1:firstWorkingPeriodEndTimePosition>
               <ns1:firstWorkingPeriodEndTime>10:30:00</ns1:firstWorkingPeriodEndTime>
               <ns1:firstWorkingPeriodStartTime>06:00:00</ns1:firstWorkingPeriodStartTime>
               <ns1:secondWorkingPeriodEndTime>17:15:00</ns1:secondWorkingPeriodEndTime>
               <ns1:halfDayTime>10:30:00</ns1:halfDayTime>
               <ns1:thirdWorkingPeriodEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fifthWorkingPeriodStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:secondWorkingPeriodStartTime>14:15:00</ns1:secondWorkingPeriodStartTime>
               <ns1:fourthWorkingPeriodEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fifthWorkingPeriodEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:fourthWorkingPeriodStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:thirdWorkingPeriodStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:nightStartTimePosition>0</ns1:nightStartTimePosition>
               <ns1:employeeIdentificationNumber>00001057</ns1:employeeIdentificationNumber>
               <ns1:employeeSurname>BLUSSEAU</ns1:employeeSurname>
               <ns1:employeeKey>332</ns1:employeeKey>
               <ns1:employeeFirstName>Tanguy</ns1:employeeFirstName>
               <ns1:employeeBadgeCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:employeeIdentificationCode>GD</ns1:employeeIdentificationCode>
               <ns1:archivedEmployee>false</ns1:archivedEmployee>
               <ns1:errorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
               <ns1:technicalString xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
            </ns1:DailyScheduleAssignment>
         </ns1:exportedDailyScheduleAssignments>
      </ns1:exportDailyScheduleAssignmentsListResponse>
   </soap:Body>
</soap:Envelope>

Veuillez activer JavaScript pour visualiser cette page.

Web Services Help Documentation

Filtre sur les salariés

Filtre sur les périodes des données à extraire