Abteilungen auflisten

Liefert eine paginierte Liste der Abteilungen, einschließlich der Anzahl ihrer Unterabteilungen und der Angabe, ob ein Abteilungsleiter zugeordnet ist.

Verfügbarkeit: Vollversion und ZEP Clock

Request

GET /api/v1/departments

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

Query-Parameter

Name
perPage
Type
integer, nullable
Description
Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.
Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.
Name
orderBy
Type
string, nullable
Description
Name des Feldes, nach dem sortiert wird.
Name
order
Type
string, nullable
Description
Sortierrichtung, aufsteigend oder absteigend.
Einer der Werte: "asc", "desc"
Name
limit
Type
integer, nullable
Description
Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.
Name
start_date
Type
string (date)
Description
Name
end_date
Type
string (date)
Description

Response

{
  "data": [
    {
      "id": null,
      "parent_id": 1,
      "name": "EU",
      "description": "Angebot|en:offer",
      "comments": "Wichtiger Kunde - mit Sorgfalt behandeln",
      "status": true,
      "manager": [
        {
          "username": "max.mustermann",
          "firstname": "Max",
          "lastname": "Mustermann",
          "personal_number": "1",
          "email": "erika.mustermann@acme-corp.de"
        }
      ],
      "children": [
        {}
      ],
      "manager_count": 2,
      "children_count": 10,
      "created": "2024-07-20T11:30:00.000000Z",
      "modified": "2024-07-20T12:30:00.000000Z"
    }
  ],
  "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
any
Description
Eindeutige ID der Abteilung.
Name
parent_id
Type
integer, nullable
Description
ID der übergeordneten Abteilung, falls diese Abteilung einer anderen untergeordnet ist.
Name
name
Type
string
Description
Anzeigename der Abteilung.
Name
description
Type
string, nullable
Description
Freitext-Beschreibung des Zwecks oder Aufgabenbereichs der Abteilung.
Name
comments
Type
string, nullable
Description
Interne Freitext-Kommentare zur Abteilung.
Name
status
Type
boolean, nullable
Description
Ob die Abteilung derzeit aktiv ist.
Name
manager
Type
Liste von DepartmentManager
Description
Der Mitarbeiter, der derzeit als Leiter dieser Abteilung zugewiesen ist.
Name
manager.username
Type
string
Description
Eindeutiger Anmeldename des Abteilungsleiters.
Name
manager.firstname
Type
string
Description
Vorname des Abteilungsleiters.
Name
manager.lastname
Type
string
Description
Nachname des Abteilungsleiters.
Name
manager.personal_number
Type
string, nullable
Description
Personalnummer des Abteilungsleiters.
Name
manager.email
Type
string, nullable
Description
Geschäftliche E-Mail-Adresse des Abteilungsleiters.
Name
children
Type
Liste von Department
Description
Die dieser Abteilung direkt untergeordneten Abteilungen.
Name
children.id
Type
any
Description
Eindeutige ID der Abteilung.
Name
children.parent_id
Type
integer, nullable
Description
ID der übergeordneten Abteilung, falls diese Abteilung einer anderen untergeordnet ist.
Name
children.name
Type
string
Description
Anzeigename der Abteilung.
Name
children.description
Type
string, nullable
Description
Freitext-Beschreibung des Zwecks oder Aufgabenbereichs der Abteilung.
Name
children.comments
Type
string, nullable
Description
Interne Freitext-Kommentare zur Abteilung.
Name
children.status
Type
boolean, nullable
Description
Ob die Abteilung derzeit aktiv ist.
Name
children.manager
Type
Liste von DepartmentManager
Description
Der Mitarbeiter, der derzeit als Leiter dieser Abteilung zugewiesen ist.
Name
children.children
Type
Liste von Department
Description
Die dieser Abteilung direkt untergeordneten Abteilungen.
Name
children.manager_count
Type
integer
Description
Ob derzeit ein Abteilungsleiter zugewiesen ist.
Name
children.children_count
Type
integer
Description
Anzahl der dieser Abteilung direkt untergeordneten Abteilungen.
Name
children.created
Type
string (date-time), nullable
Description
Zeitstempel, zu dem die Abteilung angelegt wurde.
Name
children.modified
Type
string (date-time), nullable
Description
Zeitstempel, zu dem die Abteilung zuletzt geändert wurde.
Name
manager_count
Type
integer
Description
Ob derzeit ein Abteilungsleiter zugewiesen ist.
Name
children_count
Type
integer
Description
Anzahl der dieser Abteilung direkt untergeordneten Abteilungen.
Name
created
Type
string (date-time), nullable
Description
Zeitstempel, zu dem die Abteilung angelegt wurde.
Name
modified
Type
string (date-time), nullable
Description
Zeitstempel, zu dem die Abteilung zuletzt geändert wurde.

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

Abteilungen GET Einzelne Abteilung abrufen