API docs by Redocly

DSK API v2 (1.8.140.50)

Download OpenAPI specification:

DSK Systems S.A.: info@dsk.lu URL: https://www.dsk.lu

APIv2 for the DSK environment

Testing

Methods for testing API status

Retrieve API version (raw)

Retrieves the current version and build of the API in plaintext

Responses

Retrieve API version

Retrieves the current version and build of the API

Responses

Response samples

Content type
application/json
{
  • "version": "string",
  • "build": "string"
}

Test resource w/ authentication

Resource can be called to test validity of current user session

Authorizations:
DSKToken

Responses

Test resource w/o authentication

Resource can be called to check status of API

Responses

Session

Methods for user session creation and management

Create a new user session

Attempts to authenticate the user using the badge/pin or login/password pairs

Request Body schema: application/json
required

Auth pair object

login
required
string <= 40 characters
password
required
string
jwt
string or null

Responses

Request samples

Content type
application/json
{
  • "login": "string",
  • "password": "string",
  • "jwt": "string"
}

Response samples

Content type
application/json
{
  • "noPers": 0,
  • "token": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "noSession": 0,
  • "jwt": "string",
  • "failCode": "strin",
  • "failMsg": "string"
}

Destroy a user session

Attempts to destroy current user session

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "noPers": 0,
  • "token": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "noSession": 0,
  • "jwt": "string",
  • "failCode": "strin",
  • "failMsg": "string"
}

Extend a user session

Attempts to extend (double) the lifetime of the current user session

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "noPers": 0,
  • "token": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "noSession": 0,
  • "jwt": "string",
  • "failCode": "strin",
  • "failMsg": "string"
}

Items lists

Methods for retrieval of static items

List of public holidays

Retrieves the list of existing public holidays

Authorizations:
DSKToken
query Parameters
refYear
required
integer <int>

Reference year for the query

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of accounts

Retrieves the list of existing accounts

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List of worksites

Retrieves the list of existing worksites

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List of classes

Retrieves the list of existing classes

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List of companies

Retrieves the list of existing companies

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of cost centers

Retrieves the list of existing cost centers

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of countries

Retrieves the list of existing countries

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of nations

Retrieves the list of existing nations

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of departments

Retrieves the list of existing departments

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List of schedules

Retrieves the list of existing planning schedules

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List of terminals

Retrieves the list of existing terminals

Authorizations:
DSKToken
query Parameters
active
string
Enum: "0" "1"

Limit response to terminals that are currently active

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List of warnings

Retrieves the list of existing warnings

Authorizations:
DSKToken
query Parameters
active
string
Enum: "0" "1"

Limit response to warnings that are currently active

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Accounts

Methods for retrieval of account-related informations

Account

Retrieves the details for the specified account

Authorizations:
DSKToken
path Parameters
noAccount
required
integer <int>

Identifier of the account

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Worksite

Retrieves the details for the specified worksite

Authorizations:
DSKToken
path Parameters
noAccount
required
integer <int>

Identifier of the account

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Schedules

Methods for retrieval of schedule-related informations

Schedule

Retrieves the detail of a single schedule

Authorizations:
DSKToken
path Parameters
noSchedule
required
integer <int>

Identifier of the schedule

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee lists

Methods for retrieval of lists specific to the current user

List of all employees

Retrieves a list of all the employees configured in the system

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

codePers
string <= 20 characters

Filter by employee code

wageNum
string <= 15 characters

Filter by wage number

persId
string <= 20 characters

Filter by SSN identifier

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List of all employees (ID)

Retrieves the identifiers' list of all the employees configured in the system

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

codePers
string <= 20 characters

Filter by employee code

wageNum
string <= 15 characters

Filter by wage number

persId
string <= 20 characters

Filter by SSN identifier

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List of all employees with complete information

Retrieves the complete information of all the employees configured in the system

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

codePers
string <= 20 characters

Filter by employee code

wageNum
string <= 15 characters

Filter by wage number

persId
string <= 20 characters

Filter by SSN identifier

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee data

Methods for retrieval of data specific to the selected employee

Employee planning

Retrieves an employee's planning

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee information

Retrieves an employee's basic information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee pictures

Retrieves all available pictures for the specified employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee display picture

Retrieves the display picture for the specified employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee complete information

Retrieves an employee's full information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee contract information

Retrieves an employee's full contract information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Retrieve all addresses from an employee

Retrieves all addresses for the specified employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Responses

Retrieve target address

Retrieves the targeted address for the specified employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

startDate
required
string <date>

Start date of the requested time period

Responses

Employee absences and absence requests

Retrieves an employee's absences' and absence requests' information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

accounts
string

Comma-separated list of account numbers

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee absences

Retrieves an employee's absences' information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee absences requests

Retrieves an employee's absences requests' information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

status
integer <int>
Enum: 0 1 2 3 4 6 7 9

Status for the absence requests to be retrieved

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee absence cancellation requests

Retrieves an employee's absences cancellation requests informations

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

status
integer <int>
Enum: 0 1 2 3 4 6 7 9

Status for the absence requests to be retrieved

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee absence cancellation requests

Retrieves an employee's absences cancellation requests informations

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee bookings

Retrieves an employee's bookings (grouped by day)

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee balance

Retrieves an employee's current balance and related informations

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
previousMonth
required
string <= 1 characters
Enum: "0" "1"

Date for the retrieve

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee balance (theorethical)

Calculates an employee's theoretical (simulated) flextime balance

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee day bookings

