API Anleitung

Inhalt

Ressourcen > Zeiteinträge

Pfad

https://api.logmytime.de/v1/api.svc/TimeEntries

Eigenschaften

Name Typ Beschreibung
ID Integer Eine eindeutige Zeiteintrags-ID
TypeID Integer Art des Zeiteintrags, 1 steht für einen für Dauer-Zeiteintrag, 2 für Start/Ende
StartTime Datum/Uhrzeit Der Startzeitpunkt des Eintrags, bei Dauer-Zeiteinträgen liegt diese immer zu Mitternacht.
EndTime Datum/Uhrzeit Der Endzeitpunkt des Eintrags.
DurationString String, Read only Die aus Start- und Endzeitpunkt errechnete Dauer des Zeiteintrags im hh:mm format, auf Minuten abgerundet.
DurationSeconds Integer, Read only Die aus Start- und Endzeitpunkt errechnete Dauer des Zeiteintrags in Sekunden
UserID Integer Die ID des Mitarbeiters, dem der Zeiteintrag zugewiesen ist
ProjectID Integer Die Projekt-ID
TaskID Integer Die Tätigkeits-ID, oder 'null' falls keine Tätigkeit existiert.
Comment String, Max. Länge: 1500 Ein optionaler Kommentar zum Zeiteintrag. Auf Anfrage können wir die maximal zulässige Datenmenge für dieses Feld auf bis zu 3500 Zeichen erweitern.
Custom1 bis Custom15 String, Max. Länge: 50 Zusatzfelder für Kunden, falls diese vom Administrator angelegt wurden. Die Konfiguration kann mit der Ressource Kontoeinstellungen per API ausgelesen werden.
Billable Boolean Ist der Zeiteintrag abrechenbar? Default-Wert: True
Locked Boolean Ist der Zeiteintrag abgeschlossen? Abgeschlossene Zeiteinträge können nicht verändert oder gelöscht werden. Default-Wert: False
IsEditable Boolean (read only) Ein Zeiteintrag ist für Standardnutzer nur dann editierbar, wenn er nach dem Buchungsschluss liegt und nicht explizit abgeschlossen wurde. IsEditable wird immer nur serverseitig gesetzt.
HourlyRate decimal (read only) Der für den Zeiteintrag hinterlegte Stundensatz, falls Stundensätze aktiviert sind und der Nutzer, der auf die API zugreift dazu berechtigt ist, Stundensätze zu sehen. Ansonsten ist der Wert des Feldes immer null.
Dieses Feld kann über die API nur ausgelesen, nicht aber beschrieben werden.
Revenue decimal (read only) Der für den Zeiteintrag errechnete Umsatz, falls Stundensätze aktiviert sind und der Nutzer, der auf die API zugreift dazu berechtigt ist, Stundensätze zu sehen. Ansonsten ist der Wert des Feldes immer null.
Dieses Feld kann über die API nur ausgelesen, nicht aber beschrieben werden.
LastChangeTime Datum/Uhrzeit Der Zeitpunkt, zu dem den Zeiteintrag zuletzt verändert wurde
LastChangeAuthor Integer Die ID des Mitarbeiters, der den Zeiteintrag zuletzt geändert hat
StopWatchCertificationStatus Integer Dieses Datenfeld enthält informationen darüber, wie ein Zeiteintrag erstellt wurde. Folgende Werte sind hierbei möglich:
Wert Bedeutung
0 Zeiteintrag wurde erstellt, bevor bei LogMyTime die Unterscheidung zwischen den verschiedenen Zuständen implementiert war
1 Zeiteintrag wurde mit der Stoppuhr erstellt (Über Webseite oder App) und nicht nachträglich verändert.
2 Zeiteintrag wurde nicht mit der Stoppuhr, sondern durch Angabe einer Start- und Endzeit, bzw. einer Arbeitsdauer erstellt.
3 Zeiteintrag wurde mit der Stoppuhr erstellt, aber die Start- oder Endzeit wurde nachträglich geändert.
4 Zeiteintrag wurde mit einem nicht zertifizierten Client über die LogMyTime API importiert
5 Zeiteintrag wurde mit der Stoppuhr in der LogMyTime App erstellt, die Systemzeit auf dem Smartphone oder Tablet

Zugriffsrechte

Lesen Schreiben
Admin ja ja
Erweiterte Nutzerrechte Einstellbar in firmenweiten Einstellungen Einstellbar in firmenweiten Einstellungen
Standardnutzer ja (nur eigene Zeiteinträge) ja (nur eigene Zeiteinträge)

Beispiel

Alle Zeiteinträge mit der Startzeit "im Juli 2010" nach Startzeit sortiert auflisten:

GET http://api.logmytime.de/v1/api.svc/TimeEntries?$filter=month(StartTime) eq 7 and year(StartTime) eq 2010&$orderby=StartTime&ApiKey={apischluessel} 
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<feed xml:base="http://127.0.0.1:7777/V1/API.svc/"
xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
xmlns="http://www.w3.org/2005/Atom">
    ...
    <entry>
      ...
      <content type="application/xml">
        <m:properties>
          <d:ID m:type="Edm.Int32">12009</d:ID>
          <d:TypeID m:type="Edm.Int16">2</d:TypeID>
          <d:UserID m:type="Edm.Int32">58934</d:UserID>
          <d:ProjectID m:type="Edm.Int32">4782</d:ProjectID>
          <d:TaskID m:type="Edm.Int32">22699</d:TaskID>
          <d:StartTime m:type="Edm.DateTime">2010-07-01T13:00:00</d:StartTime>
          <d:EndTime m:type="Edm.DateTime">2010-07-01T15:25:03</d:EndTime>
          <d:DurationString>2:25</d:DurationString>
          <d:DurationSeconds>8703</d:DurationString>
          <d:Comment m:null="true" />
          <d:Billable m:type="Edm.Boolean">True</d:Billable>
          <d:LastChangeAuthor m:type="Edm.Int32">58934</d:LastChangeAuthor>
          <d:LastChangeTime m:type="Edm.DateTime">
            2010-07-20T22:31:13.713
          </d:LastChangeTime>
        </m:properties>
      </content>
    </entry>
    ...weitere Zeiteinträge...
</feed>