Zuletzt geändert von YellowFox_RD am 2025/01/20 15:37
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((Inhaltsverzeichnis)))
3 {{toc/}}
4
5 (% class="box" %)
6 (((
7 **Kompatibilität
8 **Diese Funktion ist nur für Kunden mit aktivierter Zeiterfassung V3 verfügbar.
9 )))
10
11 Gibt alle aktuell verfügbaren Tätigkeiten der Zeiterfassung zurück.
12 = Beschreibung =
13 **(% class="green mark" %)GET(%%) //timerecording/get_activities.php?company//**//=COMPANY_RTIKEY**&import**=COMPANY_IMPORTKEY**&format**=FORMAT_TYPE//
14 = Parameter =
15 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
16 |company|RTI Firmenschlüssel|string||ja
17 |import|RTI Importschlüssel|string||ja
18 |format|Ausgabeformat|string|zulässige Ausgabeformate
19 (((
20 * csv
21 * json
22 * xml
23 )))
24 Standard ist csv.|nein
25
26 = Rückgabe =
27 Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)".
28 == JSON Format ==
29 Gibt einen JSON formatierten Text zurück mit den Eigenschaften jeder Tätigkeit.
30 === Beispiel Ausgabe ===
31 **JSON Ausgabe**
32 {{code language="js"}}[
33 {
34 ident: 'A100',
35 name: 'Arbeiten',
36 color: 'CC0000',
37 is_worktime: 1,
38 is_standbytime: 0
39 },
40 {
41 ident: 'A200',
42 name: 'Fahren',
43 color: '00CC00',
44 is_worktime: 1,
45 is_standbytime: 0
46 },
47 {
48 ident: 'P100',
49 name: 'Pause',
50 color: '0000CC',
51 is_worktime: 0,
52 is_standbytime: 0
53 },
54 {
55 ident: 'B100',
56 name: 'Bereitschaft',
57 color: '0000CC',
58 is_worktime: 0,
59 is_standbytime: 1
60 }
61 ]{{/code}}
62
63 == XML Format ==
64 Gibt einen XML formatierten Text zurück mit den Eigenschaften jeder Tätigkeit.
65 === Beispiel Ausgabe ===
66 **XML Ausgabe**
67 {{code language="xml"}}<?xml version="1.0" encoding="UTF-8"?>
68 <activities>
69 <activity>
70 <color>CC0000</color>
71 <ident>A100</ident>
72 <is_standbytime>0</is_standbytime>
73 <is_worktime>1</is_worktime>
74 <name>Arbeiten</name>
75 </activity>
76 <activity>
77 <color>00CC00</color>
78 <ident>A200</ident>
79 <is_standbytime>0</is_standbytime>
80 <is_worktime>1</is_worktime>
81 <name>Fahren</name>
82 </activity>
83 <activity>
84 <color>0000CC</color>
85 <ident>P100</ident>
86 <is_standbytime>0</is_standbytime>
87 <is_worktime>0</is_worktime>
88 <name>Pause</name>
89 </activity>
90 <activity>
91 <color>0000CC</color>
92 <ident>B100</ident>
93 <is_standbytime>1</is_standbytime>
94 <is_worktime>0</is_worktime>
95 <name>Bereitschaft</name>
96 </activity>
97 </activities>{{/code}}
98
99 == CSV Format ==
100 Das CSV Format enthält eine Zeile pro Tätigkeit. Felder die mehrere Datensätze enthalten können, werden als JSON String ausgegeben.
101 === Metainformationen ===
102 |=Trennzeichen|Semikolon ( ; )
103 |=Textbegrenzer|Doppeltes Hochkomma ( " )
104 |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
105 |=Header|Zeile 1
106 |=Kodierung|UTF-8
107
108 === CSV Spalten ===
109 |=Spalte|=Beschreibung|=
110 |ident|//optional// selbst definierter Identifikator der Tätigkeit|Einstellbar unter Zeiterfassung > Einstellungen > Tätigkeiten
111 Die Standard-Tätigkeit "Gehen" hat immer einen "ident" von "0".
112 |name|selbst definierter Name der Tätigkeit|
113 |color|selbst definierte Farbe der Tätigkeit|Format: Hexadezimal
114 Die Standard-Tätigkeit "Gehen" hat hat keine Farbe.
115 |is_worktime|Option ob diese Tätigkeit Bestandteil der Arbeitszeit ist oder nicht.|Mögliche Werte: 0 oder 1
116 |is_standbytime|Option ob diese Tätigkeit Bestandteil einer Bereitschaftszeit ist oder nicht.|Mögliche Werte: 0 oder 1
117
118 === Beispiel Ausgabe ===
119 **Ausgabe in CSV**
120 {{code language="java"}}"ident";"name";"color";"is_worktime";"is_standbytime"
121 "A100";"Arbeiten";"CC0000";"1";"0"
122 "A200";"Fahren";"00CC00";"1";"0"
123 "P100";"Pause";"0000CC";"0";"0"
124 "B100";"Bereitschaft";"0000CC";"0";"1"{{/code}}
125
126 = Beispiele =
127 **Abruf der Buchungen im CSV Format**
128 {{code language="java"}}https://map.yellowfox.de/rti/timerecording/get_activities.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&format=csv{{/code}}
129