Retrieves an employee's bookings for a specified day

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
theDate
string <date>

Date for the retrieve

Responses

Response samples

Content type
application/json
{
  • "noPers": 0,
  • "curDate": "2019-08-24",
  • "dayBookings": [
    ]
}

Employee counters

Retrieves an employee's counters in the specified year

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
refYear
required
integer <int>

Reference year for the query

refScope
integer <int>
Default: 0
Enum: 0 1 2 3 4

Reference scope for the query (0=all, 1=individual summary, 2=yearly absence report, 3=absence request, 4=absence validation)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employee counter

Retrieves an employee's counter information for the specified year

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

noCounter
required
integer <int>

Identifier of the counter to retrieve

query Parameters
refYear
required
integer <int>

Reference year for the query

refScope
integer <int>
Default: 0
Enum: 0 1 2 3 4

Reference scope for the query (0=all, 1=individual summary, 2=yearly absence report, 3=absence request, 4=absence validation)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Employee accounts values by day

Retrieves an employee's daily accounts values in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee aggregated accounts values by dates

Retrieves an employee's aggregated accounts values in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee account value by dates

Retrieves an employee's account in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

noAccount
required
integer <int>

Identifier of the account

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee external work

Retrieves an employee's counters for all homeoffice and external work events

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee checklist

Retrieves an employee's list of days containing calculation errors and/or warnings in the specified interval

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

showErrors
integer <int>
Default: 1
Enum: 0 1

Retrieve days with calculation errors

showWarnings
integer <int>
Default: 1
Enum: 0 1

Retrieve days with warnings

showRecapValidation
integer <int>
Default: 1
Enum: 0 1

Retrieve months with required validation and/or approval

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee trainings

Retrieves an employee's trainings

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee logs

Retrieves an employee's list of log entries in the specified interval

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
actions
string

Comma-separated list of log action identifiers

dateFrom
required
string <date-time>

Start date of the requested time period

dateTo
required
string <date-time>

End date of the requested time period

dateMode
string
Enum: "target" "event"

Match request date filter on target (modified day) or event (log record date)

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee return date

Retrieves an employee's absence status with his/her's closest return date (if applicable)

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
refDate
string <date>

Reference date for the query

Responses

Checklists

Retrieves a list of days containing calculation errors and/or warnings for all visible employees

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

showErrors
integer <int>
Default: 1
Enum: 0 1

Retrieve days with calculation errors

showWarnings
integer <int>
Default: 1
Enum: 0 1

Retrieve days with warnings

showRecapValidation
integer <int>
Default: 1
Enum: 0 1

Retrieve months with required validation and/or approval

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee operations

Methods for modifiying an employee's data

Edit employee

Edits the specified employee's data

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Request Body schema: application/json
required

Data to be updated for the employee

firstName
required
string <= 50 characters

First name of the employee

lastName
required
string <= 40 characters

Last name of the employee

address
string or null <= 50 characters

Address (street & house nr.)

zipCode
string or null <= 20 characters

Address (zip code)

city
string or null <= 30 characters

Address (city)

country
string or null <= 3 characters

Identifier of the country of residence

privatePhone
string or null <= 30 characters

Personal phone nr.

intPhone
string or null <= 30 characters

Office phone nr.

gsm
string or null <= 30 characters

Mobile phone nr.

email
string or null <= 50 characters

Office email address

emailPersonal
string or null <= 50 characters

Personal email address

birthDate
string or null <date>

Birth date of the employee

birthPlace
string or null <= 50 characters

Birth place of the employee

persId
string or null <= 20 characters

SSN of the employee

gender
string or null <= 1 characters
Enum: "F" "M"

Gender of the employee

nationality
string or null <= 3 characters

Identifier of the country of citizenship

badge1
integer or null <int>

Numeric access card no. 1

badge2
integer or null <int>

Numeric access card no. 2

badge3
integer or null <int>

Numeric access card no. 3

badgestr1
string or null <= 20 characters

Alphanumeric access card no. 1

badgestr2
string or null <= 20 characters

Alphanumeric access card no. 2

badgestr3
string or null <= 20 characters

Alphanumeric access card no. 3

wageNum
string or null <= 15 characters

Payroll identifier of the employee

codePers
string or null <= 20 characters

External identifier of the employee

iban
string or null <= 20 characters

IBAN of the employee

login
string or null <= 40 characters

Login username

password
string or null <= 32 characters

Login password

wageCodeComp
string or null <= 10 characters

Employer SSN for payroll software

noExtraMonthly
integer or null <int>

Identifier of the monthly calculation model

noPRMN
integer or null <int>

Identifier of the PRMN model

limitDaily
integer or null <int>
Default: 660

Maximum daily working time (in minutes)

limitWeekly
integer or null <int>
Default: 2640

Maximum weekly working time (in minutes)

overtime
boolean
Default: true

Activate extended calculations

changeBK0
boolean
Default: false

Activate conversion of bookings at midnight

timeControl
boolean
Default: true

Activate requirement of bookings for daily calculations

timeControlBooking
boolean
Default: false

TBD

inOutControl
boolean
Default: false

Activate in/out control

allowOutWork
boolean
Default: true

Activate external work

allowHomeWorking
boolean
Default: false

Activate home office work

startDateRefBlock
boolean
Default: false

Block STARTDATE update of reference data

endDateRefBlock
boolean
Default: false

Block ENDDATE update of reference data

codeDeptRefBlock
boolean
Default: false

Block DEPT update of reference data

codeCostCenterRefBlock
boolean
Default: false

