Erfassungsgeräte auflisten

Liefert eine paginierte Liste der registrierten Terminals/Erfassungsgeräte, einschließlich der Anzahl zugeordneter Mitarbeiter und Kategorien.

Verfügbarkeit: Vollversion und ZEP Clock

Request

GET /api/v1/devices

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/devices' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Query-Parameter

Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.

Response

{
  "data": [
    {
      "id": 1,
      "type": 1,
      "status": 1,
      "name": "EU",
      "password": "1234",
      "min_time": "string",
      "max_time": "string",
      "track": 0,
      "display_config": 1,
      "employees": [
        {
          "employee_id": "max.mustermann"
        }
      ],
      "categories": [
        {
          "name": "EU",
          "description": {
            "de": "string",
            "en": "string",
            "fr": "string",
            "es": "string",
            "pl": "string"
          },
          "type": {
            "id": "string",
            "name": "Mitarbeiter/in"
          }
        }
      ],
      "employees_count": 0,
      "categories_count": 0
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response-Felder

Name
id
Type
integer
Description
Eindeutige ID des Erfassungsgeräts.
Name
type
Type
integer, nullable
Description
Art des Terminals (z. B. ein physisches Zeiterfassungsterminal oder eine mobile App).
Name
status
Type
integer, nullable
Description
Ob das Erfassungsgerät derzeit aktiv ist.
Name
name
Type
string
Description
Anzeigename des Erfassungsgeräts.
Name
password
Type
string, nullable
Description
Passwort zur Authentifizierung dieses Erfassungsgeräts, falls konfiguriert.
Name
min_time
Type
string, nullable
Description
Früheste Tageszeit, zu der über dieses Erfassungsgerät Projektzeiten gebucht werden dürfen.
Name
max_time
Type
string, nullable
Description
Späteste Tageszeit, zu der über dieses Erfassungsgerät Projektzeiten gebucht werden dürfen.
Name
track
Type
integer, nullable
Description
Ob Buchungen über dieses Erfassungsgerät separat nachverfolgt werden sollen.
Name
display_config
Type
integer, nullable
Description
Anzeigekonfiguration, die auf dem Erfassungsgerät selbst angewendet wird.
Name
employees
Type
Liste von DeviceEmployee
Description
Mitarbeiter, die dieses Erfassungsgerät derzeit verwenden dürfen.
Name
employees.employee_id
Type
string
Description
Benutzername des Mitarbeiters, der das Erfassungsgerät verwenden darf.
Name
categories
Type
Liste von Category
Description
Kategorien, denen dieses Erfassungsgerät zugeordnet ist.
Name
categories.name
Type
string
Description
Name der Kategorie, wird überall angezeigt, wo eine Entität damit gekennzeichnet ist.
Name
categories.description
Type
object
Description
Ausführlichere Erläuterung, wofür diese Kategorie verwendet werden soll.
Name
categories.type
Type
object
Description
Art der Entität, der diese Kategorie zugeordnet werden kann, z. B. Mitarbeiter, Projekt oder Kunde.
Name
employees_count
Type
integer
Description
Anzahl der Mitarbeiter, die dieses Erfassungsgerät derzeit verwenden dürfen.
Name
categories_count
Type
integer
Description
Anzahl der Kategorien, denen dieses Erfassungsgerät zugeordnet ist.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.

Erfassungsgeräte GET Einzelnes Erfassungsgerät abrufen