Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageen


Info
titleCompatibility

This function is intended to be used with timerecording V3


Returns all currently available time recording activitiescost centers.

Description

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

Parameters

parameter

description

type

hint

mandatory

companyRTI company keystring
yes
importRTI import keystring
yes
formatoutput formatstring

allowed output formats

  • csv
  • json
  • xml
yes

Return values

This funtion 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
languagejs
titleJSON 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: 'Pause',
		color: '0000CC',
		is_worktime duration: null }
	],
	allow_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
languagexml
titleXML 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</color>
   <duration>2000</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>
      <name>Bereitschaft</name>
   </activity>
</activities><valid_to null="true" />
</costcenter>
<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

SeparatorSemicolon ( ; )
DelimiterDouble quote ( " )
Line break0x0D 0x0A (CarriageReturn LineFeed)
HeaderRow 1
EncodingWindows-1252

CSV columns

Column

Description


 
identoptional self-defined identifier of the
activity
cost centerCan be set under
Timerecording> Settings> Activities
The standard activity "End span" always has an "ident" of "0"
cost center basic data.
nameself-defined name of the
activity
colorself-defined color of the activityFormat: hexadecimal
The standard activity "Walking" has no color.
is_worktimeOption whether this activity is part of a working time or not.
cost center
valid_fromDate since when this cost center has been active.Format: YYYY-mm-dd
valid_tooptional Date until when this cost center is activeFormat: YYYY-mm-dd
planned_durationoptional planned duration of the cost centerin minutes
defined_activitiesoptional defined activities for this cost centerFormat: JSON string
allow_other_activitiesOption 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
personsoptional defined persons for this cost centerFormat: JSON string
Option whether this activity is part of a standby time or not.Possible values: 0 or 1

Example output


"ident";"name";"
color
valid_from"";
"is
valid_
worktime
to";"
is
planned_
standbytime
duration"

"A100"
;"
Arbeiten
defined_activities";"
CC0000
allow_other_activities";"
1
defined_persons"
;

"
0
K1001"

"A200"
;"
Fahren
Baustelle B";"
00CC00
2021-01-01";"
1
";"
0"
"P100";"Pause";"0000CC";"0";"0"
"B100";"Bereitschaft";"0000CC";"0";"1"
20000";"[{ ident: 'A100', duration: 18000 },{ ident: 'A200', duration: 2000 },{ ident: 'A200', duration: null }]";"0";"[{id:'2093',name:'Max Mustermann'}]"


 Examples


Code Block
titleAbruf der Buchungen im CSV FormatGet cost centers as CSV
http://map.yellowfox.de/rti/timerecording/get_activitiescostcenters.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&format=csv