Block COSTCENTER update of reference data

codeClassRefBlock
boolean
Default: false

Block CLASS update of reference data

isHR
boolean
Default: false

Flag the employee as part of HR

inConflict
boolean
Default: false

Disable automatic GDPR-compliant tasks

printLangue
integer or null <int>
Default: 1
Enum: 1 2 3

Display language for DSK applications

printSummary
boolean
Default: true

Activate the monthly report for the employee

weeklyBreak
boolean
Default: false

Activate a weekly break in the monthly report for the employee

printStat
boolean
Default: true

Activate the stats report for the employee

activJOB
boolean
Default: false

Include the employee in the DSK JOBNET application (requires a valid license)

activLOC
boolean
Default: true

Include the employee in the synchronization tool for DSK LOC

activDSKnet
boolean
Default: false

Include the employee in the DSK DSKNET application (requires a valid license)

activPlanPers
boolean
Default: false

Include the employee in the DSK PLANPERS application (requires a valid license)

activPresAbs
boolean
Default: false

Include the employee in the DSK PRESABS application (requires a valid license)

activDM
boolean
Default: true

Include the employee in the daily view of DSK TIM

activProxsafe
boolean
Default: false

Include the employee in the synchronization tool for PROXSAFE

customB1
boolean

Boolean custom field 1

customB2
boolean

Boolean custom field 2

customB3
boolean

Boolean custom field 3

customB4
boolean

Boolean custom field 4

customB5
boolean

Boolean custom field 5

customB6
boolean

Boolean custom field 6

customB7
boolean

Boolean custom field 7

customB8
boolean

Boolean custom field 8

customC1
string or null <= 40 characters

String custom field 1

customC2
string or null <= 40 characters

String custom field 2

customC3
string or null <= 40 characters

String custom field 3

customC4
string or null <= 40 characters

String custom field 4

customC5
string or null <= 40 characters

String custom field 5

customC6
string or null <= 40 characters

String custom field 6

customC7
string or null <= 40 characters

String custom field 7

customC8
string or null <= 40 characters

String custom field 8

customC9
string or null <= 40 characters

String custom field 9

customC10
string or null <= 40 characters

String custom field 10

customC11
string or null <= 40 characters

String custom field 11

customC12
string or null <= 40 characters

String custom field 12

customC13
string or null <= 40 characters

String custom field 13

customC14
string or null <= 40 characters

String custom field 14

customC15
string or null <= 40 characters

String custom field 15

customC16
string or null <= 40 characters

String custom field 16

customD1
string or null <date>

Date custom field 1

customD2
string or null <date>

Date custom field 2

customD3
string or null <date>

Date custom field 3

customD4
string or null <date>

Date custom field 4

customD5
string or null <date>

Date custom field 5

customD6
string or null <date>

Date custom field 6

customD7
string or null <date>

Date custom field 7

customD8
string or null <date>

Date custom field 8

customD9
string or null <date>

Date custom field 9

customD10
string or null <date>

Date custom field 10

customD11
string or null <date>

Date custom field 11

customD12
string or null <date>

Date custom field 12

customD13
string or null <date>

Date custom field 13

customD14
string or null <date>

Date custom field 14

customD15
string or null <date>

Date custom field 15

customD16
string or null <date>

Date custom field 16

customF1
number or null <float>

Float custom field 1

customF2
number or null <float>

Float custom field 2

customF3
number or null <float>

Float custom field 3

customF4
number or null <float>

Float custom field 4

customF5
number or null <float>

Float custom field 5

customF6
number or null <float>

Float custom field 6

customF7
number or null <float>

Float custom field 7

customF8
number or null <float>

Float custom field 8

Responses

Request samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "country": "str",
  • "privatePhone": "string",
  • "intPhone": "string",
  • "gsm": "string",
  • "email": "string",
  • "emailPersonal": "string",
  • "birthDate": "2019-08-24",
  • "birthPlace": "string",
  • "persId": "string",
  • "gender": "F",
  • "nationality": "str",
  • "badge1": 0,
  • "badge2": 0,
  • "badge3": 0,
  • "badgestr1": "string",
  • "badgestr2": "string",
  • "badgestr3": "string",
  • "wageNum": "string",
  • "codePers": "string",
  • "iban": "string",
  • "login": "string",
  • "password": "string",
  • "wageCodeComp": "string",
  • "noExtraMonthly": 0,
  • "noPRMN": 0,
  • "limitDaily": 660,
  • "limitWeekly": 2640,
  • "overtime": true,
  • "changeBK0": false,
  • "timeControl": true,
  • "timeControlBooking": false,
  • "inOutControl": false,
  • "allowOutWork": true,
  • "allowHomeWorking": false,
  • "startDateRefBlock": false,
  • "endDateRefBlock": false,
  • "codeDeptRefBlock": false,
  • "codeCostCenterRefBlock": false,
  • "codeClassRefBlock": false,
  • "isHR": false,
  • "inConflict": false,
  • "printLangue": 1,
  • "printSummary": true,
  • "weeklyBreak": false,
  • "printStat": true,
  • "activJOB": false,
  • "activLOC": true,
  • "activDSKnet": false,
  • "activPlanPers": false,
  • "activPresAbs": false,
  • "activDM": true,
  • "activProxsafe": false,
  • "customB1": true,
  • "customB2": false,
  • "customB3": true,
  • "customB4": true,
  • "customB5": true,
  • "customB6": true,
  • "customB7": true,
  • "customB8": true,
  • "customC1": null,
  • "customC2": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC3": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC4": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC5": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC6": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC7": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC8": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC9": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC10": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC11": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC12": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC13": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC14": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC15": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customC16": "Lorem ipsum dolor sit amet orci aliquam.",
  • "customD1": "2020-03-10",
  • "customD2": null,
  • "customD3": "2020-03-10",
  • "customD4": "2020-03-10",
  • "customD5": "2020-03-10",
  • "customD6": "2020-03-10",
  • "customD7": "2020-03-10",
  • "customD8": "2020-03-10",
  • "customD9": "2020-03-10",
  • "customD10": "2020-03-10",
  • "customD11": "2020-03-10",
  • "customD12": "2020-03-10",
  • "customD13": "2020-03-10",
  • "customD14": "2020-03-10",
  • "customD15": "2020-03-10",
  • "customD16": "2020-03-10",
  • "customF1": 7.15,
  • "customF2": 0,
  • "customF3": 7.15,
  • "customF4": 1.23,
  • "customF5": 0.75,
  • "customF6": 9.2,
  • "customF7": 1,
  • "customF8": 7.15
}

