API docs by Redocly

DSK API (1.6.138.49)

Download OpenAPI specification:

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

DSK API

TestMethods

Methods for testing API status

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

Creates 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
string
password
string

Responses

Request samples

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

Response samples

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

Destroys 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,
  • "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,
  • "failCode": "strin",
  • "failMsg": "string"
}

Accounts

Methods for retrieval of account-related informations

List of accounts

Retrieves the list of existing accounts

Authorizations:
DSKToken

Responses

Response samples

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

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": {
    }
}

List of worksites

Retrieves the list of existing worksites

Authorizations:
DSKToken

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": {
    }
}

List of schedules

Retrieves the list of existing planning schedules

Authorizations:
DSKToken

Responses

Response samples

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

ItemsLists

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
[
  • {
    }
]

UsersLists

Methods for retrieval of lists specific to the current user

Global list of people

Retrieves the list of all the people visible to the current user, in all contexts

Authorizations:
DSKToken
query Parameters
onlyActivePers
required
string
Enum: "0" "1"

Limit response to people that are currently active

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": [
    ]
}

Global list of people (ID)

Retrieves the identifiers' list of all the people visible to the current user, in all contexts

Authorizations:
DSKToken
query Parameters
onlyActivePers
required
string
Enum: "0" "1"

Limit response to people that are currently active

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 visible people

Retrieves a list of people that are visible to the current user in all contexts

Authorizations:
DSKToken
query Parameters
onlyActivePers
required
string
Enum: "0" "1"

Limit response to people that are currently active

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 visible people (ID)

Retrieves the identifiers' list of people that are visible to the current user (in all contexts)

Authorizations:
DSKToken
query Parameters
onlyActivePers
required
string
Enum: "0" "1"

Limit response to people that are currently active

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 all people

Retrieves a list of all the people 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

Responses

Response samples

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

List of visible people (ID)

Retrieves the identifiers' list of all the people 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

Responses

Response samples

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

Pers

Methods for retrieval of data specific to the selected person

All daily calculated accounts by dates

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

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 people

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 people

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": [
    ]
}

Pers info

Retrieves a person's basic information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

Responses

Response samples

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

Pers pictures

Retrieves all displayable pictures for the specified person

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

Responses

Response samples

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

Pers complete info

Retrieves a person's full information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

Responses

Response samples

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

Pers contract info

Retrieves a person's full contract information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

Responses

Response samples

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

Pers absences

Retrieves a person's absences' information (without absence requests)

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers absences requests

Retrieves a person's absences requests' information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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>

Status for the absence requests to be retrieved

Responses

Response samples

Content type
application/json
{
  • "pers": {
    },
  • "isApproved": true,
  • "customFields": [
    ],
  • "abs": [
    ],
  • "absReq": [
    ],
  • "absCancelReq": [
    ],
  • "absCommon": [
    ],
  • "schedules": [
    ]
}

Pers absences cancellation requests

Retrieves a person's absences cancellation requests informations

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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>

Status for the absence requests to be retrieved

Responses

Response samples

Content type
application/json
{
  • "pers": {
    },
  • "isApproved": true,
  • "customFields": [
    ],
  • "abs": [
    ],
  • "absReq": [
    ],
  • "absCancelReq": [
    ],
  • "absCommon": [
    ],
  • "schedules": [
    ]
}

Pers bookings

Retrieves a person's bookings (grouped by day)

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers balance

Retrieves current balance and related informations for a person

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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

Date for the retrieve

Responses

Response samples

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

Pers balance (theorethical)

Calculates the theoretical (simulated) flextime balance for a person

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers initial balances

Retrieves a person's inital balance records in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers day bookings

Retrieves a person's bookings for a specified day

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

query Parameters
theDate
string <date>

Date for the retrieve

Responses

Response samples

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

Pers counters

Retrieves a person's counters in the specified year

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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
[
  • {
    }
]

Pers counter

Retrieves a person's counters for a specified year

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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
[
  • {
    }
]

Pers accounts values by dates

Retrieves a person's accounts in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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
{
  • "pers": {
    },
  • "accounts": [
    ]
}

Pers aggregated accounts values by dates

Retrieves a person's accounts in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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
{
  • "pers": {
    },
  • "accounts": [
    ]
}

Pers all daily calculated accounts by dates

Retrieves a person'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 person

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": [
    ]
}

Pers daily calculated accounts by dates

Retrieves a person's calculated account values for each day in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": [
    ]
}

Pers daily calculated worksites by dates

Retrieves a person's calculated worksite values for each day in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": [
    ]
}

Pers account value by dates

Retrieves a person's account in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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
{
  • "pers": {
    },
  • "accounts": [
    ]
}

Pers planning

