Login English

Entwickler, sei gegrüßt! Die mite.api freut sich auf deine Hacks. Welche Funktionen wie zur Verfügung stehen, erfährst du hier im Dokumentationsbereich.

Hinweis

Leistungen können von Zeiterfassern nur gelesen, nicht jedoch bearbeitet werden.

Alle aktiven Leistungen auflisten

GET /services.xml

Listet alle aktiven Leistungen sortiert nach deren Namen auf.

Response : 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<services type="array">
   <service>
      ...
   </service>
   <service>
      ...
   </service>
</services>

Mit dem Parameter name kann die Liste eingeschränkt werden:

GET /services.xml?name=writing

Listet alle aktiven Leistungen auf, deren Namen 'writing' enthält. Groß-/Kleinschreibung wird ignoriert.

Standardmäßig werden alle Leistungen ausgegeben, die den übergebenen Kriterien entsprechen. Mit dem Parameter limit ist es möglich, die Anzahl zu begrenzen:

GET /services.xml?limit=100

Gibt die ersten 100 Leistungen zurück. Mit dem Parameter page können die darauf folgenden Leistungen ausgegeben werden:

GET /services.xml?limit=100&page=2

Gibt die Leistungen 101 bis 200 zurück.

Alle archivierten Leistungen auflisten

GET /services/archived.xml

Listet alle archivierten Leistungen sortiert nach deren Namen auf. Auch hier ist eine Freitextsuche mit dem Parameter name möglich.

Einzelne Leistung anzeigen

GET /services/{id}.xml

Gibt eine einzelne Leistung zurück.

Response : 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<service>
   <id type="integer">123</id>
   <name>Website Konzeption</name>
   <note></note>
   <billable type="boolean">true</billable>
   <hourly-rate type="integer">3300</hourly-rate>
   <archived type="boolean">false</archived>
   <updated-at type="datetime">2007-12-13T12:12:00+01:00</updated-at>
   <created-at type="datetime">2007-12-13T12:12:00+01:00</created-at>
</service>

Erstellen

POST /services.xml

Erstellt eine neue Leistung. Alle Parameter – bis auf den Namen – sind optional.

note
Default: '' (leerer String)
hourly_rate
in Cent (ein Hundertstel der Basiseinheit, unabhängig von der Währung) - Default: nil
billable
true oder false - Default: true
archived
true oder false - Default: false
Request Body
<service>
   <name>Leistung XY</name>
   <billable>false</billable>
</service>
Response : 201 Created
<?xml version="1.0" encoding="UTF-8"?>
<service>
   <id type="integer">123</id>
   <name>Leistung XY</name>
   <note></note>
   <billable type="boolean">false</billable>
   <hourly-rate type="integer" nil="true"></hourly-rate>
   <archived type="boolean">true</archived>
   <updated-at type="datetime">2008-02-11T22:12:00+01:00</updated-at>
   <created-at type="datetime">2008-02-11T22:12:00+01:00</created-at>
</service>

Bearbeiten

PUT /services/{id}.xml

Aktualisiert eine Leistung mit den übergebenen Parametern.

Request Body
<service>
   <note>Konzeption</note>
</service>
Response : 200 OK

Wird der Stundensatz verändert, kann über den Parameter update_hourly_rate_on_time_entries gesteuert werden, ob der neue Stundensatz auch auf existierende Zeiteinträge angewendet werden soll. Per Default werden die Zeiteinträge nicht aktualisiert; um sie zu aktualisieren setze update_hourly_rate_on_time_entries auf true.

Löschen

DELETE http://demo.mite.yo.lk/services/{id}.xml

Löscht ein Leistung. Dies ist nur möglich, wenn keine Zeiteinträge der Leistung existieren.

Response : 200 OK