Versions Compared

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 Kostenstellen der Zeiterfassung zurück.

Beschreibung

timerecording/get_costcenters.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
ja

Rückgabewerte

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

JSON Format

Gibt einen JSON Formatierten Text zurück mit den Eigenschaften jeder Kostenstelle.

Beispiel Ausgabe

Code Block
languagejs
titleJSON Ausgabe
[{ 
	ident: 'K1001',
	name: 'Baustelle B',
	valid_from: '2021-01-01',
	valid_to: null,
	planned_duration: 20000,
	defined_activities: [
		{ ident: 'A100', duration: 18000 },
		{ ident: 'A200', duration: 2000 },
		{ ident: 'A200', duration: null }
	],
	allow_other_activities: 0,
	defined_persons: [
		{ id: '2093', name:'Max Mustermann' }
	]
}]


XML Format

Gibt einen XML Formatierten Text zurück mit den Eigenschaften jeder Kostenstelle.

Beispiel Ausgabe

Code Block
languagexml
titleXML Ausgabe
<?xml version="1.0" encoding="UTF-8"?>
<costcenters>
<costcenter>
   <defined_activities>
      <activity>
         <duration>18000</duration>
         <ident>A100</ident>
      </activity>
      <activity>
         <duration>2000</duration>
         <ident>A200</ident>
      </activity>
      <activity>
         <duration null="true" />
         <ident>A200</ident>
      </activity>
   </defined_activities>
   <allow_other_activities>0</allow_other_activities>
   <ident>K1001</ident>
   <name>Baustelle B</name>
   <defined_persons>
      <person>
         <id>2093</ident>
         <name>Max Mustermann</name>
      </person>
   </defined_persons>
   <planned_duration>20000</planned_duration>
   <valid_from>2021-01-01</valid_from>
   <valid_to null="true" />
</costcenter>
<costcenters>


CSV Format

Das CSV Format enthält eine Zeile pro Kostenstelle. 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ätigkeitKostenstelleEinstellbar über die allgemeinen Daten der KostenstelleEinstellbar unter Zeiterfassung > Einstellungen > Tätigkeiten
Die Standard-Tätigkeit "Gehen" hat immer einen "ident" von "0".
nameselbst definierter Name der TätigkeitKostenstelle
colorselbst definierte Farbe der TätigkeitFormat: Hexadezimal
Die Standard-Tätigkeit "Gehen" hat hat keine Farbe.

valid_fromDatum seit wann diese Kostenstelle aktiv istFormat: YYYY-mm-dd
valid_tooptional Datum bis wann diese Kostenstelle aktiv istFormat: YYYY-mm-dd
planned_durationoptional geplante Dauer der Kostenstellein Minuten
defined_activitiesoptional festgelegte Tätigkeiten für diese KostenstelleFormat: JSON String
allow_other_activitiesOption die festlegt ob neben den festgelegten Tätigkeiten auch andere Tätigkeiten auf diese Kostenstelle gebucht werden dürfen. Formatis_worktimeOption ob diese Tätigkeit Bestandteil der Arbeitszeit ist oder nicht.Mögliche Werte: 0 oder 1
isdefined_standbytimeOption ob diese Tätigkeit Bestandteil einer Bereitschaftszeit ist oder nicht.personsoptional festgelegte Personen für diese KostenstelleFormat: JSON StringMögliche Werte: 0 oder 1

Beispiel Ausgabe


"ident";"name";"valid_from"";valid_to";"planned_duration";"defined_activities";"allow_other_activities";"defined_persons"
"K1001";"Baustelle B";"2021-01-01";"";"20000";"[{ ident: 'A100', duration: 18000 },{ ident: 'A200', duration: 2000 },{ ident: 'A200', duration: null }]";"0";"[{id:'2093',name:'Max Mustermann'}]"


 Beispiele


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


...