Retrieves a person's planning

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers external work

Retrieves a person's counters for all the external work events

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers checklist

Retrieves a list of days containing calculation errors and/or warnings for specified person in the specified interval

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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

Responses

Response samples

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

Pers logs

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

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers return date

Retrieves the absence status for a person with his/her's closest return date (if applicable)

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

query Parameters
refDate
required
string <date>

Reference date for the query

Responses

PresAbs

Retrieves the list of visible people 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 people (limited to employees present)

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 people 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 people 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 people 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": [
    ]
}

Checklists

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

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

Responses

Response samples

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

PersManagement

Methods for modifiying a person's data

Edit employee

Edits the specified employee's data

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

Request Body schema: application/json
required

Data to be updated for the employee

firstName
required
string <= 50 characters

First name of the person

lastName
required
string <= 40 characters

Last name of the person

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 person

birthPlace
string or null <= 50 characters

Birth place of the person

persId
string or null <= 20 characters

SSN of the person

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

Gender of the person

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 person

codePers
string or null <= 20 characters

External identifier of the person

iban
string or null <= 20 characters

IBAN of the person

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 or null
Default: true

Activate extended calculations

changeBK0
boolean or null
Default: false

Activate conversion of bookings at midnight

timeControl
boolean or null
Default: true

Activate requirement of bookings for daily calculations

timeControlBooking
boolean or null
Default: false

TBD

inOutControl
boolean or null
Default: false

Activate in/out control

allowOutWork
boolean or null
Default: true

Activate external work

allowHomeWorking
boolean or null
Default: false

Activate home office work

startDateRefBlock
boolean or null
Default: false

Block STARTDATE update of reference data

endDateRefBlock
boolean or null
Default: false

Block ENDDATE update of reference data

codeDeptRefBlock
boolean or null
Default: false

Block DEPT update of reference data

codeCostCenterRefBlock
boolean or null
Default: false

Block COSTCENTER update of reference data

codeClassRefBlock
boolean or null
Default: false

Block CLASS update of reference data

isHR
boolean or null
Default: false

Flag the person as part of HR

inConflict
boolean or null
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 or null
Default: true

Activate the monthly report for the person

weeklyBreak
boolean or null
Default: false

Activate a weekly break in the monthly report for the person

printStat
boolean or null
Default: true

Activate the stats report for the person

activJOB
boolean or null

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

activLOC
boolean or null
Default: true

Include the person in the synchronization tool for DSK LOC

activDSKnet
boolean or null

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

activPlanPers
boolean or null

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

activPresAbs
boolean or null

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

activDM
boolean or null
Default: true

Include the person in the daily view of DSK TIM

activProxsafe
boolean or null

Include the person in the synchronization tool for PROXSAFE

customB1
boolean or null

Boolean custom field 1

customB2
boolean or null

Boolean custom field 2

customB3
boolean or null

Boolean custom field 3

customB4
boolean or null

Boolean custom field 4

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

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

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

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": true,
  • "activLOC": true,
  • "activDSKnet": true,
  • "activPlanPers": true,
  • "activPresAbs": true,
  • "activDM": true,
  • "activProxsafe": true,
  • "customB1": true,
  • "customB2": true,
  • "customB3": true,
  • "customB4": true,
  • "customC1": "string",
  • "customC2": "string",
  • "customC3": "string",
  • "customC4": "string",
  • "customC5": "string",
  • "customC6": "string",
  • "customC7": "string",
  • "customC8": "string",
  • "customD1": "2019-08-24",
  • "customD2": "2019-08-24",
  • "customD3": "2019-08-24",
  • "customD4": "2019-08-24",
  • "customD5": "2019-08-24",
  • "customD6": "2019-08-24",
  • "customD7": "2019-08-24",
  • "customD8": "2019-08-24",
  • "customF1": 0.1,
  • "customF2": 0.1,
  • "customF3": 0.1,
  • "customF4": 0.1
}

Delete employee

Deletes all the employee data

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

Responses

New contract period

Adds one contract period for the employee

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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

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

codeClass
string or null

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

codeCostCenter
string or null

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

codeCompany
string or null

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

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

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "codeDept": "string",
  • "codeClass": "string",
  • "codeCostCenter": "string",
  • "codeCompany": "string",
  • "nbWorkingDay": 5,
  • "weeklyContract": 40,
  • "occupationRate": 100,
  • "custom1": "string",
  • "custom2": "string",
  • "custom3": "string",
  • "custom4": "string"
}

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 person

lastName
required
string <= 40 characters

Last name of the person

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 person

birthPlace
string or null <= 50 characters

Birth place of the person

persId
string or null <= 20 characters

SSN of the person

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

Gender of the person

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 person