Delete employee

Deletes all the employee data

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Responses

New contract period

Adds one contract period for the employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Request Body schema: application/json
required

Data for the contract record to be created

startDate
required
string <date>

First day of the specified contract period

endDate
required
string <date>

Last day of the specified contract period

codeDept
string or null <= 20 characters

Identifier of the department the employee belonged to in the specified contract period

codeClass
string or null <= 10 characters

Identifier of the class the employee belonged to in the specified contract period

codeCostCenter
string or null <= 20 characters

Identifier of the cost center the employee belonged to in the specified contract period

codeCompany
string or null <= 20 characters

Identifier of the company the employee belonged to in the specified contract period

noWeekly
integer or null <int>
Default: null

Identifier of the person's weekly work model

nbWorkingDay
integer <int>
Default: 5

Person's number of working days per week in the specified contract period

weeklyContract
number <float>
Default: 40

Person's number of working hours per week in the specified contract period

occupationRate
number <float>
Default: 100

Person's occupation rate (pct.) in the specified contract period

custom1
string or null <= 50 characters

Custom field 1

custom2
string or null <= 50 characters

Custom field 2

custom3
string or null <= 50 characters

Custom field 3

custom4
string or null <= 50 characters

Custom field 4

custom5
string or null <= 50 characters

Custom field 5

custom6
string or null <= 50 characters

Custom field 6

custom7
string or null <= 50 characters

Custom field 7

custom8
string or null <= 50 characters

Custom field 8

customhd1
string or null <date>

Date custom field 1

customhd2
string or null <date>

Date custom field 2

customhd3
string or null <date>

Date custom field 3

customhd4
string or null <date>

Date custom field 4

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "codeDept": "string",
  • "codeClass": "string",
  • "codeCostCenter": "string",
  • "codeCompany": "string",
  • "noWeekly": null,
  • "nbWorkingDay": 5,
  • "weeklyContract": 40,
  • "occupationRate": 100,
  • "custom1": "string",
  • "custom2": "string",
  • "custom3": "string",
  • "custom4": "string",
  • "custom5": "string",
  • "custom6": "string",
  • "custom7": "string",
  • "custom8": "string",
  • "customhd1": "2019-08-24",
  • "customhd2": "2019-08-24",
  • "customhd3": "2019-08-24",
  • "customhd4": "2019-08-24"
}

Delete employee address

Deletes the address record with the specified starting date

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

startDate
required
string <date>

Start date of the requested time period

Responses

Update employee address

Updates the specified address for the employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Request Body schema: application/json
required

Data for the address to be updated

startdate
required
string <date>

Start date for the new address

enddate
string <date>

End date for the new address, can be null

address
string or null <= 50 characters

Address (street & house nr.)

zipCode
string or null <= 20 characters

Address (zip code)

city
string or null <= 30 characters

Address (city)

country
string or null <= 3 characters

Identifier of the country of residence

latitude
number or null <float>

Address latitude coordinate

longitude
number or null <float>

Address longitude coordinate

Responses

Request samples

Content type
application/json
{
  • "startdate": "2025-05-01",
  • "enddate": "2019-08-24",
  • "address": "92 Route d'Arlon",
  • "zipCode": "8311",
  • "city": "Capellen",
  • "country": "LU",
  • "latitude": 0.1,
  • "longitude": 0.1
}

Add employee address

Add new address for the specified employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Request Body schema: application/json
required

Data for the address to be created

startdate
required
string <date>

Start date for the new address

enddate
string <date>

End date for the new address, can be null

address
string or null <= 50 characters

Address (street & house nr.)

zipCode
string or null <= 20 characters

Address (zip code)

city
string or null <= 30 characters

Address (city)

country
string or null <= 3 characters

Identifier of the country of residence

latitude
number or null <float>

Address latitude coordinate

longitude
number or null <float>

Address longitude coordinate

Responses

Request samples

Content type
application/json
{
  • "startdate": "2025-05-01",
  • "enddate": "2019-08-24",
  • "address": "92 Route d'Arlon",
  • "zipCode": "8311",
  • "city": "Capellen",
  • "country": "LU",
  • "latitude": 0.1,
  • "longitude": 0.1
}

Create employee

Creates a new employee record with inital data

Authorizations:
DSKToken
Request Body schema: application/json
required

Data for the employee to be created

firstName
required
string <= 50 characters

First name of the employee

lastName
required
string <= 40 characters

Last name of the employee

address
string or null <= 50 characters

