Menü
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.

Bitte beachten: Benutzer können über die mite.api von allen Benutzern außer Zeiterfassern gelesen werden, jedoch von niemandem angelegt oder modifiziert werden.

Alle aktiven Benutzer auflisten

Liste alle aktiven Benutzer sortiert nach deren Namen auf:

GET /users.xml
GET /users.json

Parameter

name Gibt nur die Benutzer zurück, deren Namen den übergebenen String enthalten. Groß- und Kleinschreibung wird ignoriert.
email Gibt nur die Benutzer zurück, deren E-Mailadressen den übergebenen String enthalten. Groß- und Kleinschreibung wird ignoriert.
limit Mit dem Parameter limit ist es möglich, die maximale Anzahl der ausgegebenen Benutzer zu begrenzen.
Default: unbegrenzt
page In Kombination mit dem Parameter limit können Folgeseiten ausgegeben werden.
Default: 1

Antwort

Status: 200 OK
[
   {
      "user": {...}
   },
   {
      "user": {...}
   }
]
Status: 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<users type="array">
   <user>
      ...
   </user>
   <user>
      ...
   </user>
</users>

Alle archivierten Benutzer auflisten

Liste alle archivierten Benutzer sortiert nach deren Namen auf:

GET /users/archived.xml
GET /users/archived.json

Es können die gleichen Parameter wie bei den aktiven Benutzern verwendet werden.

Einzelnen Benutzer anzeigen

Rufe eine Benutzer nach dessen id auf:

GET /users/:id.xml
GET /users/:id.json

Antwort

Status: 200 OK
{
   "user": {
      "id": 2453,
      "name": "Willi Wirbelwind",
      "email": "willi@email.com",
      "note": "",
      "created_at": "2013-06-23T23:00:58+02:00",
      "updated_at": "2015-02-14T00:33:26+01:00",
      "archived": false,
      "language": "de",
      "role": "admin"
   }
}
Status: 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<user>
   <id type="integer">2453</id>
   <name>Willi Wirbelwind</name>
   <email>willi@email.com</email>
   <note></note>
   <archived type="boolean">false</archived>
   <role>admin</role>
   <language>de</language>
   <created-at type="datetime">2013-06-23T23:00:58+02:00</created-at>
   <updated-at type="datetime">2015-02-14T00:33:26+01:00</updated-at>
</user>