Alle Mitarbeiter anzeigen

GET /ws/2.0/employees.json

Beispiel

Anfrage: GET /ws/2.0/employees.json

Antwort: 200 OK

[ 
  { 
    "id": 1,
    "username": "om",
    "firstname": "Olaf",
    "lastname": "Meier",
    ...
  }, {
    "id": 2,
    "username": "aa",
    "firstname": "Andrea",
    "lastname": "Andreesen",
    ...
  }, {
    ...
  }
]

Die Antwort besteht aus einer Liste aller in Timicx angelegten Mitarbeiter. Jeder Eintrag im zurückgegebenen Array entspricht dem Format eines einzelnen Mitarbeiters.

Anfrage-Parameter zur Filterung und Sortierung

Parameter Datentyp Standardwert Beschreibung
limit int 100 Beschränkt die Anzahl der zurückgegeben Datensätze.
offset int 0

Gibt die Datensätze ab dem mit offset angegeben Datensatz aus. Die Zählung beginnt bei 0. Die limit-Einschränkung bleibt bestehen.

Beispiel: GET ...?offset=50&limit=25 gibt 25 Datensätze ab dem 50. Datensatz zurück.

orderBy string | array (ohne)

Gibt die Sortierreihenfolge der Datensätze an.

Beispiele:

  • GET ...?orderBy=id
  • GET ...?orderBy[id]=DESC
  • GET ...?orderBy[name]=ASC&orderBy[date]=DESC
enabledOnly boolean false Legt fest, dass nur aktive Mitarbeiter anzeigt werden.

HTTP-Statuscodes

Statuscode Beschreibung
200 OK Die Anfrage war erfolgreich.
400 Bad Request Die Anfrage hat ein ungültiges Format.
403 Forbidden Sie haben keine Berechtigung, die Mitarbeiterdaten anzusehen.