REST DokumentationTätigkeitenGET Tätigkeiten auflisten

Tätigkeiten auflisten

Liefert eine paginierte Liste der in diesem Mandanten definierten Tätigkeiten.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

Request

GET /api/v1/activities
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/activities' \
     --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.

Response

{
  "data": [
    {
      "name": "EU",
      "description": "Angebot|en:offer",
      "is_travel": false,
      "is_goodwill": true,
      "note": "Familienurlaub",
      "travel_type": {
        "id": 1,
        "name": "Pure travel"
      }
    }
  ],
  "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
    name
    Type
    string
    Description

    Name der Tätigkeit.

  • Name
    description
    Type
    string, nullable
    Description

    Freitextbeschreibung der Tätigkeit.

  • Name
    is_travel
    Type
    boolean
    Description

    Ob die Tätigkeit als Reisezeit zählt.

  • Name
    is_goodwill
    Type
    boolean, nullable
    Description

    Ob die Tätigkeit nicht abrechenbare Kulanzarbeit ist, die dem Kunden nicht in Rechnung gestellt wird.

  • Name
    note
    Type
    string, nullable
    Description

    Freitextnotiz zur Tätigkeit.

  • Name
    travel_type
    Type
    object, nullable
    Description

    Ob die Tätigkeit reine Reise, reiner Bereitschaftsdienst oder sowohl Reise als auch Bereitschaftsdienst ist.

  • Name
    travel_type.id
    Type
    integer
    Description

    Der gespeicherte Wert. Vergleichen Sie gegen diesen, nicht gegen name.

  • Name
    travel_type.name
    Type
    string
    Description

    Die lesbare Bezeichnung in der Sprache des Mandanten. Nicht parsen.

    Einer der Werte: "Pure travel", "Purely on call", "Travel and on call"

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