Reading absence files
Allows you to read the employees' absence files between 2 dates. The Web Service returns all the employee's absence files that have a date period falling within the period requested.
Link to : https://sandbox-ws.kelio.io/open/services/AbsenceFileService?wsdl
Web Service: AbsenceFileService
Method: exportAbsenceFilesList
Mandatory data
There are two options for reading employee data:
•Either reading an employee's data via one of the employee's identifiers (personnel number, badge no, surname/first name). The is the preferred identifier because it is usually consistent over time.
•Or reading data from a list of employees using filters on and . These concepts can be configured using the Kelio manager (see online help Population and Group).
The tag is used to define this operating mode:
In this case, one of the following identifiers is mandatory:
Employee ID number:
or Badge code:
or Surname First name: and
•or Technical key: (this identifier is used during batch processing after reading employee keys via the Web Service )
In this case, the concepts of Population and Group can be used. This data is not mandatory. If they are not completed, the Web Service returns the data for all employees. On large quantities of data, this type of request can slow down the performance of the Kelio server. We therefore strongly recommend that you use them.
Population:
Group: |
There are two ways of filtering dated data by date range.
•Either by using a real date period: for example, from 14/05/2024 to 25/06/2024.
•Or by using a date range relative to the current date: e.g. -20 days to +10 days.
The tagis used to define this operating mode:
Fields to be completed:
•: start date using actual date
•: end date using actual date
Fields to be completed
•: relative start date. Number of days before or after the current date.
•: relative end date. Number of days before or after the current date. |
|
Input data
Code
|
Description
|
Class type
|
absenceFileKey
|
Absence file key
|
Int
|
archivedEmployee
|
Archived employee
|
boolean (false / true)
|
dateMode
|
Date entry mode
|
Int
Possible values:
0Date to date
1Relative start date to relative end date |
employeeBadgeCode
|
Employee badge code
|
string (max: 16)
|
employeeFirstName
|
Employee first name
|
string (max: 24)
|
employeeIdentificationCode
|
Employee ID number code
|
string (max: 80)
|
employeeIdentificationNumber
|
Employee ID
|
string (max: 16)
|
employeeKey
|
Employee key
|
Int
|
employeeSurname
|
Employee surname
|
string (max: 24)
|
endDate
|
End date
|
date (format: yyyy-MM-dd)
|
endOffset
|
End offset
|
Int
|
errorMessage
|
Error message
|
string
|
groupFilter
|
Filter by public type group
|
string (max: 40)
|
limitedToAPeriod
|
Limit absence files to the exported period
|
boolean (false / true)
|
populationEndDate
|
Population end date
|
date (format: yyyy-MM-dd)
|
populationFilter
|
Population filter
|
string
|
populationMode
|
Population entry mode
|
Int
Possible values:
0Population / Group
1Employee |
populationStartDate
|
Population start date
|
date (format: yyyy-MM-dd)
|
startDate
|
Start date
|
date (format: yyyy-MM-dd)
|
startOffset
|
Start offset
|
Int
|
technicalString
|
Technical key
|
string
|
|
Output data
Code
|
Description
|
Class type
|
absenceFileKey
|
Absence file key
|
Int
|
absenceTypeAbbreviation
|
Abbreviation of absence / business leave type
|
String (max: 5)
|
absenceTypeDescription
|
Absence/business leave type description
|
String (max: 40)
|
absenceTypeKey
|
Absence/business leave type key
|
Int
|
archivedEmployee
|
Archived employee
|
boolean (false / true)
|
comment
|
Comment
|
String (max: 2000)
|
creationDate
|
Creation date
|
Date (format: yyyy-MM-dd)
|
durationInDays
|
Duration in days
|
double
|
durationInHours
|
Duration in hours
|
double
|
employeeBadgeCode
|
Employee badge code
|
String (max: 16)
|
employeeFirstName
|
Employee first name
|
String (max: 24)
|
employeeIdentificationCode
|
Employee ID number code
|
String (max: 80)
|
employeeIdentificationNumber
|
Employee ID
|
String (max: 16)
|
employeeKey
|
Employee key
|
Int
|
employeeSurname
|
Employee surname
|
String (max: 24)
|
endDate
|
End date
|
Date (format: yyyy-MM-dd)
|
endingTheAfternoon
|
End in the afternoon
|
boolean (false / true)
|
errorMessage
|
Error message
|
String
|
eventObservingDate
|
Event noticing date
|
Date (format: yyyy-MM-dd)
|
existRelatedDocument
|
Attached document exists
|
boolean (false / true)
|
firstEndTime
|
First absence period end time
|
Time (format: HH:mm:ss)
|
firstEndTimePosition
|
First absence period end time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
firstStartTime
|
First absence period start time
|
Time (format: HH:mm:ss)
|
firstStartTimePosition
|
First absence period start time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
initialNoticeCessationWorkDate
|
Start date of initial leave
|
Date (format: yyyy-MM-dd)
|
lastModificationDate
|
Last modification date
|
dateTime (format: yyyy-MM-dd'T'HH:mm:ss)
|
lastWorkingDayDate
|
Date of the last working day
|
Date (format: yyyy-MM-dd)
|
limitedToAPeriod
|
Limit absence files to the exported period
|
boolean (false / true)
|
noticeCessationWorkExtension
|
Sick leave extension
|
boolean (false / true)
|
numberOfAbsenceDays
|
Number of absence days
|
Int
|
prescribedEndDate
|
Prescribed end date
|
Date (format: yyyy-MM-dd)
|
repetitiveAbsencePeriod
|
Repetitive absence period
|
Int
|
resumptionWorkDate
|
Work restart date
|
Date (format: yyyy-MM-dd)
|
resumptionWorkEarlyDate
|
Early restart work date
|
Date (format: yyyy-MM-dd)
|
secondEndTime
|
Second absence period end time
|
Time (format: HH:mm:ss)
|
secondEndTimePosition
|
Second absence period end time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
secondStartTime
|
Second absence period start time
|
Time (format: HH:mm:ss)
|
secondStartTimePosition
|
Second absence period start time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
splitHolidaysWaiver
|
Waiving of split vacation days
|
short
Possible values:
0Not concerned
1Accepted
2Refused |
startDate
|
Start date
|
Date (format: yyyy-MM-dd)
|
startInTheMorning
|
Starts in the morning
|
boolean (false / true)
|
technicalString
|
Technical key
|
String
|
totalInDays
|
Total in days
|
double
|
totalInHours
|
Total in hours
|
double
|
|
Example of a request
Name
|
Copy
|
AbsenceFileService
|
Sample code
|
Copy Code
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ech="http://echange.service.open.bodet.com">
<soapenv:Header/>
<soapenv:Body>
<ech:exportAbsenceFilesList>
<ech:exportFilter>
<ech:AskedAbsence>
<ech:employeeIdentificationNumber>00001065</ech:employeeIdentificationNumber>
<ech:populationMode>1</ech:populationMode>
<ech:startDate>2024-09-01</ech:startDate>
<ech:endDate>2024-09-30</ech:endDate>
<ech:dateMode>0</ech:dateMode>
</ech:AskedAbsence>
</ech:exportFilter>
</ech:exportAbsenceFilesList>
</soapenv:Body>
</soapenv:Envelope>
|
|
Response
Sample code
|
Copy Code
|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:exportAbsenceFilesListResponse xmlns:ns1="http://echange.service.open.bodet.com">
<ns1:exportedAbsenceFiles>
<ns1:AbsenceFile>
<ns1:comment xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:startDate>2024-09-16</ns1:startDate>
<ns1:endDate>2024-09-22</ns1:endDate>
<ns1:firstEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:creationDate>2024-09-13</ns1:creationDate>
<ns1:lastModificationDate>2024-09-13T15:48:02</ns1:lastModificationDate>
<ns1:eventObservingDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:prescribedEndDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:initialNoticeCessationWorkDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:resumptionWorkEarlyDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:lastWorkingDayDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:resumptionWorkDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:absenceTypeAbbreviation>CP</ns1:absenceTypeAbbreviation>
<ns1:absenceTypeDescription>Congés Payés</ns1:absenceTypeDescription>
<ns1:firstStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:noticeCessationWorkExtension xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:numberOfAbsenceDays xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:fromClockings>false</ns1:fromClockings>
<ns1:totalInHours>36.75</ns1:totalInHours>
<ns1:totalInDays>6.0</ns1:totalInDays>
<ns1:durationInHours>0.00</ns1:durationInHours>
<ns1:absenceFileKey>4391</ns1:absenceFileKey>
<ns1:durationInDays>0.0</ns1:durationInDays>
<ns1:startInTheMorning>true</ns1:startInTheMorning>
<ns1:splitHolidaysWaiver>0</ns1:splitHolidaysWaiver>
<ns1:limitedToAPeriod>false</ns1:limitedToAPeriod>
<ns1:secondEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:firstStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:repetitiveAbsencePeriod>0</ns1:repetitiveAbsencePeriod>
<ns1:endingTheAfternoon>true</ns1:endingTheAfternoon>
<ns1:existRelatedDocument>false</ns1:existRelatedDocument>
<ns1:firstEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:absenceTypeKey>12</ns1:absenceTypeKey>
<ns1:employeeKey>332</ns1:employeeKey>
<ns1:employeeIdentificationCode>GD</ns1:employeeIdentificationCode>
<ns1:employeeBadgeCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeIdentificationNumber>00001065</ns1:employeeIdentificationNumber>
<ns1:archivedEmployee>false</ns1:archivedEmployee>
<ns1:employeeSurname>BLUSSEAU</ns1:employeeSurname>
<ns1:employeeFirstName>Tanguy</ns1:employeeFirstName>
<ns1:technicalString xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:errorMessage xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
</ns1:AbsenceFile>
</ns1:exportedAbsenceFiles>
</ns1:exportAbsenceFilesListResponse>
</soap:Body>
</soap:Envelope>
|
|
Writing absence files
Allows you to write the employees' absence files in Kelio.
There are several write methods for absence files in Kelio. Absences can be written:
•From Date to date (absence from 26/04 to 12/05)
•From date to date with half-day management (absence from 25/04 in the afternoon to 28/04)
•From hour to hour over part of a day (start date = end date e.g. absence on 30/04 from 10am to 12pm)
•With time allocated on part of a day (start date=end date e.g. absence on 05/05 for 1 hour)
Each entry method involves different input fields.
Link to : https://sandbox-ws.kelio.io/open/services/AbsenceFileService?wsdl
Web Service: AbsenceFileService
Method: importAbsenceFiles
Mandatory data
Employee identifier:
By identification number:
Or by badge:
Or by Surname/First name: and
Absence identifier:
Absence type abbreviation:
Or absence type description:
Absence period
•Start date: startDate
•End date: endDate
According to the entry mode
Date to date: no additional parameters
Date to date with half-day: and
From hour to hour: and
Time allocated:
|
The terms in red are compulsory! For the terms in orange, you need to choose data from among that proposed.
|
|
Input data
Code
|
Description
|
Class type
|
absenceFileKey
|
Absence file key
|
Int
|
absenceTypeAbbreviation
|
Abbreviation of absence / business leave type
|
string (max: 5)
|
absenceTypeDescription
|
Absence/business leave type description
|
string (max: 40)
|
absenceTypeKey
|
Absence/business leave type key
|
Int
|
archivedEmployee
|
Archived employee
|
boolean (false / true)
|
comment
|
Comment
|
string (max: 2000)
|
creationDate
|
Creation date
|
date (format: yyyy-MM-dd)
|
durationInDays
|
Duration in days
|
double
|
durationInHours
|
Duration in hours
|
double
|
employeeBadgeCode
|
Employee badge code
|
string (max: 16)
|
employeeFirstName
|
Employee first name
|
string (max: 24)
|
employeeIdentificationCode
|
Employee ID number code
|
string (max: 80)
|
employeeIdentificationNumber
|
Employee ID
|
String (max: 16)
|
employeeKey
|
Employee key
|
Int
|
employeeSurname
|
Employee surname
|
String (max: 24)
|
endDate
|
End date
|
date (format: yyyy-MM-dd)
|
endingTheAfternoon
|
End in the afternoon
|
boolean (false / true)
|
errorMessage
|
Error message
|
String
|
eventObservingDate
|
Event noticing date
|
Date (format: yyyy-MM-dd)
|
existRelatedDocument
|
Attached document exists
|
boolean (false / true)
|
firstEndTime
|
First absence period end time
|
Time (format: HH:mm:ss)
|
firstEndTimePosition
|
First absence period end time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
firstStartTime
|
First absence period start time
|
Time (format: HH:mm:ss)
|
firstStartTimePosition
|
First absence period start time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
initialNoticeCessationWorkDate
|
Start date of initial leave
|
Date (format: yyyy-MM-dd)
|
lastModificationDate
|
Last modification date
|
dateTime (format: yyyy-MM-dd'T'HH:mm:ss)
|
lastWorkingDayDate
|
Date of the last working day
|
Date (format: yyyy-MM-dd)
|
limitedToAPeriod
|
Limit absence files to the exported period
|
boolean (false / true)
|
noticeCessationWorkExtension
|
Sick leave extension
|
boolean (false / true)
|
numberOfAbsenceDays
|
Number of absence days
|
Int
|
prescribedEndDate
|
Prescribed end date
|
Date (format: yyyy-MM-dd)
|
repetitiveAbsencePeriod
|
Repetitive absence period
|
Int
|
resumptionWorkDate
|
Work restart date
|
Date (format: yyyy-MM-dd)
|
resumptionWorkEarlyDate
|
Early restart work date
|
Date (format: yyyy-MM-dd)
|
secondEndTime
|
Second absence period end time
|
Time (format: HH:mm:ss)
|
secondEndTimePosition
|
Second absence period end time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
secondStartTime
|
Second absence period start time
|
Time (format: HH:mm:ss)
|
secondStartTimePosition
|
Second absence period start time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
splitHolidaysWaiver
|
Waiving of split vacation days
|
short
Possible values:
0Not concerned
1Accepted
2Refused |
startDate
|
Start date
|
date (format: yyyy-MM-dd)
|
startInTheMorning
|
Starts in the morning
|
boolean (false / true)
|
technicalString
|
Technical key
|
String
|
totalInDays
|
Total in days
|
double
|
totalInHours
|
Total in hours
|
double
|
|
Example of a request
Name
|
Copy
|
AbsenceFileService
|
Sample code
|
Copy Code
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ech="http://echange.service.open.bodet.com">
<soapenv:Header/>
<soapenv:Body>
<ech:importAbsenceFiles>
<!--Optional:-->
<ech:absenceFilesToImport>
<!--Zero or more repetitions:-->
<ech:AbsenceFile>
<!--Optional:-->
<ech:employeeIdentificationNumber>00001057</ech:employeeIdentificationNumber>
<ech:endDate>2024-06-15</ech:endDate>
<!--Optional:-->
<ech:startDate>2024-06-02</ech:startDate>
<!--Optional:-->
<ech:absenceTypeAbbreviation>CP</ech:absenceTypeAbbreviation>
</ech:AbsenceFile>
</ech:absenceFilesToImport>
</ech:importAbsenceFiles>
</soapenv:Body>
</soapenv:Envelope>
|
If the system sends the error message, this means that this absence has already been created. In this case, you can change the dates and make a new creation request.
|
Response
If a request is made to write data to Kelio:
•If there is no error, the Web Service returns an empty request with no elements.
•If there are errors when writing data, the Web Service returns the elements in error and populates the field . The message returned corresponds to the description of the functional error encountered by the Web Service during the data write request.
Sample code
|
Copy Code
|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:importAbsenceFilesResponse xmlns:ns1="http://echange.service.open.bodet.com">
<ns1:absenceFilesInError></ns1:absenceFilesInError>
</ns1:importAbsenceFilesResponse>
</soap:Body>
</soap:Envelope>
|
Sample code
|
Copy Code
|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:importAbsenceFilesResponse xmlns:ns1="http://echange.service.open.bodet.com">
<ns1:absenceFilesInError>
<ns1:AbsenceFile>
<ns1:comment xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:startDate>2024-07-01</ns1:startDate>
<ns1:endDate>2024-07-15</ns1:endDate>
<ns1:firstEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:creationDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:lastModificationDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:eventObservingDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:prescribedEndDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:initialNoticeCessationWorkDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:resumptionWorkEarlyDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:lastWorkingDayDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:resumptionWorkDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:absenceTypeAbbreviation>CPH</ns1:absenceTypeAbbreviation>
<ns1:absenceTypeDescription xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:firstStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:noticeCessationWorkExtension xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:numberOfAbsenceDays xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:fromClockings xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:totalInHours xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:totalInDays xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:durationInHours xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:absenceFileKey xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:durationInDays xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:startInTheMorning xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:splitHolidaysWaiver xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:limitedToAPeriod xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:firstStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:repetitiveAbsencePeriod xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:endingTheAfternoon xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:existRelatedDocument xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:firstEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:absenceTypeKey xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeKey xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeIdentificationCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeBadgeCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeIdentificationNumber>00001057</ns1:employeeIdentificationNumber>
<ns1:archivedEmployee xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeSurname xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeFirstName 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:errorMessage>L'objet a été modifié ou supprimé entre temps par un autre utilisateur (motifAbsence)</ns1:errorMessage>
</ns1:AbsenceFile>
</ns1:absenceFilesInError>
</ns1:importAbsenceFilesResponse>
</soap:Body>
</soap:Envelope</soap:Envelope>
|
Web Services returns the list of failed elements with the fieldcompleted. ErrorMessage indicates that:The object has been modified or deleted in the meantime by another user (motifAbsence). This type of error is returned when an element cannot be found by its identifier in the Kelio database. Here, the absence typedoes not exist in the list of absence types.
|
Deleting absence files
Allows you to delete an absence file from Kelio for an employee.
Link to : https://sandbox-ws.kelio.io/open/services/AbsenceFileService?wsdl
Web Service: AbsenceFileService
Method: deleteAbsenceFiles
Mandatory data
Employee identifier:
by identification number:
or by badge:
or by surname/first name: and
or by technical key:
Absence identifier:
Absence type abbreviation:
Or absence type description:
Absence period
•Start date: startDate
•End date: endDate
|
The terms in red are compulsory! For the terms in orange, you need to choose data from among that proposed.
|
|
Input data
Code
|
Description
|
Class type
|
absenceFileKey
|
Absence file key
|
Int
|
absenceTypeAbbreviation
|
Abbreviation of absence / business leave type
|
string (max: 5)
|
absenceTypeDescription
|
Absence/business leave type description
|
string (max: 40)
|
absenceTypeKey
|
Absence/business leave type key
|
Int
|
archivedEmployee
|
Archived employee
|
boolean (false / true)
|
comment
|
Comment
|
string (max: 2000)
|
creationDate
|
Creation date
|
date (format: yyyy-MM-dd)
|
durationInDays
|
Duration in days
|
double
|
durationInHours
|
Duration in hours
|
double
|
employeeBadgeCode
|
Employee badge code
|
string (max: 16)
|
employeeFirstName
|
Employee first name
|
string (max: 24)
|
employeeIdentificationCode
|
Employee ID number code
|
string (max: 80)
|
employeeIdentificationNumber
|
Employee ID
|
String (max: 16)
|
employeeKey
|
Employee key
|
Int
|
employeeSurname
|
Employee surname
|
String (max: 24)
|
endDate
|
End date
|
date (format: yyyy-MM-dd)
|
endingTheAfternoon
|
End in the afternoon
|
boolean (false / true)
|
errorMessage
|
Error message
|
String
|
eventObservingDate
|
Event noticing date
|
Date (format: yyyy-MM-dd)
|
existRelatedDocument
|
Attached document exists
|
boolean (false / true)
|
firstEndTime
|
First absence period end time
|
Time (format: HH:mm:ss)
|
firstEndTimePosition
|
First absence period end time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
firstStartTime
|
First absence period start time
|
Time (format: HH:mm:ss)
|
firstStartTimePosition
|
First absence period start time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
initialNoticeCessationWorkDate
|
Start date of initial leave
|
Date (format: yyyy-MM-dd)
|
lastModificationDate
|
Last modification date
|
dateTime (format: yyyy-MM-dd'T'HH:mm:ss)
|
lastWorkingDayDate
|
Date of the last working day
|
Date (format: yyyy-MM-dd)
|
limitedToAPeriod
|
Limit absence files to the exported period
|
boolean (false / true)
|
noticeCessationWorkExtension
|
Sick leave extension
|
boolean (false / true)
|
numberOfAbsenceDays
|
Number of absence days
|
Int
|
prescribedEndDate
|
Prescribed end date
|
Date (format: yyyy-MM-dd)
|
repetitiveAbsencePeriod
|
Repetitive absence period
|
Int
|
resumptionWorkDate
|
Work restart date
|
Date (format: yyyy-MM-dd)
|
resumptionWorkEarlyDate
|
Early restart work date
|
Date (format: yyyy-MM-dd)
|
secondEndTime
|
Second absence period end time
|
Time (format: HH:mm:ss)
|
secondEndTimePosition
|
Second absence period end time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
secondStartTime
|
Second absence period start time
|
Time (format: HH:mm:ss)
|
secondStartTimePosition
|
Second absence period start time position in the logical day
|
Int
Possible values:
-1 Before 0:00
0The same day
1After midnight |
splitHolidaysWaiver
|
Waiving of split vacation days
|
short
Possible values:
0Not concerned
1Accepted
2Refused |
startDate
|
Start date
|
date (format: yyyy-MM-dd)
|
startInTheMorning
|
Starts in the morning
|
boolean (false / true)
|
technicalString
|
Technical key
|
String
|
totalInDays
|
Total in days
|
double
|
totalInHours
|
Total in hours
|
double
|
|
Example of a request
Name
|
Copy
|
AbsenceFileService
|
Code Sample
|
Copy Code
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ech="http://echange.service.open.bodet.com">
<soapenv:Header/>
<soapenv:Body>
<ech:deleteAbsenceFiles>
<ech:absenceFilesToDelete>
<ech:AbsenceFile>
<ech:employeeIdentificationNumber>00002110</ech:employeeIdentificationNumber>
<ech:employeeIdentificationCode>Retail</ech:employeeIdentificationCode>
<ech:endDate>2025-03-28</ech:endDate>
<ech:startDate>2025-03-28</ech:startDate>
<ech:absenceTypeAbbreviation>RTT</ech:absenceTypeAbbreviation>
</ech:AbsenceFile>
</ech:absenceFilesToDelete>
</ech:deleteAbsenceFiles>
</soapenv:Body>
</soapenv:Envelope>
|
|
Response
If a request is made to delete data from Kelio:
•If there is no error, the Web Service returns an empty request with no elements.
•If there are errors when deleting data, the Web Service returns the elements in error and populates the field . The message returned corresponds to the description of the functional error encountered by the Web Service during the data deletion request.
Code Sample
|
Copy Code
|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:deleteAbsenceFilesResponse xmlns:ns1="http://echange.service.open.bodet.com">
<ns1:absenceFilesInError></ns1:absenceFilesInError>
</ns1:deleteAbsenceFilesResponse>
</soap:Body>
</soap:Envelope>
|
Code Sample
|
Copy Code
|
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:deleteAbsenceFilesResponse xmlns:ns1="http://echange.service.open.bodet.com">
<ns1:absenceFilesInError>
<ns1:AbsenceFile>
<ns1:absenceTypeKey xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:absenceFileKey xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:startInTheMorning xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:totalInHours xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:totalInDays xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:fromClockings xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:firstStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:durationInDays xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:numberOfAbsenceDays xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:noticeCessationWorkExtension xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:durationInHours xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondStartTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:resumptionWorkDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:splitHolidaysWaiver xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:absenceTypeAbbreviation>RTT</ns1:absenceTypeAbbreviation>
<ns1:limitedToAPeriod xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:absenceTypeDescription xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:firstEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:repetitiveAbsencePeriod xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:firstStartTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondEndTimePosition xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:existRelatedDocument xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:endingTheAfternoon xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:creationDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:firstEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:secondEndTime xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:lastModificationDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:comment xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:resumptionWorkEarlyDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:lastWorkingDayDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:initialNoticeCessationWorkDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:prescribedEndDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:eventObservingDate xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:endDate>2025-02-27</ns1:endDate>
<ns1:startDate>2025-02-27</ns1:startDate>
<ns1:employeeFirstName xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeKey xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeSurname xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:archivedEmployee xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeBadgeCode xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:employeeIdentificationCode>Retails</ns1:employeeIdentificationCode>
<ns1:employeeIdentificationNumber>00002110</ns1:employeeIdentificationNumber>
<ns1:technicalString xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<ns1:errorMessage>Salarié introuvable</ns1:errorMessage>
</ns1:AbsenceFile>
</ns1:absenceFilesInError>
</ns1:deleteAbsenceFilesResponse>
</soap:Body>
</soap:Envelope>
|
|
Filter on the periods of data to be extracted