Address (street & house nr.)

zipCode
string or null <= 20 characters

Address (zip code)

city
string or null <= 30 characters

Address (city)

country
string or null <= 3 characters

Identifier of the country of residence

privatePhone
string or null <= 30 characters

Personal phone nr.

intPhone
string or null <= 30 characters

Office phone nr.

gsm
string or null <= 30 characters

Mobile phone nr.

email
string or null <= 50 characters

Office email address

emailPersonal
string or null <= 50 characters

Personal email address

birthDate
string or null <date>

Birth date of the employee

birthPlace
string or null <= 50 characters

Birth place of the employee

persId
string or null <= 20 characters

SSN of the employee

gender
string or null <= 1 characters
Enum: "F" "M"

Gender of the employee

nationality
string or null <= 3 characters

Identifier of the country of citizenship

badge1
integer or null <int>

Numeric access card no. 1

badge2
integer or null <int>

Numeric access card no. 2

badge3
integer or null <int>

Numeric access card no. 3

badgestr1
string or null <= 20 characters

Alphanumeric access card no. 1

badgestr2
string or null <= 20 characters

Alphanumeric access card no. 2

badgestr3
string or null <= 20 characters

Alphanumeric access card no. 3

wageNum
string or null <= 15 characters

Payroll identifier of the employee

codePers
string or null <= 20 characters

External identifier of the employee

iban
string or null <= 20 characters

IBAN of the employee

login
string or null <= 40 characters

Login username

password
string or null <= 32 characters

Login password

wageCodeComp
string or null <= 10 characters

Employer SSN for payroll software

noExtraMonthly
integer <int>
Default: null

Identifier of the monthly calculation model

noPRMN
integer <int>
Default: 1

Identifier of the PRMN model

limitDaily
integer <int>
Default: 660

Maximum daily working time (in minutes)

limitWeekly
integer <int>
Default: 2640

Maximum weekly working time (in minutes)

overtime
boolean
Default: true

Activate extended calculations

changeBK0
boolean
Default: false

Activate conversion of bookings at midnight

timeControl
boolean
Default: true

Activate requirement of bookings for daily calculations

timeControlBooking
boolean
Default: false

TBD

inOutControl
boolean
Default: false

Activate in/out control

allowOutWork
boolean
Default: true

Activate external work

allowHomeWorking
boolean
Default: false

Activate home office work

startDateRefBlock
boolean
Default: false

Block STARTDATE update of reference data

endDateRefBlock
boolean
Default: false

Block ENDDATE update of reference data

codeDeptRefBlock
boolean
Default: false

Block DEPT update of reference data

codeCostCenterRefBlock
boolean
Default: false

Block COSTCENTER update of reference data

codeClassRefBlock
boolean
Default: false

Block CLASS update of reference data

isHR
boolean
Default: false

Flag the employee as part of HR

inConflict
boolean
Default: false

Disable automatic GDPR-compliant tasks

printLangue
integer <int>
Default: 1
Enum: 1 2 3

Display language for DSK applications

printSummary
boolean
Default: true

Activate the monthly report for the employee

weeklyBreak
boolean
Default: false

Activate a weekly break in the monthly report for the employee

printStat
boolean
Default: true

Activate the stats report for the employee

activJOB
boolean

Include the employee in the DSK JOBNET application (requires a valid license)

activLOC
boolean
Default: true

Include the employee in the synchronization tool for DSK LOC

activDSKnet
boolean

Include the employee in the DSK DSKNET application (requires a valid license)

activPlanPers
boolean

Include the employee in the DSK PLANPERS application (requires a valid license)

activPresAbs
boolean

Include the employee in the DSK PRESABS application (requires a valid license)

activDM
boolean
Default: true

Include the employee in the daily view of DSK TIM

activProxsafe
boolean
Default: false

Include the employee in the synchronization tool for PROXSAFE

timezoneBk
integer or null <int>
Default: 3

User timezone identifier to be taken into account for delta calculation when using the virtual booking terminal

excludeCollectiveAg
boolean
Default: false

Person is not covered by the collective work agreement

customB1
boolean
Default: false

Boolean custom field 1

customB2
boolean
Default: false

Boolean custom field 2

customB3
boolean
Default: false

Boolean custom field 3

customB4
boolean
Default: false

Boolean custom field 4

customB5
boolean
Default: false

Boolean custom field 5

customB6
boolean
Default: false

Boolean custom field 6

customB7
boolean
Default: false

Boolean custom field 7

customB8
boolean
Default: false

Boolean custom field 8

customC1
string or null <= 40 characters
Default: null

String custom field 1

customC2
string or null <= 40 characters
Default: null

String custom field 2

customC3
string or null <= 40 characters
Default: null

String custom field 3

customC4
string or null <= 40 characters
Default: null

String custom field 4

customC5
string or null <= 40 characters
Default: null

String custom field 5

customC6
string or null <= 40 characters
Default: null

String custom field 6

customC7
string or null <= 40 characters
Default: null

String custom field 7

customC8
string or null <= 40 characters
Default: null

String custom field 8

customC9
string or null <= 40 characters
Default: null

String custom field 9

customC10
string or null <= 40 characters
Default: null

String custom field 10

customC11
string or null <= 40 characters
Default: null

String custom field 11

customC12
string or null <= 40 characters
Default: null

String custom field 12

customC13
string or null <= 40 characters
Default: null

String custom field 13

customC14
string or null <= 40 characters
Default: null

String custom field 14

customC15
string or null <= 40 characters
Default: null