codePers
string or null <= 20 characters

External identifier of the person

iban
string or null <= 20 characters

IBAN of the person

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 or null
Default: true

Activate extended calculations

changeBK0
boolean or null
Default: false

Activate conversion of bookings at midnight

timeControl
boolean or null
Default: true

Activate requirement of bookings for daily calculations

timeControlBooking
boolean or null
Default: false

TBD

inOutControl
boolean or null
Default: false

Activate in/out control

allowOutWork
boolean or null
Default: true

Activate external work

allowHomeWorking
boolean or null
Default: false

Activate home office work

startDateRefBlock
boolean or null
Default: false

Block STARTDATE update of reference data

endDateRefBlock
boolean or null
Default: false

Block ENDDATE update of reference data

codeDeptRefBlock
boolean or null
Default: false

Block DEPT update of reference data

codeCostCenterRefBlock
boolean or null
Default: false

Block COSTCENTER update of reference data

codeClassRefBlock
boolean or null
Default: false

Block CLASS update of reference data

isHR
boolean or null
Default: false

Flag the person as part of HR

inConflict
boolean or null
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 or null
Default: true

Activate the monthly report for the person

weeklyBreak
boolean or null
Default: false

Activate a weekly break in the monthly report for the person

printStat
boolean or null
Default: true

Activate the stats report for the person

activJOB
boolean or null

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

activLOC
boolean or null
Default: true

Include the person in the synchronization tool for DSK LOC

activDSKnet
boolean or null

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

activPlanPers
boolean or null

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

activPresAbs
boolean or null

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

activDM
boolean or null
Default: true

Include the person in the daily view of DSK TIM

activProxsafe
boolean or null

Include the person 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 or null

Person is not covered by the collective work agreement

customB1
boolean or null

Boolean custom field 1

customB2
boolean or null

Boolean custom field 2

customB3
boolean or null

Boolean custom field 3

customB4
boolean or null

Boolean custom field 4

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

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

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

Array of objects or null (RS_PersHistoryInput)

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": true,
  • "activLOC": true,
  • "activDSKnet": true,
  • "activPlanPers": true,
  • "activPresAbs": true,
  • "activDM": true,
  • "activProxsafe": true,
  • "timezoneBk": 3,
  • "excludeCollectiveAg": true,
  • "customB1": true,
  • "customB2": true,
  • "customB3": true,
  • "customB4": true,
  • "customC1": "string",
  • "customC2": "string",
  • "customC3": "string",
  • "customC4": "string",
  • "customC5": "string",
  • "customC6": "string",
  • "customC7": "string",
  • "customC8": "string",
  • "customD1": "2019-08-24",
  • "customD2": "2019-08-24",
  • "customD3": "2019-08-24",
  • "customD4": "2019-08-24",
  • "customD5": "2019-08-24",
  • "customD6": "2019-08-24",
  • "customD7": "2019-08-24",
  • "customD8": "2019-08-24",
  • "customF1": 0.1,
  • "customF2": 0.1,
  • "customF3": 0.1,
  • "customF4": 0.1,
  • "persHistory": [
    ]
}

Edit contract period

Edits the contract record with the specified starting date

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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

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

codeClass
string or null

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

codeCostCenter
string or null

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

codeCompany
string or null

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

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

Responses

Request samples

Content type
application/json
{
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "codeDept": "string",
  • "codeClass": "string",
  • "codeCostCenter": "string",
  • "codeCompany": "string",
  • "nbWorkingDay": 5,
  • "weeklyContract": 40,
  • "occupationRate": 100,
  • "custom1": "string",
  • "custom2": "string",
  • "custom3": "string",
  • "custom4": "string"
}

Delete contract period

Deletes the contract record with the specified starting date

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

theDate
required
string <date>

Date

Responses

TimeSheet

Methods specific to the timesheet input

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": [
    ]
}

All activities in period for person

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

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": [
    ]
}

Absences

Methods for retrieval of absence information and creation/modification of absence requests

Absences

Retrieves absences and absence requests for all visible people

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

Retrieves absences for all visible people 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

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": [
    ]
}

Visible absences requests

Retrieves absence requests for all visible people

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 absence requests that can be approved by the user

status
integer <int>

Status for the absence requests to be retrieved

Responses

Response samples

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

Pers absences

Retrieves a person's absences' information (without absence requests)

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers absences requests

Retrieves a person's absences requests' information

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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>

Status for the absence requests to be retrieved

Responses

Response samples

Content type
application/json
{
  • "pers": {
    },
  • "isApproved": true,
  • "customFields": [
    ],
  • "abs": [
    ],
  • "absReq": [
    ],
  • "absCancelReq": [
    ],
  • "absCommon": [
    ],
  • "schedules": [
    ]
}

