timerecording/get_costcenters.php
Inhaltsverzeichnis
Kompatibilitä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
GET timerecording/get_costcenters.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&format=FORMAT_TYPE
Parameter
| Parameter | Beschreibung | Typ | Hinweis | Pflicht |
|---|---|---|---|---|
| company | RTI Firmenschlüssel | string | ja | |
| import | RTI Importschlüssel | string | ja | |
| format | Ausgabeformat | string | zulässige Ausgabeformate
| nein |
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 Kostenstelle.
Beispiel Ausgabe
JSON 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
XML 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
| 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 Kostenstelle | Einstellbar über die allgemeinen Daten der Kostenstelle. |
| name | selbst definierter Name der Kostenstelle | |
| valid_from | Datum seit wann diese Kostenstelle aktiv ist | Format: YYYY-mm-dd |
| valid_to | optional Datum bis wann diese Kostenstelle aktiv ist | Format: YYYY-mm-dd |
| planned_duration | optional geplante Dauer der Kostenstelle | in Minuten |
| defined_activities | optional festgelegte Tätigkeiten für diese Kostenstelle | Format: JSON String |
| allow_other_activities | Option die festlegt ob neben den festgelegten Tätigkeiten auch andere Tätigkeiten auf diese Kostenstelle gebucht werden dürfen. | Format: 0 oder 1 |
| defined_persons | optional festgelegte Personen für diese Kostenstelle | Format: JSON String |
Beispiel Ausgabe
Ausgabe in CSV
"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
Kostenstellen im CSV Format
https://map.yellowfox.de/rti/timerecording/get_costcenters.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&format=csv