Times

GET

Get time via ID

/rest/times/time/5

  • Get for time ID 5
Example result

1) 

<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <id>5</id>
    <project_id>11</project_id>
    <cost_centre_id>0</cost_centre_id>
    <work_package_id>12</work_package_id>
    <number>1.5</number>
    <type_id>6</type_id>
    <purpose>Test</purpose>
</xml>

Get times for a member of staff for today

/rest/times/staff/4

  • Get for staff ID 4
Example result

2) 

<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <item0 id="169" purpose="Test" number="2" project_id="6" date="2013-11-14 00:00:00" time_from="" time_to="" .../>
    <item1 id="170" purpose="" number="3.42" project_id="7" date="2013-11-14 00:00:00" time_from="1900-01-10 12:00:00" time_to="1900-01-10 15:25:00"/ .../>
</xml>

Get times for a member of staff for a defined date

/rest/times/staff/4/2011/1/1

  • Get for staff ID 4
  • Get for 2011/Jan/01
Same result as above

3)

Get total times for a project [From X4 26858]

/rest/times/project_total/5

  • Get for project ID 5
Example result

It shows the total hours of all work packages with hours of this project 

<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <item0 work_package_id="544" name="1 Grundlagenermittlung" total="3"/>
    <item1 work_package_id="545" name="2 Vorplanung" total="19.34"/>
</xml>

POST/PUT

Add a new time for social project [From X2 new format]

Social projects (Sozialkostenprojekte) are those projects with the flag is_included_in_time_sheet active.

/rest/times/time

  • Add new
Example request body
staff_id=4&date=2012/06/12&project_id=11&work_package_id=12&number=2&time_to=14%3A00&time_from=12%3A00&purpose=Test
Example result
<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <url>.../rest/times/time/5</url>
</xml>

Possible values

Field Description Valid Values German Name
staff_id Staff ID required,integer Person
date Date required,us_date Datum
project_id Project ID required,integer Projekt
work_package_id Work package ID required,integer Bereich
number Number required,numeric,greater_than[-0.001] Anzahl der Stunden
factor Factor numeric,greater_than[-0.001] Faktor
time_from Time from us_time Zeit von
time_to Time to us_time Zeit bis
purpose Purpose Leistung
purpose_internal Purpose internal Intern

X3 13.0
The cost_centre_id is ignored starting with X3 13.0 and should therefore be omitted for this call.
Setting the cost_centre_id will result in a HTTP Header US-Warning with the above message, but the call will still work.

DELETE

Delete a time for social project time via ID

/rest/times/time/5

  • Delete for time ID 5
Example result
<?xml version="1.0" encoding="UTF-8"?>
<xml>
    <item0>OK</item0>
</xml>
1) , 2) , 3)
From X2 new format