Pers absences cancellation requests

Retrieves a person's absences cancellation requests informations

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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>

Status for the absence requests to be retrieved

Responses

Response samples

Content type
application/json
{
  • "pers": {
    },
  • "isApproved": true,
  • "customFields": [
    ],
  • "abs": [
    ],
  • "absReq": [
    ],
  • "absCancelReq": [
    ],
  • "absCommon": [
    ],
  • "schedules": [
    ]
}

Bookings

Methods for retrieval of booking information and creation/modification of booking requests

List of modified days

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

Authorizations:
DSKToken
query Parameters
refDate
required
string <date>

Reference date for the query

Responses

Response samples

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

Pers bookings

Retrieves a person's bookings (grouped by day)

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers day bookings

Retrieves a person's bookings for a specified day

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

query Parameters
theDate
string <date>

Date for the retrieve

Responses

Response samples

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

Counters

Methods related to the counters

Pers counters

Retrieves a person's counters in the specified year

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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
[
  • {
    }
]

Pers counter

Retrieves a person's counters for a specified year

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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
[
  • {
    }
]

Pers external work

Retrieves a person's counters for all the external work events

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

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": [
    ]
}

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": {
    }
}

Planning

Methods for retrieval of planning information

Planning

Retrieves all the planning for all visible people

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": [
    ]
}

Reporting

Methods for retrieval of reporting data

List of consecutive absence days

Retrieves the list of people 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
[
  • {
    }
]

Sync

Methods for bulk 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
integer <int>

Uniquer identifier of the person

startDate
string <date>

Begin date of the absence

endDate
string <date>

End date of the absence

noAccount
integer <int>

Identifier of the account that will be used

mode
integer <int>

Mode in which the absence will be attached

unit
integer <int>

Duration unit for the absence

timeMin
integer <int>

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

startTime
integer <int>

Start time of the absence (in minutes from midnight)

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
integer <int>

Uniquer identifier of the person

startDate
string <date>

Begin date of the absence

endDate
string <date>

End date of the absence

noAccount
integer <int>

Absence account identifier

mode
integer <int>

Absence attachment mode

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

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

Limitation on items pending processing

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>

Uniquer identifier of the person

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 <date>

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>

Uniquer identifier of the person

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
[
  • {
    }
]

FromSOAP

Methods replacing the legacy SOAP/XML interface

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
integer <int>

Uniquer identifier of the person

startDate
string <date>

Begin date of the absence

endDate
string <date>

End date of the absence

noAccount
integer <int>

Identifier of the account that will be used

mode
integer <int>

Mode in which the absence will be attached

unit
integer <int>

Duration unit for the absence

timeMin
integer <int>

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

startTime
integer <int>

Start time of the absence (in minutes from midnight)

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
integer <int>

Uniquer identifier of the person

startDate
string <date>

Begin date of the absence

endDate
string <date>

End date of the absence

noAccount
integer <int>

Absence account identifier

mode
integer <int>

Absence attachment mode

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

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

Limitation on items pending processing

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

All daily calculated accounts by dates

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

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 people

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 people

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": [
    ]
}

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>

Uniquer identifier of the person

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 <date>

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>

Uniquer identifier of the person

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
[
  • {
    }
]

List of modified days

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

Authorizations:
DSKToken
query Parameters
refDate
required
string <date>

Reference date for the query

Responses

Response samples

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

Pers initial balances

Retrieves a person's inital balance records in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": {
    }
}

Pers all daily calculated accounts by dates

Retrieves a person'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 person

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": [
    ]
}

Pers daily calculated accounts by dates

Retrieves a person's calculated account values for each day in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": [
    ]
}

Pers daily calculated worksites by dates

Retrieves a person's calculated worksite values for each day in the specified period

Authorizations:
DSKToken
path Parameters
noPers
required
integer <int>

Identifier of the person

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": [
    ]
}

Version

API version

Retrieves the current version and build of the API in plaintext

Responses

API version

Retrieves the current version and build of the API

Responses

Response samples

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

Logs

Log list

Retrieves a list of log entries for the selected people 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": [
    ]
}

IdentifierLists

Global list of people (ID)

Retrieves the identifiers' list of all the people visible to the current user, in all contexts

Authorizations:
DSKToken
query Parameters
onlyActivePers
required
string
Enum: "0" "1"

Limit response to people that are currently active

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 visible people (ID)

Retrieves the identifiers' list of people that are visible to the current user (in all contexts)

Authorizations:
DSKToken
query Parameters
onlyActivePers
required
string
Enum: "0" "1"

Limit response to people that are currently active

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 visible people (ID)

Retrieves the identifiers' list of all the people 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

Responses

Response samples

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