Timeregistreringer
Hent specifik
Henter en specifik (enkelt) timeregistrering.
GET https://app.tasks.dk/api/time/x (hvor x erstattes med timeregistreringens id)
Response
<reply>
<status>
…
</status>
<data>
<time-entry>
<id>(int) Id</id>
<task-id>(int) Opgaveid</task-id>
<user-id>(int) Brugerid</user-id>
<invoice-status>(string) billed eller unbilled</invoice-status>
<servicetype-id>(int) Ydelsestypeid</servicetype-id>
<actual-minutes>(int) Antal minutter faktisk forbrugt</actual-minutes>
<billable-hours>(decimal) Antal timer der kan faktureres</billable-hours>
<paused-minutes>(int) Samlet antal minutter, opgaven har været pauseret</paused-minutes>
<started>(datetime) Start dato og tid</started>
<ended>(datetime) Slut dato og tid</ended>
<created>(datetime) Dato for oprettelse</created>
<modified>(datetime) Dato for opdatering</modified>
</time-entry>
</data>
</reply>
Hent alle for opgave
Henter alle timeregistreringer for en given opgave.
GET https://app.tasks.dk/api/task/x/time (hvor x erstattes med opgavens id)
Response
<reply>
<status>
…
</status>
<data>
<time-entry>
…
</time-entry>
<time-entry>
…
</time-entry>
…
</data>
</reply>
Opret
Opretter en timeregistrering.
POST https://app.tasks.dk/api/time
Ved oprettelse af timeregistreringer er der følgende regler:
- ‘task-id’, ‘user-id’, ‘servicetype-id’, ‘started’ og ‘ended’ er påkrævede.
- ‘id’, ‘actual-minutes’, ‘billable-hours’, ‘created’ og ‘modified’ skal aldrig angives. De ignoreres selvom de angives.
- Formatet for ‘started’ og ‘ended’ ser således ud: yyyy-mm-ddThh:mm:ss – eksempelvis 2010-04-01T13:24:00 (bemærk T’et).
- Hvis ‘paused-minutes’ angives skal det være et positivt heltal. Ingen kommaer. Værdien fratrækkes den faktiske forbrugte tid.
Start/stop/pause-funktionen fra brugergrænsefladen er ikke eksponeret via API’et. I stedet skal den implementerende applikation selv holde styr på start- og sluttidspunkt. Implementerer man selv en pause-funktion, skal det samlede antal pause-minutter angives i ‘paused-minutes’.
Faktisk forbrugt tid samt fakturerbar tid beregnes automatisk på baggrund af ‘started’, ‘ended’, evt. ‘paused-minutes’ samt indstillingerne for den ydelsestype der tilknyttes via ‘servicetype-id’.
Request
<data>
<task-id>1</task-id>
<user-id>10</user-id>
<servicetype-id>43</servicetype-id>
<started>2010-04-01T13:24:00</started>
<ended>2010-04-01T15:19:00</ended>
</data>
Bemærk, som beskrevet under Best practice, at kun udfyldte/aktuelle felter behøver sendes.
Response
Se samme under “Hent specifik”.
Opdater
Opdaterer en timeregistrering.
PUT https://app.tasks.dk/api/time/x (hvor x erstattes med timeregistreringens id)
Ved opdatering af timeregistreringer er der følgende regler:
- ‘id’, ‘task-id’, ‘user-id’, ‘actual-minutes’, ‘billable-hours’, ‘created’ og ‘modified’ skal aldrig angives. De ignoreres selvom de angives.
- Formatet for ’started’ og ‘ended’ ser således ud: yyyy-mm-ddThh:mm:ss – eksempelvis 2010-04-01T13:24:00 (bemærk T’et).
- Hvis ‘paused-minutes’ angives skal det være et positivt heltal. Ingen kommaer. Værdien fratrækkes den faktiske forbrugte tid.
Faktisk forbrugt tid samt fakturerbar tid beregnes automatisk på baggrund af ’started’, ‘ended’, evt. ‘paused-minutes’ samt indstillingerne for den ydelsestype der tilknyttes via ’servicetype-id’.
Request
Se samme under “Opret”.
Response
Se samme under “Hent specifik”.
Slet
Sletter en timeregistrering, hvis brugeren har rettighederne til det.
DELETE https://app.tasks.dk/api/time/x (hvor x erstattes med timeregisteringens id)
Response
<reply>
<status>
…
</status>
<data></data>
</reply>