String custom field 15

customC16
string or null <= 40 characters
Default: null

String custom field 16

customD1
string or null <date>
Default: null

Date custom field 1

customD2
string or null <date>
Default: null

Date custom field 2

customD3
string or null <date>
Default: null

Date custom field 3

customD4
string or null <date>
Default: null

Date custom field 4

customD5
string or null <date>
Default: null

Date custom field 5

customD6
string or null <date>
Default: null

Date custom field 6

customD7
string or null <date>
Default: null

Date custom field 7

customD8
string or null <date>
Default: null

Date custom field 8

customD9
string or null <date>
Default: null

Date custom field 9

customD10
string or null <date>
Default: null

Date custom field 10

customD11
string or null <date>
Default: null

Date custom field 11

customD12
string or null <date>
Default: null

Date custom field 12

customD13
string or null <date>
Default: null

Date custom field 13

customD14
string or null <date>
Default: null

Date custom field 14

customD15
string or null <date>
Default: null

Date custom field 15

customD16
string or null <date>
Default: null

Date custom field 16

customF1
number or null <float>
Default: null

Float custom field 1

customF2
number or null <float>
Default: null

Float custom field 2

customF3
number or null <float>
Default: null

Float custom field 3

customF4
number or null <float>
Default: null

Float custom field 4

customF5
number or null <float>
Default: null

Float custom field 5

customF6
number or null <float>
Default: null

Float custom field 6

customF7
number or null <float>
Default: null

Float custom field 7

customF8
number or null <float>
Default: null

Float custom field 8

Array of objects or null (RS_PersHistoryInput)

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "DOE",
  • "address": "92 Route d'Arlon",
  • "zipCode": "8311",
  • "city": "Capellen",
  • "country": "LU",
  • "privatePhone": "555-123 456",
  • "intPhone": "49 38 72 1",
  • "gsm": "555-123 456",
  • "email": "john.doe@dsk.lu",
  • "emailPersonal": "john.doe@dsk.lu",
  • "birthDate": "2000-01-01",
  • "birthPlace": "Luxembourg",
  • "persId": "2000010163799",
  • "gender": "F",
  • "nationality": "LU",
  • "badge1": 503,
  • "badge2": 504,
  • "badge3": 505,
  • "badgestr1": "A56F0730000503",
  • "badgestr2": "A56F0730000504",
  • "badgestr3": "A56F0730000505",
  • "wageNum": "XXX555",
  • "codePers": "A105",
  • "iban": "LU640031000000000000",
  • "login": "jdoe",
  • "password": "string",
  • "wageCodeComp": "string",
  • "noExtraMonthly": null,
  • "noPRMN": 1,
  • "limitDaily": 660,
  • "limitWeekly": 2640,
  • "overtime": true,
  • "changeBK0": false,
  • "timeControl": true,
  • "timeControlBooking": false,
  • "inOutControl": false,
  • "allowOutWork": true,
  • "allowHomeWorking": false,
  • "startDateRefBlock": false,
  • "endDateRefBlock": false,
  • "codeDeptRefBlock": false,
  • "codeCostCenterRefBlock": false,
  • "codeClassRefBlock": false,
  • "isHR": false,
  • "inConflict": false,
  • "printLangue": 1,
  • "printSummary": true,
  • "weeklyBreak": false,
  • "printStat": true,
  • "activJOB": true,
  • "activLOC": true,
  • "activDSKnet": true,
  • "activPlanPers": true,
  • "activPresAbs": true,
  • "activDM": true,
  • "activProxsafe": false,
  • "timezoneBk": 3,
  • "excludeCollectiveAg": false,
  • "customB1": false,
  • "customB2": false,
  • "customB3": false,
  • "customB4": false,
  • "customB5": false,
  • "customB6": false,
  • "customB7": false,
  • "customB8": false,
  • "customC1": null,
  • "customC2": null,
  • "customC3": null,
  • "customC4": null,
  • "customC5": null,
  • "customC6": null,
  • "customC7": null,
  • "customC8": null,
  • "customC9": null,
  • "customC10": null,
  • "customC11": null,
  • "customC12": null,
  • "customC13": null,
  • "customC14": null,
  • "customC15": null,
  • "customC16": null,
  • "customD1": null,
  • "customD2": null,
  • "customD3": null,
  • "customD4": null,
  • "customD5": null,
  • "customD6": null,
  • "customD7": null,
  • "customD8": null,
  • "customD9": null,
  • "customD10": null,
  • "customD11": null,
  • "customD12": null,
  • "customD13": null,
  • "customD14": null,
  • "customD15": null,
  • "customD16": null,
  • "customF1": null,
  • "customF2": null,
  • "customF3": null,
  • "customF4": null,
  • "customF5": null,
  • "customF6": null,
  • "customF7": null,
  • "customF8": null,
  • "persHistory": [
    ]
}

Edit contract period

Edits the contract record with the specified starting date

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

theDate
required
string <date>

Date

Request Body schema: application/json
required

Contract record to be altered

startDate
required
string <date>

First day of the specified contract period

endDate
required
string <date>

Last day of the specified contract period

codeDept
string or null <= 20 characters

Identifier of the department the employee belonged to in the specified contract period

codeClass
string or null <= 10 characters

Identifier of the class the employee belonged to in the specified contract period

codeCostCenter
string or null <= 20 characters

Identifier of the cost center the employee belonged to in the specified contract period

codeCompany
string or null <= 20 characters

Identifier of the company the employee belonged to in the specified contract period

noWeekly
integer or null <int>
Default: null

