Vehicles

List vehicles

GET

/vehicles

GET

/vehicles

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Response Body

Fahrzeuge

application/json

response

[index: integer]?

Example Request

curl -X GET 'https://example.com/api/v1/vehicles'

Example Request

curl -X GET 'https://example.com/api/v1/vehicles'

Example ResponseSchema200

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "licensePlate": "string",
    "vin": "string",
    "odometerKm": 0,
    "color": "string",
    "notes": "string",
    "bluetoothMac": "string",
    "businessReimbursementRateEur": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
]

[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "licensePlate": "string",    "vin": "string",    "odometerKm": 0,    "color": "string",    "notes": "string",    "bluetoothMac": "string",    "businessReimbursementRateEur": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }]

Create vehicle

POST

/vehicles

POST

/vehicles

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Request Body

application/json

body

name*string

Length1 <= length

licensePlate?string|null

vin?string|null

odometerKm?|

Range0 <= value

color?string|null

notes?string|null

bluetoothMac?|

Match^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$

businessReimbursementRateEur?|

Default employer mileage reimbursement (EUR per km); null removes it. Omitted on update = unchanged.

Range0 <= value <= 1000

Response Body

Fahrzeug angelegt

application/json

response

id*string

Formatuuid

name*string

licensePlate?string|null

vin?string|null

odometerKm?|

Range0 <= value

color?string|null

notes?string|null

bluetoothMac?string|null

businessReimbursementRateEur?|

Default employer mileage reimbursement (EUR per km). Copied into a trip when it becomes a business trip and has no rate yet.

Range0 <= value

createdAt*string

Formatdate-time

updatedAt?string

Formatdate-time

Example Request

curl -X POST 'https://example.com/api/v1/vehicles' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

Example Request

curl -X POST 'https://example.com/api/v1/vehicles' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'

Example ResponseSchema201

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "licensePlate": "string",
  "vin": "string",
  "odometerKm": 0,
  "color": "string",
  "notes": "string",
  "bluetoothMac": "string",
  "businessReimbursementRateEur": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "licensePlate": "string",  "vin": "string",  "odometerKm": 0,  "color": "string",  "notes": "string",  "bluetoothMac": "string",  "businessReimbursementRateEur": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Get vehicle

GET

/vehicles/{id}

GET

/vehicles/{id}

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Path Parameters

id*string

Formatuuid

Response Body

Fahrzeug

application/json

response

id*string

Formatuuid

name*string

licensePlate?string|null

vin?string|null

odometerKm?|

Range0 <= value

color?string|null

notes?string|null

bluetoothMac?string|null

businessReimbursementRateEur?|

Default employer mileage reimbursement (EUR per km). Copied into a trip when it becomes a business trip and has no rate yet.

Range0 <= value

createdAt*string

Formatdate-time

updatedAt?string

Formatdate-time

Example Request

curl -X GET 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08'

Example Request

curl -X GET 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08'

Example ResponseSchema200

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "licensePlate": "string",
  "vin": "string",
  "odometerKm": 0,
  "color": "string",
  "notes": "string",
  "bluetoothMac": "string",
  "businessReimbursementRateEur": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "licensePlate": "string",  "vin": "string",  "odometerKm": 0,  "color": "string",  "notes": "string",  "bluetoothMac": "string",  "businessReimbursementRateEur": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Delete vehicle

DELETE

/vehicles/{id}

DELETE

/vehicles/{id}

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Path Parameters

id*string

Formatuuid

Response Body

Fahrzeug gelöscht

Example Request

curl -X DELETE 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08'

Example Request

curl -X DELETE 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08'

Example Response204

Empty

Update vehicle

PUT

/vehicles/{id}

PUT

/vehicles/{id}

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Path Parameters

id*string

Formatuuid

Request Body

application/json

body

name*string

Length1 <= length

licensePlate?string|null

vin?string|null

odometerKm?|

Range0 <= value

color?string|null

notes?string|null

bluetoothMac?|

Match^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$

businessReimbursementRateEur?|

Default employer mileage reimbursement (EUR per km); null removes it. Omitted on update = unchanged.

Range0 <= value <= 1000

Response Body

Fahrzeug aktualisiert

application/json

response

id*string

Formatuuid

name*string

licensePlate?string|null

vin?string|null

odometerKm?|

Range0 <= value

color?string|null

notes?string|null

bluetoothMac?string|null

businessReimbursementRateEur?|

Default employer mileage reimbursement (EUR per km). Copied into a trip when it becomes a business trip and has no rate yet.

Range0 <= value

createdAt*string

Formatdate-time

updatedAt?string

Formatdate-time

Example Request

curl -X PUT 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

Example Request

curl -X PUT 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'

Example ResponseSchema200

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "licensePlate": "string",
  "vin": "string",
  "odometerKm": 0,
  "color": "string",
  "notes": "string",
  "bluetoothMac": "string",
  "businessReimbursementRateEur": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "licensePlate": "string",  "vin": "string",  "odometerKm": 0,  "color": "string",  "notes": "string",  "bluetoothMac": "string",  "businessReimbursementRateEur": 0,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

Set default vehicle

