REST DokumentationVehiclesGET Fahrzeuge der an einem Stichtag gültigen Liste auflisten

Fahrzeuge der an einem Stichtag gültigen Liste auflisten

Fahrzeuge liegen in datierten Listen; gültig ist die Liste, deren Startdatum am oder vor date (Standard: heute) liegt und das späteste ist. Vor der ersten Liste ist die Antwort leer.

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

Request

GET /api/v1/vehicles
curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/vehicles' \
     --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
    date
    Type
    string (date), nullable
    Description

    Der Tag, an dem die Fahrzeugliste gültig sein muss, JJJJ-MM-TT. Standardwert ist heute.

Response

{
  "data": [
    {
      "id": "PKW",
      "name": "PKW",
      "description": {
        "de": "Dienstwagen"
      }
    }
  ],
  "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
    string
    Description

    Das Kürzel des Fahrzeugs, der Wert, den Projektzeiten als vehicle_id tragen.

  • Name
    name
    Type
    string
    Description

    Kürzel des Fahrzeugs.

  • Name
    description
    Type
    object, nullable
    Description

    Beschreibung des Fahrzeugs je Sprache; null, wenn das Fahrzeug keine hat.

  • Name
    description.de
    Type
    string, nullable
    Description
  • Name
    description.en
    Type
    string
    Description
  • Name
    description.fr
    Type
    string
    Description
  • Name
    description.es
    Type
    string
    Description
  • Name
    description.pl
    Type
    string
    Description
Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.