Identifier of the person's weekly work model

nbWorkingDay
integer <int>
Default: 5

Person's number of working days per week in the specified contract period

weeklyContract
number <float>
Default: 40

Person's number of working hours per week in the specified contract period

occupationRate
number <float>
Default: 100

Person's occupation rate (pct.) in the specified contract period

custom1
string or null <= 50 characters

Custom field 1

custom2
string or null <= 50 characters

Custom field 2

custom3
string or null <= 50 characters

Custom field 3

custom4
string or null <= 50 characters

Custom field 4

custom5
string or null <= 50 characters

Custom field 5

custom6
string or null <= 50 characters

Custom field 6

custom7
string or null <= 50 characters

Custom field 7

custom8
string or null <= 50 characters

Custom field 8

customhd1
string or null <date>

Date custom field 1

customhd2
string or null <date>

Date custom field 2

customhd3
string or null <date>

Date custom field 3

customhd4
string or null <date>

Date custom field 4

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "codeDept": "string",
  • "codeClass": "string",
  • "codeCostCenter": "string",
  • "codeCompany": "string",
  • "noWeekly": null,
  • "nbWorkingDay": 5,
  • "weeklyContract": 40,
  • "occupationRate": 100,
  • "custom1": "string",
  • "custom2": "string",
  • "custom3": "string",
  • "custom4": "string",
  • "custom5": "string",
  • "custom6": "string",
  • "custom7": "string",
  • "custom8": "string",
  • "customhd1": "2019-08-24",
  • "customhd2": "2019-08-24",
  • "customhd3": "2019-08-24",
  • "customhd4": "2019-08-24"
}

Delete contract period

Deletes the contract record with the specified starting date

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

theDate
required
string <date>

Date

Responses

Get approvers or informed

Retrieves the list of approvers or informed persons for the employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add approver or informed

Adds an approver or informed person for the employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

appType
required
integer <int>
Enum: 1 2 3 4 5 8

Identifier of the approver type (1=approver / 2=informed / 4=delegate / 5=direct input / 3=approver (bookings) / 8=delegate (bookings))

Request Body schema: application/json
required

Data for the approver or informed person to be added

Array
noPers
required
Array of integers <int> [ items <int > ]

List of unique identifiers of the approver

theLevel
integer <int> [ 1 .. 5 ]

Approval level of the approver (at the time of the event)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete approver or informed

Deletes an approver or informed person for the employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

appType
required
integer <int>
Enum: 1 2 3 4 5 8

Identifier of the approver type (1=approver / 2=informed / 4=delegate / 5=direct input / 3=approver (bookings) / 8=delegate (bookings))

Request Body schema: application/json
required

Data for the approver or informed person to be deleted

Array
noPers
required
Array of integers <int> [ items <int > ]

List of unique identifiers of the approver

theLevel
integer <int> [ 1 .. 5 ]

Approval level of the approver (at the time of the event)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Presence state

Methods for retrieval of the employee's latest presence state

PresAbs

Retrieves the list of visible employees with their current status

Authorizations:
DSKToken
query Parameters
count
integer <int>

Maximum number of results to be returned per page

page
integer <int>

Number of the page to be returned

filter
string

Filter string

sort
string

Sort string

secDiff
integer <int>

Maximum delta (in seconds) from current time to include the last status change

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

PresAbs present

Retrieves the list of visible employees (limited to present only)

Authorizations:
DSKToken
query Parameters
pageBreak
string

Page break field to sort results

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

PresAbs from AC

Retrieves the list present/absent employees using data from the access control system

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

PresAbs snapshot

Retrieves the list of visible employees with their status at the requested date and time

Authorizations:
DSKToken
query Parameters
filter
string

Filter string

sort
string

Sort string

date
required
string <date-time>

Date and time

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Trombinoscope

Retrieves the list of visible employees with their data and pictures

Authorizations:
DSKToken
query Parameters
count
integer <int>

Maximum number of results to be returned per page

page
integer <int>

Number of the page to be returned

filter
string

Filter string

sort
string

Sort string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Absences

Methods for retrieval of absence information

Absences

Retrieves absences for all visible employees

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

accounts
string

Comma-separated list of account numbers

count
integer <int>

Maximum number of results to be returned per page

page
integer <int>

Number of the page to be returned

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Absences and absence requests

Retrieves absences and absence requests for all visible employees

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

accounts
string

Comma-separated list of account numbers

count
integer <int>

Maximum number of results to be returned per page

page
integer <int>

Number of the page to be returned

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Absences and absence requests (with restriction)

Retrieves absences for all visible employees without additional information

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

count
integer <int>

Maximum number of results to be returned per page

page
integer <int>

Number of the page to be returned

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Visible absences requests

Retrieves absence requests for all visible employees

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

approvable
integer <int>
Enum: 0 1

Return only requests that can be approved by the user

status
integer <int>
Enum: 0 1 2 3 4 6 7 9

Status for the absence requests to be retrieved

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Bookings

Methods for retrieval of booking information

Bookings

Retrieves bookings (grouped by day) for all visible employees

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Planning

Methods for retrieval of planning information

Planning

Retrieves all the planning information for all visible employees

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

count
integer <int>

Maximum number of results to be returned per page

page
integer <int>

Number of the page to be returned

filter
string

Filter string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Localization

Retrieves the detail of a single localization item

Authorizations:
DSKToken
path Parameters
idLocalization
required
integer <int>

Identifier of the localization

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

List of localizations

Retrieves the list of existing planning localizations

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Activity

