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

Beschreibung

Status

colour	Green
title	GET

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

ja

Rückgabewerte

Standard ist csv.

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

Code Block

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

Code Block

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

Code Block

title	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

Code Block

title	Abruf der Buchungen Kostenstellen im CSV Format

httphttps://map.yellowfox.de/rti/timerecording/get_costcenters.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 activitiescost centers.

Description

Status

colour	Green
title	GET

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

Parameters

parameter

description

type

hint

mandatory

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.

noyes

Return values

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

JSON Format

Returns a JSON formatted text with the properties of each activitycost center.

Example output

Code Block

language	js
title	JSON Ausgabe

[
	{ 
		ident: 'A100K1001',
		name: 'ArbeitenBaustelle B',
		colorvalid_from: 'CC00002021-01-01',
		isvalid_worktimeto: 1null,
		isplanned_standbytimeduration: 0
	}20000,
	{defined_activities: [
		{ ident: 'A200A100',
		name: 'Fahren' duration: 18000 },
		color{ ident: '00CC00A200',
		is_worktime: 1,
		is_standbytime: 0
	 duration: 2000 },
		{ 
		ident: 'P100A200',
		name duration: 'Pause',
		color: '0000CC'null }
	],
		is_worktimeallow_other_activities: 0,
		isdefined_standbytimepersons: 0[
	},
	{ 
		identid: 'B1002093',
		 name: 'Bereitschaft',
		color: '0000CC',
		is_worktime: 0,
		is_standbytime: 1
	}
'Max Mustermann' }
	]
}]

XML Format

Returns an XML formatted text with the properties of each activitycost center.

Example output

Code Block

language	xml
title	XML Ausgabe

<?xml version="1.0" encoding="UTF-8"?>
<costcenters>
<activities><costcenter>
   <activity><defined_activities>
      <color>CC0000</color><activity>
      <ident>A100</ident>
   <duration>18000</duration>
   <is_standbytime>0</is_standbytime>
      <is_worktime>1</is_worktime><ident>A100</ident>
      <name>Arbeiten<</name>activity>
   </activity>
   <activity>
       <color>00CC00<  <duration>2000</color>duration>
         <ident>A200</ident>
      <is_standbytime>0</is_standbytime></activity>
      <is_worktime>1</is_worktime><activity>
      <name>Fahren</name>
   </activity>   <duration null="true" />
   <activity>
      <color>0000CC<<ident>A200</color>ident>
      <ident>P100<</ident>activity>
   </defined_activities>
   <is<allow_other_standbytime>0<activities>0</isallow_other_standbytime>activities>
   <ident>K1001</ident>
   <name>Baustelle <is_worktime>0</is_worktime>B</name>
   <defined_persons>
      <name>Pause</name>
<person>
        < <id>2093</activity>ident>
    <activity>
     <name>Max <color>0000CC<Mustermann</color>name>
      <ident>B100<</ident>person>
   </defined_persons>
   <is<planned_standbytime>1<duration>20000</isplanned_standbytime>duration>
      <is_worktime>0</is_worktime><valid_from>2021-01-01</valid_from>
   <valid_to null="true"  <name>Bereitschaft</name>>
   </activity>costcenter>
</activities><costcenters>

CSV Format

The CSV format contains one line per activitycost center. 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

cost center

Can be set under

Timerecording> Settings> Activities
The standard activity "End span" always has an "ident" of "0"

cost center basic data.
name	self-defined name of the

activity

color

self-defined color of the activity

Format: hexadecimal
The standard activity "Walking" has no color.

is_worktime

Option whether this activity is part of a working time or not.

cost center
valid_from	Date since when this cost center has been active.	Format: YYYY-mm-dd
valid_to	optional Date until when this cost center is active	Format: YYYY-mm-dd
planned_duration	optional planned duration of the cost center	in minutes
defined_activities	optional defined activities for this cost center	Format: JSON string
allow_other_activities	Option that determines whether other activities can be posted to this cost center in addition to the activities defined.	Format

Possible values

: 0 or 1

is

defined_

standbytime

persons

optional defined persons for this cost center

Format: JSON string

Option whether this activity is part of a standby time or not.Possible values: 0 or 1

Page tree

Versions Compared

Old Version 8

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

Examples

Page tree

Page History

Versions Compared

Old Version 8

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

Examples