PUT

/vehicles/{id}/default

PUT

/vehicles/{id}/default

curl -X PUT 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/default'

Example Request

curl -X PUT 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/default'

Example Response200

Empty

Update Bluetooth assignment

PUT

/vehicles/{id}/bluetooth

PUT

/vehicles/{id}/bluetooth

body

bluetoothMac*|

Match^([0-9A-Fa-f]{2}:){5}[0-9A-Fa-f]{2}$

Response Body

Bluetooth-Zuordnung aktualisiert

Example Request

curl -X PUT 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/bluetooth' \
  -H 'Content-Type: application/json' \
  -d '{
  "bluetoothMac": "string"
}'

Example Request

curl -X PUT 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/bluetooth' \  -H 'Content-Type: application/json' \  -d '{  "bluetoothMac": "string"}'

Example Response200

Empty

Get shared-user trip activity for an owned vehicle

GET

/vehicles/{id}/shared-trip-activity

GET

/vehicles/{id}/shared-trip-activity

curl -X GET 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/shared-trip-activity'

Example Request

curl -X GET 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/shared-trip-activity'

Example Response

Empty

List confirmed vehicle shares

GET

/vehicles/{id}/shares

GET

/vehicles/{id}/shares

curl -X GET 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/shares'

Example Request

curl -X GET 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/shares'

Example Response200

Empty

POST

/vehicles/{id}/shares

POST

/vehicles/{id}/shares

body

email*string

Formatemail

Response Body

Einladung versendet

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/shares' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com"
}'

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/shares' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'

Example Response202

Empty

DELETE

/vehicles/{id}/shares/{userId}

DELETE

/vehicles/{id}/shares/{userId}

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Path Parameters

id*string

Formatuuid

userId*string

Formatuuid

Response Body

Freigabe entfernt

Example Request

curl -X DELETE 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/shares/497f6eca-6276-4993-bfeb-53cbbbba6f08'

Example Request

curl -X DELETE 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/shares/497f6eca-6276-4993-bfeb-53cbbbba6f08'

Example Response204

Empty

POST

/vehicles/{id}/share-link

POST

/vehicles/{id}/share-link

Der Link ist 24 Stunden gültig. Nach sieben Tagen wird der Einladungsdatensatz gelöscht.

response

url*string

Formaturi

expiresAt*string

Formatdate-time

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/share-link'

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/share-link'

Example ResponseSchema201

{
  "url": "http://example.com",
  "expiresAt": "2019-08-24T14:15:22Z"
}

{  "url": "http://example.com",  "expiresAt": "2019-08-24T14:15:22Z"}

GET

/vehicles/share-invitations/inspect

GET

/vehicles/share-invitations/inspect

curl -X GET 'https://example.com/api/v1/vehicles/share-invitations/inspect?token=stringstringstringst'

Example Request

curl -X GET 'https://example.com/api/v1/vehicles/share-invitations/inspect?token=stringstringstringst'

Example Response

Empty

GET

/vehicles/share-invitations/pending

GET

/vehicles/share-invitations/pending

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Response Body

Ausstehende Einladungen

Example Request

curl -X GET 'https://example.com/api/v1/vehicles/share-invitations/pending'

Example Request

curl -X GET 'https://example.com/api/v1/vehicles/share-invitations/pending'

Example Response200

Empty

POST

/vehicles/share-invitations/respond

POST

/vehicles/share-invitations/respond

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Request Body

application/json

body

token*string

Length20 <= length

action*string

Value in"accept""decline"

Response Body

Einladung beantwortet

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/share-invitations/respond' \
  -H 'Content-Type: application/json' \
  -d '{
  "token": "stringstringstringst",
  "action": "accept"
}'

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/share-invitations/respond' \  -H 'Content-Type: application/json' \  -d '{  "token": "stringstringstringst",  "action": "accept"}'

Example Response

Empty

Deregister owned vehicle

POST

/vehicles/{id}/deregister

POST

/vehicles/{id}/deregister

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/deregister'

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/deregister'

Example Response200

Empty

Get archived owned vehicles

GET

/vehicles/archive

GET

/vehicles/archive

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Response Body

Archivierte Fahrzeuge

Example Request

curl -X GET 'https://example.com/api/v1/vehicles/archive'

Example Request

curl -X GET 'https://example.com/api/v1/vehicles/archive'

Example Response200

Empty

Restore archived vehicle

POST

/vehicles/{id}/restore

POST

/vehicles/{id}/restore

Stellt das Fahrzeug als abgemeldetes/inaktives Fahrzeug wieder her. Eine Wiederanmeldung erfolgt separat.

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore'

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore'

Example Response

Empty

Re-register deregistered vehicle

POST

/vehicles/{id}/register

POST

/vehicles/{id}/register

Startet eine neue aktive Besitzperiode; frühere Abmeldungen und Fahrten bleiben erhalten.

body

effectiveAt?string

Formatdate-time

Response Body

Fahrzeug wieder angemeldet

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/register' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/register' \  -H 'Content-Type: application/json' \  -d '{}'

Example Response

Empty

Transfer vehicle ownership

POST

