Versions Compared

Old Version 12

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version 13

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Abrufen der angelegten Abwesenheiten für alle oder einzelne Mitarbeiter.

Beschreibung

GET /absence_management/get_absences.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&start=YYYYMMDDHHIISS&end=YYYYMMDDHHIISS

Parameter

Parameter

Beschreibung

Typ

Hinweis

Pflicht

companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring
ja
startStart AbfragezeitraumstringFormat: YYYYMMDDHHIISSja
endEnde AbfragezeitraumstringFormat: YYYYMMDDHHIISSja
employeeNumbersArray von Mitarbeiternummernjson

Einschränkung auf bestimmte Mitarbeiter

Wird dieser Parameter nicht angegeben, werden die Abwesenheiten von allen Mitarbeiten ausgegeben, welche eine Mitarbeiternummer besitzen.

Format: [ 'NR1','NR2', ... ]

nein
withHolidaysAusgabe von Feiertagenbool

Pro Mitarbeiter kann ein Feiertagsprofil mit vordefinierten Feiertagen zugewiesen werden. Ist dieser Parameter aktiv, werden diese Feiertage ebenfalls als Abwesenheiten mit ausgegeben. Sie erkennen solche Datensätze am Attribut isHoliday = true.

Standard: true

nein
withDeletedAusgabe von gelöschten Abwesenheitenbool

Gelöschte Abwesenheiten werden standardmäßig nicht mit ausgegeben. Sie können diesen Parameter aktivieren, um einen Abgleich mit Ihren Daten durchzuführen. Sie erkennen gelöschte Datensätze am gesetzten Attribut "deleteDate". 

Standard: false

nein
groupBezeichnung der Personalgruppe, auf welche eingegrenzt werden sollstringEs muss die exakte Bezeichnung einer Personalgruppe angegeben werdennein

Rückgabe

Die Rückgabe erfolgt im JSON-Format. Bei fehlenden Pflichtparametern wird ein "ERROR:Beschreibung" zurückgegeben.


Attribute

AttributFormatBeschreibung
employeeNumberstringMitarbeiternummer zur Identifizierung
createDate

string (nach ISO 8601) | null

Erstelldatum des Eintrags
deleteDatestring (nach ISO 8601) | nullLöschdatum des Eintrags
startDatestring (nach ISO 8601)Beginn der Abwesenheit
endDatestring (nach ISO 8601)Ende der Abwesenheit
factorfloat

Anteil am Arbeitstag in Bezug auf das Arbeitszeitprofil

Wert zwischen 0 und 1 wobei 1 einem ganzen Arbeitstag entspricht

typestringKürzel der Abwesenheitsart wie im Portal hinterlegt
remarkstring | nullOptionaler Beschreibungstext
isRestTimeboolFlag ob es sich dabei um einen Erholungsurlaub handelt
isFlexTimeboolFlag ob diese Abwesenheit vom Gleitzeitkonto abgezogen werden soll 
isHolidayboolFlag ob es sich dabei um einen Feiertag laut Feiertagsprofil handelt

ignored

  • weekDays
  • calendarDays

object

  • int[]
  • string[] (nach ISO 8601)

Abwesenheiten die über einen längeren Zeitraum gehen können Tage innerhalb dieses Zeitraumes ausschließen.

weekDays: Nummern von Wochentagen (Wert 0 bis 6 = Sonntag bis Samstag), z.B. Wochenende

calendarDays: explizite Datumsangaben, z.B. ein Feiertag

workTime

  • targetTimeInMinutes
  • calculatedTimeInMinutes


object

  • int
  • int
  • targetTimeInMinutes = Soll-Arbeitszeit laut Arbeitszeitprofilen während des Abwesenheitszeitraums.
  • calculatedTimeInMinutes = gutgeschriebene Arbeitszeit, abhängig von Soll-Arbeitszeit, Abwesenheits-Anteil und ob die Abwesenheit vom Gleitzeitkonto abgezogen wird (Gleitzeitkonto Abwesenheiten schreiben keine Arbeitszeit gut)


Beispiel

Code Block
[
    {
        "employeeNumber": "0815",
        "createDate": "2021-04-15T13:53:23+02:00",
        "deleteDate": null,
        "startDate": "2021-03-08T00:00:00+01:00",
        "endDate": "2021-03-08T23:59:59+01:00",
        "factor": 1,
        "type": "BA",
        "remark": null,
        "isRestTime": false,
        "isFlexTime": false,
        "isHoliday": false,
        "ignored": {
            "weekDays": [],
            "calendarDays": []
        },
	 	"workTime": {
            "targetTimeInMinutes": 0,
            "calculatedTimeInMinutes": 0
        }
    },
	...
]



Sv translation
languageen

Get all absences for all or specific employees.

Description

GET /absence_management/get_absences.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&start=YYYYMMDDHHIISS&end=YYYYMMDDHHIISS

Parameter

parameter

description

type

hint

mandatory

companyRTI company keystring
yes
importRTI import keystring
yes
startstart of queried timerangestringFormat: YYYYMMDDHHIISSyes
endend of queried timerangestringFormat: YYYYMMDDHHIISSyes
employeeNumbersarray of employee numbersjson

Restriction to specific employees

If this parameter is not set, all absences of all employees, who own an employee number, will be returned

Format: [ 'NR1','NR2', ... ]

no
withHolidaysreturn holidays as wellbool

Each employee can be assigned to a holiday profile. If this parameter is active, the holidays will be returned as absences as well. You can recognize such entries by the atrribute isHoliday = true. 

Default: true

no
withDeletedreturn deleted absences as wellbool

Deleted absences are not returned by default. You can change this by setting this parameter to true. You can recognize such entries by the attribute "deleteDate" being set.

Default: false

no
groupname of the personnel group to which the restriction is to be madestringThe exact name of a personnel group must be givenno

Return value

A string in Json format is returned. Returns "ERROR:description" on error.


Attributes

attribute

format

description

employeeNumberstringemployee number for identification
createDate

string (according to ISO 8601) | null

create date of entry
deleteDatestring (according to ISO 8601) | nulldelete date of entry
startDatestring (according to ISO 8601)begin of absence
endDatestring (according to ISO 8601)end of absence
factorfloat

share of working day based on assigned work profile

value is between 0 and 1 with 1 being equivalent to a full day

typestringshort name of absence type according to portal settings
remarkstring | nulloptional description text
isRestTimeboolflag if this absence is an annual leave
isFlexTimeboolflag if this absence is subtracted from flex time account
isHolidayboolflag if this absence is a holiday according to assigned holiday profile

ignored

  • weekDays
  • calendarDays

object

  • int[]
  • string[] (according to ISO 8601)

Absences with a long duration might exclude some days in between.

weekDays: numbers of weekdays (value 0 to 6 = sunday to saturday), e.g. weekend

calendarDays: explicit dates, e.g. a holiday


Example

Code Block
[
    {
        "employeeNumber": "0815",
        "createDate": "2021-04-15T13:53:23+02:00",
        "deleteDate": null,
        "startDate": "2021-03-08T00:00:00+01:00",
        "endDate": "2021-03-08T23:59:59+01:00",
        "factor": 1,
        "type": "BA",
        "remark": null,
        "isRestTime": false,
        "isFlexTime": false,
        "isHoliday": false,
        "ignored": {
            "weekDays": [],
            "calendarDays": []
        }
    },
	...
]