List the vehicles of the list valid on a date

Vehicles live in dated lists; the list valid on date (default today) is the one with the latest start date on or before it. Before the first list the answer is empty.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

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 parameters

Name
perPage
Type
integer, nullable
Description
Ignored on this endpoint — send limit instead. Any value given here is replaced by limit, or by the default when limit is absent.
Name
page
Type
integer, nullable
Description
The page of results to return, counting from 1.
Name
orderBy
Type
string, nullable
Description
Name of the field to sort by.
Name
order
Type
string, nullable
Description
Sort direction, ascending or descending.
One of: "asc", "desc"
Name
limit
Type
integer, nullable
Description
The number of records per page, 1 to 200. Defaults to 15.
Name
date
Type
string (date), nullable
Description
The day the vehicle list must be valid on, YYYY-MM-DD. Defaults to today.

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 fields

Name
id
Type
string
Description
The vehicle’s short name, the value attendances carry as their vehicle_id.
Name
name
Type
string
Description
Short name of the vehicle.
Name
description
Type
object, nullable
Description
Description of the vehicle per language; null when the vehicle has none.
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

Generated from the OpenAPI specification — edit the source code, not this page.

Vehicles