/vehicles/{id}/transfer

POST

/vehicles/{id}/transfer

body

account*string

transferAt*string

Formatdate-time

Response Body

Besitzerwechsel gespeichert

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/transfer' \
  -H 'Content-Type: application/json' \
  -d '{
  "account": "string",
  "transferAt": "2019-08-24T14:15:22Z"
}'

Example Request

curl -X POST 'https://example.com/api/v1/vehicles/497f6eca-6276-4993-bfeb-53cbbbba6f08/transfer' \  -H 'Content-Type: application/json' \  -d '{  "account": "string",  "transferAt": "2019-08-24T14:15:22Z"}'

Example Response200

Empty

Get saved odometer readings

GET

/odometer

GET

/odometer

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Response Body

Kilometerstand-Ablesungen

Example Request

curl -X GET 'https://example.com/api/v1/odometer'

Example Request

curl -X GET 'https://example.com/api/v1/odometer'

Example Response200

Empty

Get missing monthly odometer readings

GET

/odometer/pending

GET

/odometer/pending

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Response Body

Fehlende Messwerte

Example Request

curl -X GET 'https://example.com/api/v1/odometer/pending'

Example Request

curl -X GET 'https://example.com/api/v1/odometer/pending'

Example Response200

Empty

Save monthly odometer reading

PUT

/odometer/{vehicleId}/{month}

PUT

/odometer/{vehicleId}/{month}

Authorization

bearerAuth

headerAuthorizationBearer <JWT>

Path Parameters

vehicleId*string

Formatuuid

month*string

Match^\d{4}-(0[1-9]|1[0-2])$

Request Body

application/json

body

odometerKm*number

Range0 <= value <= 10000000

readingDate?string

Kalendertag im Monat (Kontozeitzone)

Formatdate

readingAt?|

Ablesezeitpunkt; muss zum Ablesedatum passen und darf nicht in der Zukunft liegen

Formatdate-time

Response Body

Kilometerstand gespeichert

application/json

response

id?string

Formatuuid

vehicleId?string

Formatuuid

month?string

readingDate?string

Formatdate

odometerKm?number

source?string

recordedAt?string

Formatdate-time

Example Request

curl -X PUT 'https://example.com/api/v1/odometer/497f6eca-6276-4993-bfeb-53cbbbba6f08/string' \
  -H 'Content-Type: application/json' \
  -d '{
  "odometerKm": 0
}'

Example Request

curl -X PUT 'https://example.com/api/v1/odometer/497f6eca-6276-4993-bfeb-53cbbbba6f08/string' \  -H 'Content-Type: application/json' \  -d '{  "odometerKm": 0}'

Example ResponseSchema

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",
  "month": "string",
  "readingDate": "2019-08-24",
  "odometerKm": 0,
  "source": "string",
  "recordedAt": "2019-08-24T14:15:22Z"
}

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "vehicleId": "c406adf4-e700-4483-ad7a-e7447a2941cb",  "month": "string",  "readingDate": "2019-08-24",  "odometerKm": 0,  "source": "string",  "recordedAt": "2019-08-24T14:15:22Z"}

Vehicles

List vehiclesCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Create vehicleCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Get vehicleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Delete vehicleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Update vehicleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Set default vehicleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Update Bluetooth assignmentCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Get shared-user trip activity for an owned vehicleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

List confirmed vehicle sharesCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Invite vehicle share by emailCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Revoke vehicle shareCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Create one-time vehicle sharing linkCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Check vehicle sharing invitationCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Get pending email sharing invitationsCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Accept or reject vehicle shareCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Deregister owned vehicleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Get archived owned vehiclesCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Restore archived vehicleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Re-register deregistered vehicleCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Transfer vehicle ownershipCopy Anchor Link

AuthorizationCopy Anchor Link

List vehicles

Authorization

Response Body

Create vehicle

Authorization

Request Body

Response Body

Get vehicle

Authorization

Path Parameters

Response Body

Delete vehicle

Authorization

Path Parameters

Response Body

Update vehicle

Authorization

Path Parameters

Request Body

Response Body

Set default vehicle

Authorization

Path Parameters

Response Body

Update Bluetooth assignment

Authorization

Path Parameters

Request Body

Response Body

Get shared-user trip activity for an owned vehicle

Authorization

Path Parameters

Response Body

List confirmed vehicle shares

Authorization

Path Parameters

Response Body

Invite vehicle share by email

Authorization

Path Parameters

Request Body

Response Body

Revoke vehicle share

Authorization

Path Parameters

Response Body

Create one-time vehicle sharing link

Authorization

Path Parameters

Response Body

Check vehicle sharing invitation

Authorization

Query Parameters

Response Body

Get pending email sharing invitations

Authorization

Response Body

Accept or reject vehicle share

Authorization

Request Body

Response Body

Deregister owned vehicle

Authorization

Path Parameters

Response Body

Get archived owned vehicles

Authorization

Response Body

Restore archived vehicle

Authorization

Path Parameters

Response Body

Re-register deregistered vehicle

Authorization

Path Parameters

Request Body

Response Body

Transfer vehicle ownership

Authorization

Path Parameters