API docs by Redocly

Fleet API (0.0.2)

Download OpenAPI specification:

Reservations

List all Reservations

Authorizations:
OAuth2
query Parameters
orderBy
string
Enum: "title" "vehicle_id" "start" "end"

field to order by. Defaults to start

direction
string
Enum: "ASC" "DESC"

Sorting Direction

from
string <date-time>
Example: from=2023-09-29T08:00:00

Reservation Start-date

to
string <date-time>
Example: to=2023-09-29T08:00:00

Reservation End-date

vehicle_ids
integer
Example: vehicle_ids=1,2

Reservation Vehicle (Comma-seperated String)

header Parameters
Accept
required
string

application/json

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create one or multiple Reservations

Authorizations:
OAuth2
query Parameters
orderBy
string
Enum: "title" "vehicle_id" "start" "end"

field to order by. Defaults to start

direction
string
Enum: "ASC" "DESC"

Sorting Direction

from
string <date-time>
Example: from=2023-09-29T08:00:00

Reservation Start-date

to
string <date-time>
Example: to=2023-09-29T08:00:00

Reservation End-date

vehicle_ids
integer
Example: vehicle_ids=1,2

Reservation Vehicle (Comma-seperated String)

header Parameters
Accept
required
string

application/json

Request Body schema: application/json
required
Array
id
integer

internal ID of Reservation

title
required
string

Titel of the Reservation given by the user

start
required
string <date-time>

Start of the Reservation (ISO-8601)

end
required
string <date-time>

End of the Reservation (ISO-8601)

costcenter
string

The Costcenter attached to the reservation (as parsed from the title)

vehicle_id
required
integer

ID of the assigned Vehicle

object (Location)

Location

Array of objects (User)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get single Reservation

Authorizations:
OAuth2
path Parameters
reservation_id
required
string

A unique identifier for a Reservation.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "costcenter": "string",
  • "vehicle_id": 0,
  • "location": {
    },
  • "driver": [
    ]
}

Vehicles

Get all Vehicles

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create one or multiple Vehicles

Authorizations:
OAuth2
Request Body schema: application/json
Array
organisation_id
required
integer
title
required
string
licence_plate
string or null
manufacturer
string or null
model
string or null
description
string or null
object (Location)

Location

object (Location)

Location

vehicle_type
string or null
cv_id
integer or null
calender_id
integer or null
object (Media)

Media Object

Array of objects (Media)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get single Vehicle

Authorizations:
OAuth2
path Parameters
vehicle_id
required
string

A unique identifier for a Vehicle.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "organisation_id": 1,
  • "title": "Firmenfahrzeug 1",
  • "licence_plate": "ZH 12345",
  • "manufacturer": "BMW",
  • "model": "118i",
  • "description": "a short description",
  • "base_location": {
    },
  • "current_location": {
    },
  • "vehicle_type": "PKW",
  • "cv_id": 1,
  • "cv_description": "Fahrzeug 1",
  • "calender_id": 0,
  • "calender_name": "string",
  • "channel_id": "string",
  • "hasElevatedCalenderPermissions": true,
  • "profile_image": {
    },
  • "attachments": [
    ]
}

User

Get all Users

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create one or multiple Users

Authorizations:
OAuth2
query Parameters
sendOnboardingMail
boolean

Send onboarding Mail to newly created users (defaults to false)

createIdentities
boolean

Create Identites for newly created users (defaults to false)

Request Body schema: application/json
Array
email
required
string
name
string
active
boolean
department
string
remark
string
remind_date
string <date>

2023-09-25 09:17:58

accepted_terms_and_conditions
string <date-time>
verified
string <date-time>
verified_by
integer
register_mail_last_sent
string <date-time>
status
integer
Array of objects (Identity)
role
string
Default: "User"
Enum: "User" "Disponent"

Title of the User-Role

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get single User

Authorizations:
OAuth2
path Parameters
user_id
required
string

A unique identifier for a User.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "email": "string",
  • "name": "string",
  • "active": true,
  • "department": "string",
  • "remark": "string",
  • "remind_date": "2019-08-24",
  • "created_at": "2019-08-24",
  • "updated_at": "2019-08-24",
  • "deleted_at": "2019-08-24",
  • "accepted_terms_and_conditions": "2019-08-24T14:15:22Z",
  • "verified": "2019-08-24T14:15:22Z",
  • "verified_by": 0,
  • "register_mail_last_sent": "2019-08-24T14:15:22Z",
  • "status": 0,
  • "identities": [
    ],
  • "role": "User"
}

Trips

Get all VehicleUsages

Authorizations:
OAuth2
query Parameters
orderBy
string
Enum: "started_at" "ended_at" "updated_at"
Example: orderBy=ended_at

field to order by. Defaults to started_at

direction
string
Enum: "ASC" "DESC"
Example: direction=DESC

Sorting Direction. Defaults to ASC

includeZero
integer
Example: includeZero=1

include sessions with zero distance. Defaults to 0

includeDeleted
integer
Example: includeDeleted=1

include deleted sessions. Defaults to 0

lastModified
string <date-time>
Example: lastModified=2024-01-31T10:00:00

limits result to sessions whose updated_at value is greater than given time

Responses

Response samples

Content type
application/json
[
  • {
    }
]