Versions Compared

Old Version 19

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version 20

changes.mady.by.user YellowFox R&D

Saved on

Key

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


Info
titleKompatibilität

Diese Funktion ist nur für Kunden mit aktivierter Zeiterfassung V3 verfügbar.


Gibt alle aktuell verfügbaren Tätigkeiten der Zeiterfassung zurück.

Beschreibung

Status
colourGreen
titleGET
 timerecording/get_activities.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&format=FORMAT_TYPE

Parameter

Parameter

Beschreibung

Typ

Hinweis

Pflicht

companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring
ja
formatAusgabeformatstring

zulässige Ausgabeformate

  • csv
  • json
  • xml

Standard ist csv.

nein
Rückgabewerte

Rückgabe

Es wird ein string zurückgegeben. Im Fehlerfall wird "ERROR:Beschreibung".

JSON Format

Gibt einen JSON formatierten Text zurück mit den Eigenschaften jeder Tätigkeit.

Beispiel Ausgabe

Code Block
languagejs
titleJSON Ausgabe
[
	{ 
		ident: 'A100',
		name: 'Arbeiten',
		color: 'CC0000',
		is_worktime: 1,
		is_standbytime: 0
	},
	{ 
		ident: 'A200',
		name: 'Fahren',
		color: '00CC00',
		is_worktime: 1,
		is_standbytime: 0
	},
	{ 
		ident: 'P100',
		name: 'Pause',
		color: '0000CC',
		is_worktime: 0,
		is_standbytime: 0
	},
	{ 
		ident: 'B100',
		name: 'Bereitschaft',
		color: '0000CC',
		is_worktime: 0,
		is_standbytime: 1
	}
]


XML Format

Gibt einen XML formatierten Text zurück mit den Eigenschaften jeder Tätigkeit.

Beispiel Ausgabe

Code Block
languagexml
titleXML Ausgabe
<?xml version="1.0" encoding="UTF-8"?>
<activities>
   <activity>
      <color>CC0000</color>
      <ident>A100</ident>
      <is_standbytime>0</is_standbytime>
      <is_worktime>1</is_worktime>
      <name>Arbeiten</name>
   </activity>
   <activity>
      <color>00CC00</color>
      <ident>A200</ident>
      <is_standbytime>0</is_standbytime>
      <is_worktime>1</is_worktime>
      <name>Fahren</name>
   </activity>
   <activity>
      <color>0000CC</color>
      <ident>P100</ident>
      <is_standbytime>0</is_standbytime>
      <is_worktime>0</is_worktime>
      <name>Pause</name>
   </activity>
   <activity>
      <color>0000CC</color>
      <ident>B100</ident>
      <is_standbytime>1</is_standbytime>
      <is_worktime>0</is_worktime>
      <name>Bereitschaft</name>
   </activity>
</activities>


CSV Format

Das CSV Format enthält eine Zeile pro Tätigkeit. Felder die mehrere Datensätze enthalten können, werden als JSON String ausgegeben.

Metainformationen

TrennzeichenSemikolon ( ; )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1
KodierungUTF-8

CSV Spalten

Spalte

Beschreibung


 
identoptional selbst definierter Identifikator der TätigkeitEinstellbar unter Zeiterfassung > Einstellungen > Tätigkeiten
Die Standard-Tätigkeit "Gehen" hat immer einen "ident" von "0".
nameselbst definierter Name der Tätigkeit
colorselbst definierte Farbe der TätigkeitFormat: Hexadezimal
Die Standard-Tätigkeit "Gehen" hat hat keine Farbe.
is_worktimeOption ob diese Tätigkeit Bestandteil der Arbeitszeit ist oder nicht.Mögliche Werte: 0 oder 1
is_standbytimeOption ob diese Tätigkeit Bestandteil einer Bereitschaftszeit ist oder nicht.Mögliche Werte: 0 oder 1

Beispiel Ausgabe

Code Block
titleAusgabe in CSV
"ident";"name";"color";"is_worktime";"is_standbytime"


"A100";"Arbeiten";"CC0000";"1";"0"


"A200";"Fahren";"00CC00";"1";"0"


"P100";"Pause";"0000CC";"0";"0"


"B100";"Bereitschaft";"0000CC";"0";"1"

 Beispiele

Code Block
titleAbruf der Buchungen im CSV Format
https://map.yellowfox.de/rti/timerecording/get_activities.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&format=csv


...