Retrieves the detail of a single activity

Authorizations:
DSKToken
path Parameters
idActivity
required
integer <int>

Identifier of the activity

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

List of activities

Retrieves the list of existing planning activities

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Messages

Methods related to the PresAbs messages

List of messages

Retrieves the list of visible messages

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

TimeSheet

Methods for timesheet data extraction

All activities by dates

Retrieves all input data for a activities/projects in the selected time period with custom grouping

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

group
string
Enum: "D" "M" "Q" "Y"

Data grouping

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

All activities total in period

Retrieves all input data for a activities/projects in the selected period

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee activities in period

Retrieves all input data for a activities/projects in the selected period for the specified employee

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

group
string
Enum: "D" "M" "Q" "Y"

Data grouping

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Raw data

Retrieves all input data in a raw format

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

aggregate
integer <int>
Enum: 1 0

Perform data aggregation

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Logs

Methods for retrieval of system log information

Log list

Retrieves a list of log entries for the specified employees in the specified interval

Authorizations:
DSKToken
query Parameters
pers
required
string <= 1024 characters

Comma-separated list of personal identifiers

actions
string

Comma-separated list of log action identifiers

dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Reporting

Methods for retrieval of reporting data

List of consecutive absence days

Retrieves the list of employees with consecutive absence days

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

nbDays
integer <int>
Default: 10

Number of consecutive days

mode
integer <int>
Default: 1
Enum: 1 2 3 4

Report mode (1=days taken, 2=days pending, 3=days taken + pending, 4=days not taken)

filter
string

Filter string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

System status

Methods related to the current system status

Last Reprise

Retrieves the date and time of the last reprise task

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Last PresAbs

Retrieves the date and time of the last PresAbs update task

Authorizations:
DSKToken

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Data management

Methods for data injection operations

Add absences

Adds new absence records to be processed and synchronized

Authorizations:
DSKToken
Request Body schema: application/json
required

Absence data to be created

Array
noPers
required
integer <int>

Unique identifier of the employee

startDate
required
string <date>

Begin date of the absence

endDate
required
string <date>

End date of the absence

noAccount
required
integer <int>

Identifier of the account that will be used

mode
required
integer <int>
Default: 5
Enum: 0 3 5

Mode in which the absence will be attached (0 = normal / 3 = based on contract avg. / 5 = normal (hrs))

unit
required
number <float>
Default: 1
Enum: 0 0.5 1

Duration unit for the absence (0 = hours / 0.5 = half day / 1 = day)

timeMin
integer <int>
Default: 0

Duration of the absence (in minutes, will be recalculated)

startTime
integer <int>
Default: 0

Start time of the absence (in minutes from midnight)

note
string or null <= 1024 characters

Absence notes

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete absences

Deletes existing absence records

Authorizations:
DSKToken
Request Body schema: application/json
required

Absence data to be deleted

Array
noPers
required
integer <int>

Unique identifier of the employee

startDate
required
string <date>

Begin date of the absence

endDate
required
string <date>

End date of the absence

noAccount
required
integer <int>

Identifier of the account that will be used

mode
required
integer <int>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Absence log

Retrieves all absence log records in the specified interval

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Flag processed absence log (bulk)

Set the processed flag for the specified absence log records

Authorizations:
DSKToken
Request Body schema: application/json

An AbsenceHistoryMultiInput object

noAbsenceHistoryList
Array of integers <int> [ items <int > ]

List of absence log records' unique identifiers

Responses

Request samples

Content type
application/json
{
  • "noAbsenceHistoryList": [
    ]
}

Flag processed absence log

Set the processed flag for the specified absence log record

Authorizations:
DSKToken
path Parameters
noAbsenceHistory
required
integer <int>

Identifier of the absence record

Responses

Add bookings

Adds new booking records to be processed and synchronized

Authorizations:
DSKToken
Request Body schema: application/json
required

Booking data to be created

Array
noPers
integer <int>

Unique identifier of the employee

date
string <date>

Date of the booking

time
integer <int>

Time of the booking (in minutes from midnight)

key
integer <int>

Booking key action code

terminal
string or null <= 4 characters

Identifier of the terminal

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Delete bookings

Deletes existing booking records

Authorizations:
DSKToken
Request Body schema: application/json
required

Booking data to be deleted

Array
noPers
integer <int>

Unique identifier of the employee

date
string <date>

Date of the booking

time
integer <int>

Time of the booking (in minutes from midnight)

key
integer <int>

Booking key action code

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Legacy SOAP API

Methods replacing the legacy SOAP/XML interface

All daily calculated accounts by dates

Retrieves all calculated account (accounts + worksites) values for each day in the specified period for all visible employees

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

All daily calculated accounts by dates

Retrieves calculated account values for each day in the specified period for all visible employees

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

All daily calculated worksites by dates

Retrieves calculated worksite values for each day in the specified period for all visible employees

Authorizations:
DSKToken
query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List of modified days

Retrieves the list of day records that were modified after the specified date

Authorizations:
DSKToken
query Parameters
refDate
string <date>

Reference date for the query

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee initial balances

Retrieves an employee's inital balance records in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Employee daily calculated accounts by dates

Retrieves an employee's calculated account values for each day in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee all daily calculated accounts by dates

Retrieves an employees's all calculated account (accounts + worksites) values for each day in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Employee daily calculated worksites by dates

Retrieves an employee's calculated worksite values for each day in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the employee

query Parameters
dateFrom
required
string

Start date of the requested time period

dateTo
required
string

End date of the requested time period

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}