Sv translation

language	de

Info

title	Kompatibilitä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

colour	Green
title	GET

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

Parameter

Beschreibung

Typ

Hinweis

Pflicht

company

RTI Firmenschlüssel

string

ja

import

RTI Importschlüssel

string

ja

format

Ausgabeformat

string

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

language	js
title	JSON 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

language	xml
title	XML 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

Trennzeichen	Semikolon ( ; )
Textbegrenzer	Doppeltes Hochkomma ( " )
Zeilenende	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1
Kodierung	UTF-8

CSV Spalten

Spalte	Beschreibung
ident	optional selbst definierter Identifikator der Tätigkeit	Einstellbar unter Zeiterfassung > Einstellungen > Tätigkeiten Die Standard-Tätigkeit "Gehen" hat immer einen "ident" von "0".
name	selbst definierter Name der Tätigkeit
color	selbst definierte Farbe der Tätigkeit	Format: Hexadezimal Die Standard-Tätigkeit "Gehen" hat hat keine Farbe.
is_worktime	Option ob diese Tätigkeit Bestandteil der Arbeitszeit ist oder nicht.	Mögliche Werte: 0 oder 1
is_standbytime	Option ob diese Tätigkeit Bestandteil einer Bereitschaftszeit ist oder nicht.	Mögliche Werte: 0 oder 1

Beispiel Ausgabe

Code Block

title	Ausgabe 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

title	Abruf der Buchungen im CSV Format

https://map.yellowfox.de/rti/timerecording/get_activities.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&format=csv

Sv translation

language	en

Info

title	Compatibility

This function is intended to be used with timerecording V3

Returns all currently available time recording activities.

Description

Status

colour	Green
title	GET

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

Parameters

parameterParameter

descriptionDescription

typeType

hintNote

mandatoryMandatory

company

RTI company key

string

yes

import

RTI import key

string

yes

format

output format

string

allowed output formats

csv
json
xml

Default is csv.

no

Return values

This function returns a string. On error the return will be "Error:Description".

JSON Format

Returns a JSON formatted text with the properties of each activity.

Example output

Code Block

language	js
title	JSON Ausgabejson output

[
	{ 
		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

Returns an XML formatted text with the properties of each activity.

Example output

Code Block

language	xml
title	XML Ausgabexml output

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

The CSV format contains one line per activity. Fields that can contain multiple data records are output as a JSON string.

Meta information

Separator	Semicolon ( ; )
Delimiter	Double quote ( " )
Line break	0x0D 0x0A (CarriageReturn LineFeed)
Header	Row 1
Encoding	Windows-1252

CSV columns

Column	Description
ident	optional self-defined identifier of the activity	Can be set under Timerecording> Settings> Activities The standard activity "End span" always has an "ident" of "0".
name	self-defined name of the activity
color	self-defined color of the activity	Format: hexadecimal The standard activity "Leaving" has no color.
is_worktime	Option whether this activity is part of a working time or not.	Possible values: 0 or 1
is_standbytime	Option whether this activity is part of a standby time or not.	Possible values: 0 or 1

Example output

Code Block

title	output 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"

Examples

Example call

Code Block

title	Abruf der Buchungen im CSV FormatRetrieval of bookings in CSV format

https://map.yellowfox.de/rti/timerecording/get_activities.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&format=csv

Page tree

Versions Compared

Old Version 19

New Version Current

Key

Beschreibung

Parameter

Rückgabe

JSON Format

Beispiel Ausgabe

XML Format

Beispiel Ausgabe

CSV Format

Metainformationen

CSV Spalten

Beispiel Ausgabe

Beispiele

Description

Parameters

Return values

JSON Format

Example output

XML Format

Example output

CSV Format

Meta information

CSV columns

Example output

Example call

Page tree

Page History

Versions Compared

Old Version 19

New Version Current

Key

Beschreibung

Parameter

Rückgabe

JSON Format

Beispiel Ausgabe

XML Format

Beispiel Ausgabe

CSV Format

Metainformationen

CSV Spalten

Beispiel Ausgabe

Beispiele

Description

Parameters

Return values

JSON Format

Example output

XML Format

Example output

CSV Format

Meta information

CSV columns

Example output

Example call