Fleet Documentation

Postman collection → OpenAPI spec →

Introduction

Base URL: http://fleet.test

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Fleet Mobile

1- Authentification

POST

http://fleet.test

/api/v1/mobile-app/auth/login

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Le champ value doit être une adresse e-mail valide.

Example:

ortiz.cathryn@example.com

password

string

required

Example:

laborum

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"ortiz.cathryn@example.com\",
    \"password\": \"laborum\"
}"

Store temp email

POST

http://fleet.test

/api/v1/mobile-app/auth/temp-email/store

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Le champ value doit être une adresse e-mail valide. Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

davion.halvorson@example.org

Headers

Body

{ "email": "davion.halvorson@example.org" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/auth/temp-email/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"davion.halvorson@example.org\"
}"

Verify temp email

POST

http://fleet.test

/api/v1/mobile-app/auth/temp-email/verify

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Le champ value doit être une adresse e-mail valide.

Example:

judd40@example.org

uuid

string

required

Must be a valid UUID.

Example:

cd8e1278-b81e-33bd-9e20-e56bfc096dd9

otp

string

required

Le champ value doit contenir 6 chiffres.

Example:

023832

Headers

Body

{ "email": "judd40@example.org", "uuid": "cd8e1278-b81e-33bd-9e20-e56bfc096dd9", "otp": "023832" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/auth/temp-email/verify" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"judd40@example.org\",
    \"uuid\": \"cd8e1278-b81e-33bd-9e20-e56bfc096dd9\",
    \"otp\": \"023832\"
}"

Update password

POST

http://fleet.test

/api/v1/mobile-app/auth/password/update

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Le champ value doit être une adresse e-mail valide. Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

clare91@example.net

uuid

string

required

Must be a valid UUID.

Example:

deb3951f-cbdb-36e0-8357-f476790e7ef7

password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

g9qh6mUigN5U

Headers

Body

{ "email": "clare91@example.net", "uuid": "deb3951f-cbdb-36e0-8357-f476790e7ef7", "password": "g9qh6mUigN5U" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/auth/password/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"clare91@example.net\",
    \"uuid\": \"deb3951f-cbdb-36e0-8357-f476790e7ef7\",
    \"password\": \"g9qh6mUigN5U\"
}"

Logout user

POST

http://fleet.test

/api/v1/mobile-app/auth/logout

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/auth/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

2- User Profile management

Update user profile

POST

http://fleet.test

/api/v1/mobile-app/profile/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

first_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

trjrb

last_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

phone

string

required

Le texte value doit contenir au moins 10 caractères. Le texte de value ne peut contenir plus de 20 caractères.

Example:

Auth

Bearer

Headers

Body

{ "first_name": "trjrb", "last_name": "gj", "phone": "ix" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/profile/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"trjrb\",
    \"last_name\": \"gj\",
    \"phone\": \"ix\"
}"

Update user profile picture

POST

http://fleet.test

/api/v1/mobile-app/profile/picture/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

profile_picture

file

required

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpE512.tmp

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/profile/picture/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "profile_picture=@C:\Users\21355\AppData\Local\Temp\phpE512.tmp"

Update user password

POST

http://fleet.test

/api/v1/mobile-app/profile/password/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

old_password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

iwsftgjsvlicz

password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

g5FDTZLAKBm

Auth

Bearer

Headers

Body

{ "old_password": "iwsftgjsvlicz", "password": "g5FDTZLAKBm" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/profile/password/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"old_password\": \"iwsftgjsvlicz\",
    \"password\": \"g5FDTZLAKBm\"
}"

Update user signature

POST

http://fleet.test

/api/v1/mobile-app/profile/signature/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

signature

file

required

Le champ value doit être une image. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpE524.tmp

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/profile/signature/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "signature=@C:\Users\21355\AppData\Local\Temp\phpE524.tmp"

Update user preferences

POST

http://fleet.test

/api/v1/mobile-app/profile/preferences/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

preferred_language

string

Must be one of:

FR
EN

Example:

Auth

Bearer

Headers

Body

{ "preferred_language": "FR" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/profile/preferences/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"preferred_language\": \"FR\"
}"

3- Vehicle management

Get assigned vehicles

GET

http://fleet.test

/api/v1/mobile-app/vehicle/list/assigned

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vehicle/list/assigned" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get vehicle details

GET

http://fleet.test

/api/v1/mobile-app/vehicle/show/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vehicle/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get vehicle home data

GET

http://fleet.test

/api/v1/mobile-app/vehicle/home-data/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vehicle/home-data/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get vehicle details

GET

http://fleet.test

/api/v1/mobile-app/vehicle/details/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vehicle/details/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get vehicle device data

GET

http://fleet.test

/api/v1/mobile-app/vehicle/pr-2/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vehicle/pr-2/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update private mode

POST

http://fleet.test

/api/v1/mobile-app/vehicle/private-mode/update/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/vehicle/private-mode/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

4- Issue management

Get issues list

GET

http://fleet.test

/api/v1/mobile-app/issue/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/issue/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get issue details

GET

http://fleet.test

/api/v1/mobile-app/issue/show/{issue_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

issue_id

integer

required

The ID of the issue.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/issue/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an issue

POST

http://fleet.test

/api/v1/mobile-app/issue/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

axxyerazfcw

description

string

Example:

Animi quos aliquid sequi et.

priority

string

required

Must be one of:

No Priority
Low
Medium
High
Critical

Example:

Medium

vehicle_id

string

required

Example:

quia

label_id

string

reported_at

string

required

Le champ value n'est pas une date valide. Le champ value doit être une date antérieure ou égale au now.

Example:

2025-03-04

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/issue/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=axxyerazfcw"\
    --form "description=Animi quos aliquid sequi et."\
    --form "priority=Medium"\
    --form "vehicle_id=quia"\
    --form "reported_at=2025-03-04"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE583.tmp"

Update an issue

POST

http://fleet.test

/api/v1/mobile-app/issue/update/{issue_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

issue_id

integer

required

The ID of the issue.

Example:

Body Parameters

name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

ckw

description

string

Example:

Quidem sequi eveniet iure rerum.

priority

string

required

Must be one of:

No Priority
Low
Medium
High
Critical

Example:

Critical

vehicle_id

string

required

Example:

possimus

label_id

string

reported_at

string

required

Le champ value n'est pas une date valide. Le champ value doit être une date antérieure ou égale au now.

Example:

2019-09-16

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/issue/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=ckw"\
    --form "description=Quidem sequi eveniet iure rerum."\
    --form "priority=Critical"\
    --form "vehicle_id=possimus"\
    --form "reported_at=2019-09-16"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE584.tmp"

Delete an issue

DELETE

http://fleet.test

/api/v1/mobile-app/issue/delete/{issue_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

issue_id

integer

required

The ID of the issue.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/issue/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

5- Label management

Get all user labels without pagination

GET

http://fleet.test

/api/v1/mobile-app/label/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/label/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

6- Meter History management

Get meter histories list

GET

http://fleet.test

/api/v1/mobile-app/meter-history/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/meter-history/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get meter history details

GET

http://fleet.test

/api/v1/mobile-app/meter-history/show/{meterHistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

meterHistory_id

integer

required

The ID of the meterHistory.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/meter-history/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a meter history

POST

http://fleet.test

/api/v1/mobile-app/meter-history/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

voluptates

meter

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

meter_date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:35

Auth

Bearer

Headers

Body

{ "vehicle_id": "voluptates", "meter": 53, "meter_date": "2025-03-14T08:17:35" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/meter-history/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"voluptates\",
    \"meter\": 53,
    \"meter_date\": \"2025-03-14T08:17:35\"
}"

Update a meter history

POST

http://fleet.test

/api/v1/mobile-app/meter-history/update/{meterHistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

meterHistory_id

integer

required

The ID of the meterHistory.

Example:

Body Parameters

meter

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "meter": 26 }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/meter-history/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"meter\": 26
}"

Delete a meter history

DELETE

http://fleet.test

/api/v1/mobile-app/meter-history/delete/{meterHistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

meterHistory_id

integer

required

The ID of the meterHistory.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/meter-history/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

7- Expense management

Get expense types list

GET

http://fleet.test

/api/v1/mobile-app/expense/types

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/expense/types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get expenses list

GET

http://fleet.test

/api/v1/mobile-app/expense/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/expense/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get expense details

GET

http://fleet.test

/api/v1/mobile-app/expense/show/{expense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

expense_id

integer

required

The ID of the expense.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/expense/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an expense

POST

http://fleet.test

/api/v1/mobile-app/expense/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

iure

expense_type_id

string

required

Example:

vendor_id

string

required

Example:

date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:35

amount

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

notes

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

ufxbnydobzl

Auth

Bearer

Headers

Body

{ "vehicle_id": "iure", "expense_type_id": "et", "vendor_id": "ut", "date": "2025-03-14T08:17:35", "amount": 68, "notes": "ufxbnydobzl" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/expense/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"iure\",
    \"expense_type_id\": \"et\",
    \"vendor_id\": \"ut\",
    \"date\": \"2025-03-14T08:17:35\",
    \"amount\": 68,
    \"notes\": \"ufxbnydobzl\"
}"

Update an expense

POST

http://fleet.test

/api/v1/mobile-app/expense/update/{expense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

expense_id

integer

required

The ID of the expense.

Example:

Body Parameters

vehicle_id

string

required

Example:

dolore

expense_type_id

string

required

Example:

dolorem

vendor_id

string

required

Example:

date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:35

amount

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

notes

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

fyouirneddg

Auth

Bearer

Headers

URL Parameters

Body

{ "vehicle_id": "dolore", "expense_type_id": "dolorem", "vendor_id": "id", "date": "2025-03-14T08:17:35", "amount": 81, "notes": "fyouirneddg" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/expense/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"dolore\",
    \"expense_type_id\": \"dolorem\",
    \"vendor_id\": \"id\",
    \"date\": \"2025-03-14T08:17:35\",
    \"amount\": 81,
    \"notes\": \"fyouirneddg\"
}"

Delete an expense

DELETE

http://fleet.test

/api/v1/mobile-app/expense/delete/{expense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

expense_id

integer

required

The ID of the expense.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/expense/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

8- Mobility Expense management

Get mobility expense types list

GET

http://fleet.test

/api/v1/mobile-app/mobility-expense/types

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/mobility-expense/types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get mobility expenses list

GET

http://fleet.test

/api/v1/mobile-app/mobility-expense/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/mobility-expense/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get mobility expense details

GET

http://fleet.test

/api/v1/mobile-app/mobility-expense/show/{mobilityExpense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mobilityExpense_id

integer

required

The ID of the mobilityExpense.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/mobility-expense/show/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a mobility expense

POST

http://fleet.test

/api/v1/mobile-app/mobility-expense/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

mobility_expense_type_id

string

required

Example:

neque

date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:35

amount

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

notes

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

fgi

Auth

Bearer

Headers

Body

{ "mobility_expense_type_id": "neque", "date": "2025-03-14T08:17:35", "amount": 17, "notes": "fgi" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/mobility-expense/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mobility_expense_type_id\": \"neque\",
    \"date\": \"2025-03-14T08:17:35\",
    \"amount\": 17,
    \"notes\": \"fgi\"
}"

Update a mobility expense

POST

http://fleet.test

/api/v1/mobile-app/mobility-expense/update/{mobilityExpense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mobilityExpense_id

integer

required

The ID of the mobilityExpense.

Example:

Body Parameters

mobility_expense_type_id

string

required

Example:

minus

date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:35

amount

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

notes

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

xcisunhsm

Auth

Bearer

Headers

URL Parameters

Body

{ "mobility_expense_type_id": "minus", "date": "2025-03-14T08:17:35", "amount": 34, "notes": "xcisunhsm" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/mobility-expense/update/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mobility_expense_type_id\": \"minus\",
    \"date\": \"2025-03-14T08:17:35\",
    \"amount\": 34,
    \"notes\": \"xcisunhsm\"
}"

Delete a mobility expense

DELETE

http://fleet.test

/api/v1/mobile-app/mobility-expense/delete/{mobilityExpense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mobilityExpense_id

integer

required

The ID of the mobilityExpense.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/mobility-expense/delete/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

9- Sinistre management

Get sinistres list

GET

http://fleet.test

/api/v1/mobile-app/sinistre/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/sinistre/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get sinistre details

GET

http://fleet.test

/api/v1/mobile-app/sinistre/show/{sinistre_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

sinistre_id

integer

required

The ID of the sinistre.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/sinistre/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a sinistre

POST

http://fleet.test

/api/v1/mobile-app/sinistre/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

eos

date_of_accident

string

required

Le champ value n'est pas une date valide. Le champ value doit être une date antérieure ou égale au today.

Example:

2001-08-05

responsability

string

required

Must be one of:

Example:

address

string

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

pscinelumnhxfysckacpw

commentaire

string

Le texte de value ne peut contenir plus de 1000 caractères.

Example:

zdwrcqwske

document

file

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpE641.tmp

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/sinistre/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=eos"\
    --form "date_of_accident=2001-08-05"\
    --form "responsability=S"\
    --form "address=pscinelumnhxfysckacpw"\
    --form "commentaire=zdwrcqwske"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpE641.tmp"

Update a sinistre

POST

http://fleet.test

/api/v1/mobile-app/sinistre/update/{sinistre_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

sinistre_id

integer

required

The ID of the sinistre.

Example:

Body Parameters

vehicle_id

string

required

Example:

pariatur

date_of_accident

string

required

Le champ value n'est pas une date valide. Le champ value doit être une date antérieure ou égale au today.

Example:

2006-03-09

responsability

string

required

Must be one of:

Example:

address

string

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

wkvldwndgkne

commentaire

string

Le texte de value ne peut contenir plus de 1000 caractères.

Example:

kbiksuvhliwtuzylilo

document

file

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpE652.tmp

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/sinistre/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=pariatur"\
    --form "date_of_accident=2006-03-09"\
    --form "responsability=F"\
    --form "address=wkvldwndgkne"\
    --form "commentaire=kbiksuvhliwtuzylilo"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpE652.tmp"

Delete a sinistre

DELETE

http://fleet.test

/api/v1/mobile-app/sinistre/delete/{sinistre_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

sinistre_id

integer

required

The ID of the sinistre.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/sinistre/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

10- Dadycar garages management

Get all Dadycar garages list

GET

http://fleet.test

/api/v1/mobile-app/dadycar-garage/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/dadycar-garage/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get garage calendar

GET

http://fleet.test

/api/v1/mobile-app/dadycar-garage/calendar/{garage}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

garage

string

required

Example:

quaerat

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/dadycar-garage/calendar/quaerat" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

11- User garage management

Get user garages list

GET

http://fleet.test

/api/v1/mobile-app/user-garage/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/user-garage/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all user garages list

GET

http://fleet.test

/api/v1/mobile-app/user-garage/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/user-garage/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get user garage details

GET

http://fleet.test

/api/v1/mobile-app/user-garage/show/{userGarage_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

userGarage_id

integer

required

The ID of the userGarage.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/user-garage/show/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

12- User Vendor management

Get all user vendors list

GET

http://fleet.test

/api/v1/mobile-app/user-vendor/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/user-vendor/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

13- Vendor management

Get all linked vendors

GET

http://fleet.test

/api/v1/mobile-app/vendor/linked/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vendor/linked/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all vendors classifications

GET

http://fleet.test

/api/v1/mobile-app/vendor/classifications

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vendor/classifications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

14- Partner Service management

Get partner services list

GET

http://fleet.test

/api/v1/mobile-app/partner-service/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/partner-service/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get partner service details

GET

http://fleet.test

/api/v1/mobile-app/partner-service/show/{partnerService_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

partnerService_id

integer

required

The ID of the partnerService.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/partner-service/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an partner service

POST

http://fleet.test

/api/v1/mobile-app/partner-service/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

provider_id

integer

required

Example:

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

schedule_date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:35

odometer

integer

Example:

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/partner-service/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=et"\
    --form "provider_id=7"\
    --form "service_id=5"\
    --form "priority=N"\
    --form "schedule_date=2025-03-14T08:17:35"\
    --form "odometer=4"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE6D0.tmp"

Update an partner service

POST

http://fleet.test

/api/v1/mobile-app/partner-service/update/{partnerService_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

partnerService_id

integer

required

The ID of the partnerService.

Example:

Body Parameters

vehicle_id

string

required

Example:

quasi

provider_id

integer

required

Example:

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

schedule_date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:35

odometer

integer

Example:

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/partner-service/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=quasi"\
    --form "provider_id=7"\
    --form "service_id=2"\
    --form "priority=S"\
    --form "schedule_date=2025-03-14T08:17:35"\
    --form "odometer=20"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE6E0.tmp"

Delete an partner service

DELETE

http://fleet.test

/api/v1/mobile-app/partner-service/delete/{partnerService_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

partnerService_id

integer

required

The ID of the partnerService.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/partner-service/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

15- Inhouse Service management

Get inhouse services list

GET

http://fleet.test

/api/v1/mobile-app/inhouse-service/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/inhouse-service/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get inhouse service details

GET

http://fleet.test

/api/v1/mobile-app/inhouse-service/show/{inhouseService_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inhouseService_id

integer

required

The ID of the inhouseService.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/inhouse-service/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an inhouse service

POST

http://fleet.test

/api/v1/mobile-app/inhouse-service/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

corporis

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

schedule_date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:35

odometer

integer

Example:

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/inhouse-service/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=corporis"\
    --form "service_id=16"\
    --form "priority=U"\
    --form "schedule_date=2025-03-14T08:17:35"\
    --form "odometer=2"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE710.tmp"

Update an inhouse service

POST

http://fleet.test

/api/v1/mobile-app/inhouse-service/update/{inhouseService_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

inhouseService_id

integer

required

The ID of the inhouseService.

Example:

Body Parameters

vehicle_id

string

required

Example:

velit

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

schedule_date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:35

odometer

integer

Example:

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/inhouse-service/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=velit"\
    --form "service_id=3"\
    --form "priority=S"\
    --form "schedule_date=2025-03-14T08:17:35"\
    --form "odometer=4"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE721.tmp"

Delete an inhouse service

DELETE

http://fleet.test

/api/v1/mobile-app/inhouse-service/delete/{inhouseService_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inhouseService_id

integer

required

The ID of the inhouseService.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/inhouse-service/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

16- Appointment management

Get appointments list

GET

http://fleet.test

/api/v1/mobile-app/appointment/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/appointment/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Show an appointment/estimation

GET

http://fleet.test

/api/v1/mobile-app/appointment/show/{appointment_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment_id

string

required

The ID of the appointment.

Example:

maiores

Query Parameters

appointment_id

integer

required

The ID of the appointment.

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/appointment/show/maiores?appointment_id=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an appointment

POST

http://fleet.test

/api/v1/mobile-app/appointment/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

service_id

integer

required

The ID of the service.

Example:

provider_id

integer

required

The ID of the provider.

Example:

note

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

appointment_date

date

The appointment date.

Example:

2024-12-31

appointment_time

date

The appointment time.

Example:

12:00

Auth

Bearer

Headers

Body

{ "vehicle_id": 15, "service_id": 2, "provider_id": 3, "note": "d", "appointment_date": "2024-12-31", "appointment_time": "12:00" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/appointment/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": 15,
    \"service_id\": 2,
    \"provider_id\": 3,
    \"note\": \"d\",
    \"appointment_date\": \"2024-12-31\",
    \"appointment_time\": \"12:00\"
}"

Get estimations list

GET

http://fleet.test

/api/v1/mobile-app/appointment/estimation/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/appointment/estimation/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an estimation

POST

http://fleet.test

/api/v1/mobile-app/appointment/estimation/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

service_id

integer

required

The ID of the service.

Example:

provider_id

integer

required

The ID of the provider.

Example:

note

string

nullable The note.

Example:

"Please take care of the car"

Auth

Bearer

Headers

Body

{ "vehicle_id": 15, "service_id": 2, "provider_id": 3, "note": "\"Please take care of the car\"" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/appointment/estimation/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": 15,
    \"service_id\": 2,
    \"provider_id\": 3,
    \"note\": \"\\\"Please take care of the car\\\"\"
}"

17- Fuel History management

Get fuel histories list

GET

http://fleet.test

/api/v1/mobile-app/fuel-history/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/fuel-history/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get fuel history details

GET

http://fleet.test

/api/v1/mobile-app/fuel-history/show/{fuelHistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

fuelHistory_id

integer

required

The ID of the fuelHistory.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/fuel-history/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a fuel history

POST

http://fleet.test

/api/v1/mobile-app/fuel-history/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

esse

vendor_id

string

entry_date

string

required

Must be a valid date in the format Y-m-d. Le champ value doit être une date antérieure ou égale au now.

Example:

2011-05-16

entry_hour

string

required

Must be a valid date in the format H:i.

Example:

08:17

odometer

number

La valeur de value doit être supérieure ou égale à 0.

Example:

liters

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

total_price

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

fuel_cost

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

fuel_type_grade

string

required

Example:

is_partial_fuel_up

boolean

required

Example:

reset_usage

boolean

required

Example:

personal

boolean

required

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/fuel-history/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=esse"\
    --form "entry_date=2011-05-16"\
    --form "entry_hour=08:17"\
    --form "odometer=9"\
    --form "liters=50"\
    --form "total_price=55"\
    --form "fuel_cost=9"\
    --form "fuel_type_grade=et"\
    --form "is_partial_fuel_up=1"\
    --form "reset_usage=1"\
    --form "personal="\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE77F.tmp"

Update a fuel history

POST

http://fleet.test

/api/v1/mobile-app/fuel-history/update/{fuelHistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

fuelHistory_id

integer

required

The ID of the fuelHistory.

Example:

Body Parameters

vehicle_id

string

required

Example:

cupiditate

vendor_id

string

entry_date

string

required

Must be a valid date in the format Y-m-d. Le champ value doit être une date antérieure ou égale au now.

Example:

2016-04-05

entry_hour

string

required

Must be a valid date in the format H:i.

Example:

08:17

odometer

number

La valeur de value doit être supérieure ou égale à 0.

Example:

liters

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

total_price

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

fuel_cost

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

fuel_type_grade

string

required

Example:

cum

is_partial_fuel_up

boolean

required

Example:

reset_usage

boolean

required

Example:

personal

boolean

required

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/fuel-history/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=cupiditate"\
    --form "entry_date=2016-04-05"\
    --form "entry_hour=08:17"\
    --form "odometer=77"\
    --form "liters=12"\
    --form "total_price=36"\
    --form "fuel_cost=71"\
    --form "fuel_type_grade=cum"\
    --form "is_partial_fuel_up=1"\
    --form "reset_usage=1"\
    --form "personal="\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE790.tmp"

Delete a fuel history

DELETE

http://fleet.test

/api/v1/mobile-app/fuel-history/delete/{fuelHistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

fuelHistory_id

integer

required

The ID of the fuelHistory.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/fuel-history/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

18- Charging History management

Get charging histories list

GET

http://fleet.test

/api/v1/mobile-app/charging-history/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/charging-history/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get charging history details

GET

http://fleet.test

/api/v1/mobile-app/charging-history/show/{chargingHistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

chargingHistory_id

integer

required

The ID of the chargingHistory.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/charging-history/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a charging history

POST

http://fleet.test

/api/v1/mobile-app/charging-history/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

suscipit

vendor_id

string

chargin_started

string

required

Le champ value n'est pas une date valide. Must be a valid date in the format Y-m-d H:i.

Example:

2025-03-14 08:17

chargin_ended

string

Le champ value n'est pas une date valide. Must be a valid date in the format Y-m-d H:i. Le champ value doit être une date postérieure au chargin_started.

Example:

2116-05-04

total_energy

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

energy_cost

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

personal

boolean

required

Example:

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/charging-history/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=suscipit"\
    --form "chargin_started=2025-03-14 08:17"\
    --form "chargin_ended=2116-05-04"\
    --form "total_energy=67"\
    --form "energy_cost=31"\
    --form "personal=1"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE7C0.tmp"

Update a charging history

POST

http://fleet.test

/api/v1/mobile-app/charging-history/update/{chargingHistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

chargingHistory_id

integer

required

The ID of the chargingHistory.

Example:

Body Parameters

vehicle_id

string

required

Example:

vendor_id

string

chargin_started

string

required

Le champ value n'est pas une date valide. Must be a valid date in the format Y-m-d H:i.

Example:

2025-03-14 08:17

chargin_ended

string

Le champ value n'est pas une date valide. Must be a valid date in the format Y-m-d H:i. Le champ value doit être une date postérieure au chargin_started.

Example:

2115-12-20

total_energy

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

energy_cost

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

personal

boolean

required

Example:

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/charging-history/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=ea"\
    --form "chargin_started=2025-03-14 08:17"\
    --form "chargin_ended=2115-12-20"\
    --form "total_energy=31"\
    --form "energy_cost=79"\
    --form "personal=1"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpE7D1.tmp"

Delete a charging history

DELETE

http://fleet.test

/api/v1/mobile-app/charging-history/delete/{chargingHistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

chargingHistory_id

integer

required

The ID of the chargingHistory.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/charging-history/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

19- Inspections forms management

Get inspection forms list

GET

http://fleet.test

/api/v1/mobile-app/inspection-form/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/inspection-form/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get inspection forms list by vehicle

GET

http://fleet.test

/api/v1/mobile-app/inspection-form/list/vehicle/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/inspection-form/list/vehicle/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

20- Inspections management

Get submitted inspections list.

GET

http://fleet.test

/api/v1/mobile-app/inspection/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/inspection/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get inspection details.

GET

http://fleet.test

/api/v1/mobile-app/inspection/show/{inspection_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_id

integer

required

The ID of the inspection.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/inspection/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Delete inspection.

DELETE

http://fleet.test

/api/v1/mobile-app/inspection/delete/{inspection_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_id

integer

required

The ID of the inspection.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/inspection/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

21- Infractions management

Get infractions list

GET

http://fleet.test

/api/v1/mobile-app/infraction/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/infraction/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get infraction details

GET

http://fleet.test

/api/v1/mobile-app/infraction/show/{infraction_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

infraction_id

integer

required

The ID of the infraction.

Example:

158

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/infraction/show/158" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

22- Service management

Get services list

GET

http://fleet.test

/api/v1/mobile-app/service/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/service/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get sub services list

GET

http://fleet.test

/api/v1/mobile-app/service/sub-service/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/service/sub-service/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET

http://fleet.test

/api/v1/mobile-app/vehicle-sharing/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vehicle-sharing/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET

http://fleet.test

/api/v1/mobile-app/vehicle-sharing/available-vehicles/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vehicle-sharing/available-vehicles/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

POST

http://fleet.test

/api/v1/mobile-app/vehicle-sharing/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

aliquam

start_date_time

string

required

Must be a valid date in the format Y-m-d H:i. Le champ value doit être une date postérieure ou égale au now.

Example:

2111-12-05

end_date_time

string

required

Must be a valid date in the format Y-m-d H:i. Le champ value doit être une date postérieure au start_date_time.

Example:

2087-08-21

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/mobile-app/vehicle-sharing/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"aliquam\",
    \"start_date_time\": \"2111-12-05\",
    \"end_date_time\": \"2087-08-21\"
}"

24- Site management

Get all sites list

GET

http://fleet.test

/api/v1/mobile-app/site/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/site/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

25- Document management

Delete a document

DELETE

http://fleet.test

/api/v1/mobile-app/document/delete/{document_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

document_id

integer

required

The ID of the document.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/mobile-app/document/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

26- Notifications management

Get user notifications list.

GET

http://fleet.test

/api/v1/mobile-app/notification/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/notification/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

27- Service Reminder management

Get client service reminders list

GET

http://fleet.test

/api/v1/mobile-app/service-reminder/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/service-reminder/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

28- Vehicle Reminder management

Get client vehicle reminders list

GET

http://fleet.test

/api/v1/mobile-app/vehicle-reminder/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/mobile-app/vehicle-reminder/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Fleet Web

0- Stripe Webhook

Handle stripe Webhook

POST

http://fleet.test

/api/v1/fleet/stripe/webhook

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/stripe/webhook" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

0- Pricing page management

Get all pricing cards

GET

http://fleet.test

/api/v1/fleet/landingpage/pricingpage

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/landingpage/pricingpage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 59
                                                                                                                    vary
                                                            : Origin

{
    "status": true,
    "message": "Pricing card list",
    "data": {
        "plans": [
            {
                "id": 11,
                "original_price": "6.99",
                "discounted_price": "4.99",
                "discount_percentage": 40,
                "connected_vehicles": false,
                "name": "starter",
                "popular": false,
                "display_name": "Starter",
                "display_nameFr": "Starter",
                "description": "Basic plan, ideal for small fleets",
                "descriptionFr": "Plan basique, idéal pour les petites flottes",
                "display_order": 1,
                "billing_frequency": "monthly",
                "features": {
                    "included": [
                        {
                            "display_name": "Vehicle Management",
                            "display_nameFr": "Gestion des véhicules"
                        },
                        {
                            "display_name": "Deadline Reminders (technical control, insurance, etc.)",
                            "display_nameFr": "Rappel des échéances (contrôle technique, assurance, etc.)"
                        },
                        {
                            "display_name": "Employee & Site Management",
                            "display_nameFr": "Gestion des employés & Sites"
                        },
                        {
                            "display_name": "Dashboard",
                            "display_nameFr": "Tableau de bord"
                        }
                    ],
                    "excluded": [
                        {
                            "display_name": "Vehicle Assignment Planning (calendar)",
                            "display_nameFr": "Planification des affectations de véhicules (calendrier)"
                        },
                        {
                            "display_name": "Mobile App Access",
                            "display_nameFr": "Accès à l'application mobile"
                        }
                    ]
                }
            },
            {
                "id": 12,
                "original_price": "18.33",
                "discounted_price": "10.99",
                "discount_percentage": 40,
                "connected_vehicles": true,
                "name": "pro",
                "popular": true,
                "display_name": "Pro",
                "display_nameFr": "Pro",
                "description": "Provides telemetry options and advanced fleet management features",
                "descriptionFr": "Offre des options de télématique et des fonctionnalités avancées pour la gestion de flotte",
                "display_order": 2,
                "billing_frequency": "monthly",
                "features": {
                    "included": [
                        {
                            "display_name": "Everything in Starter",
                            "display_nameFr": "Tout dans Starter"
                        },
                        {
                            "display_name": "Vehicle Assignment Planning (calendar)",
                            "display_nameFr": "Planification des affectations de véhicules (calendrier)"
                        },
                        {
                            "display_name": "Reports and Analysis",
                            "display_nameFr": "Rapports et analyses"
                        },
                        {
                            "display_name": "Mobile App Access",
                            "display_nameFr": "Accès à l'application mobile"
                        }
                    ],
                    "excluded": [
                        {
                            "display_name": "Odometer Management (Automatic + real-time)",
                            "display_nameFr": "Gestion des odomètres (Automatique + temps réel)"
                        },
                        {
                            "display_name": "Vehicle Sharing (Car-sharing) lock/unlock",
                            "display_nameFr": "Partage de véhicules (Car-sharing) lock/unlock"
                        }
                    ]
                }
            },
            {
                "id": 13,
                "original_price": "24.99",
                "discounted_price": "14.99",
                "discount_percentage": 40,
                "connected_vehicles": true,
                "name": "advanced",
                "popular": false,
                "display_name": "Advanced",
                "display_nameFr": "Avancé",
                "description": "The complete solution for large enterprises with complex needs including telemetry, Car-sharing, and API integration",
                "descriptionFr": "La solution complète pour les grandes entreprises avec des besoins complexes incluant la télématique, le Car-sharing et l'intégration API",
                "display_order": 3,
                "billing_frequency": "monthly",
                "features": {
                    "included": [
                        {
                            "display_name": "Everything in Pro",
                            "display_nameFr": "Tout dans Pro"
                        },
                        {
                            "display_name": "Odometer Management (Automatic + real-time)",
                            "display_nameFr": "Gestion des odomètres (Automatique + temps réel)"
                        },
                        {
                            "display_name": "Vehicle Sharing (Car-sharing) lock/unlock",
                            "display_nameFr": "Partage de véhicules (Car-sharing) lock/unlock"
                        },
                        {
                            "display_name": "API Integration",
                            "display_nameFr": "Integration API"
                        },
                        {
                            "display_name": "Advanced Role Management",
                            "display_nameFr": "Gestion des rôles Avancé"
                        },
                        {
                            "display_name": "Unlimited access on web-app & Mobile app",
                            "display_nameFr": "Nombre d'accès sur web-app & Mobile app illimité"
                        },
                        {
                            "display_name": "Up to 1Gb Document Storage per vehicle",
                            "display_nameFr": "Jusqu'à 1Gb de Stockage Documents par véhicle"
                        }
                    ],
                    "excluded": []
                }
            }
        ],
        "comparisons": [
            {
                "id": 5,
                "category": "Vehicle Management",
                "categoryFr": "Gestion des véhicules",
                "features": [
                    {
                        "featureName": "Gestion des véhicules",
                        "featureNameFr": "Gestion des véhicules",
                        "included": {
                            "starter": {
                                "included": true,
                                "access": null,
                                "accessFR": null
                            },
                            "pro": {
                                "included": true,
                                "access": null,
                                "accessFR": null
                            },
                            "advanced": {
                                "included": true,
                                "access": null,
                                "accessFR": null
                            }
                        }
                    },
                    {
                        "featureName": "Planification des affectations de véhicules",
                        "featureNameFr": "Planification des affectations de véhicules",
                        "included": {
                            "starter": {
                                "included": true,
                                "access": null,
                                "accessFR": null
                            },
                            "pro": {
                                "included": true,
                                "access": null,
                                "accessFR": null
                            },
                            "advanced": {
                                "included": true,
                                "access": null,
                                "accessFR": null
                            }
                        }
                    },
                    {
                        "featureName": "Gestion des odomètres",
                        "featureNameFr": "Gestion des odomètres",
                        "included": {
                            "starter": {
                                "included": true,
                                "access": "Basique",
                                "accessFR": "Basique"
                            },
                            "pro": {
                                "included": true,
                                "access": "Automatique (Chaque 24h)",
                                "accessFR": "Automatique (Chaque 24h)"
                            },
                            "advanced": {
                                "included": true,
                                "access": "Automatique + temps réel",
                                "accessFR": "Automatique + temps réel"
                            }
                        }
                    },
                    {
                        "featureName": "Gestion des sites",
                        "featureNameFr": "Gestion des sites",
                        "included": {
                            "starter": {
                                "included": true,
                                "access": "Jusqu'à 10",
                                "accessFR": "Jusqu'à 10"
                            },
                            "pro": {
                                "included": true,
                                "access": "Jusqu'à 50",
                                "accessFR": "Jusqu'à 50"
                            },
                            "advanced": {
                                "included": true,
                                "access": "Illimité",
                                "accessFR": "Illimité"
                            }
                        }
                    },
                    {
                        "featureName": "Documents par vehicle",
                        "featureNameFr": "Documents par vehicle",
                        "included": {
                            "starter": {
                                "included": true,
                                "access": "Jusqu'à 50 MB",
                                "accessFR": "Jusqu'à 50 MB"
                            },
                            "pro": {
                                "included": true,
                                "access": "Jusqu'à 500 MB",
                                "accessFR": "Jusqu'à 500 MB"
                            },
                            "advanced": {
                                "included": true,
                                "access": "Jusqu'à 1gb",
                                "accessFR": "Jusqu'à 1gb"
                            }
                        }
                    }
                ]
            },
            {
                "id": 6,
                "category": "Tracking and Geolocation",
                "categoryFr": "Suivi et Géolocalisation",
                "features": [
                    {
                        "featureName": "Géolocalisation (Temps réel)",
                        "featureNameFr": "Géolocalisation (Temps réel)",
                        "included": {
                            "starter": {
                                "included": false,
                                "access": null,
                                "accessFR": null
                            },
                            "pro": {
                                "included": true,
                                "access": "Jusqu'à 100 véhicules",
                                "accessFR": "Jusqu'à 100 véhicules"
                            },
                            "advanced": {
                                "included": true,
                                "access": "Illimité",
                                "accessFR": "Illimité"
                            }
                        }
                    }
                ]
            },
            {
                "id": 7,
                "category": "Reports and Analysis",
                "categoryFr": "Rapports et Analyses",
                "features": [
                    {
                        "featureName": "Tableau de bord",
                        "featureNameFr": "Tableau de bord",
                        "included": {
                            "starter": {
                                "included": true,
                                "access": "Basique",
                                "accessFR": "Basique"
                            },
                            "pro": {
                                "included": true,
                                "access": "Avancés",
                                "accessFR": "Avancés"
                            },
                            "advanced": {
                                "included": true,
                                "access": "Avancés et Personnalisés",
                                "accessFR": "Avancés et Personnalisés"
                            }
                        }
                    }
                ]
            },
            {
                "id": 8,
                "category": "Access and Users",
                "categoryFr": "Accès et Utilisateurs",
                "features": [
                    {
                        "featureName": "Nombre d'accès sur web-app",
                        "featureNameFr": "Nombre d'accès sur web-app",
                        "included": {
                            "starter": {
                                "included": true,
                                "access": "1",
                                "accessFR": "1"
                            },
                            "pro": {
                                "included": true,
                                "access": "Jusqu'a 10",
                                "accessFR": "Jusqu'a 10"
                            },
                            "advanced": {
                                "included": true,
                                "access": "Illimité",
                                "accessFR": "Illimité"
                            }
                        }
                    },
                    {
                        "featureName": "Nombre d'accès sur mobile-app",
                        "featureNameFr": "Nombre d'accès sur mobile-app",
                        "included": {
                            "starter": {
                                "included": false,
                                "access": null,
                                "accessFR": null
                            },
                            "pro": {
                                "included": true,
                                "access": "Jusqu'a 10",
                                "accessFR": "Jusqu'a 10"
                            },
                            "advanced": {
                                "included": true,
                                "access": "Illimité",
                                "accessFR": "Illimité"
                            }
                        }
                    }
                ]
            }
        ]
    }
}

1- Authentification

POST

http://fleet.test

/api/v1/fleet/auth/login

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Le champ value doit être une adresse e-mail valide.

Example:

eloisa.greenholt@example.net

password

string

required

Example:

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"eloisa.greenholt@example.net\",
    \"password\": \"ut\"
}"

Register client

POST

http://fleet.test

/api/v1/fleet/auth/register

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

first_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

wzitencvopmowtvfcyimbcuh

last_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

ennojkyavjqjkmkczzvvtuxd

string

required

Le champ value doit être une adresse e-mail valide. Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

javonte35@example.com

phone

string

required

Le texte value doit contenir au moins 10 caractères. Le texte de value ne peut contenir plus de 14 caractères.

Example:

esiuvxf

password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

)[?,Ex8LEq}7O5N:'N

Headers

Body

{ "first_name": "wzitencvopmowtvfcyimbcuh", "last_name": "ennojkyavjqjkmkczzvvtuxd", "email": "javonte35@example.com", "phone": "esiuvxf", "password": ")[?,Ex8LEq}7O5N:'N" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/auth/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"wzitencvopmowtvfcyimbcuh\",
    \"last_name\": \"ennojkyavjqjkmkczzvvtuxd\",
    \"email\": \"javonte35@example.com\",
    \"phone\": \"esiuvxf\",
    \"password\": \")[?,Ex8LEq}7O5N:\'N\"
}"

Send reset password link

POST

http://fleet.test

/api/v1/fleet/auth/password/forgot

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Le champ value doit être une adresse e-mail valide.

Example:

waelchi.constance@example.net

Headers

Body

{ "email": "waelchi.constance@example.net" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/auth/password/forgot" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"waelchi.constance@example.net\"
}"

Reset password

POST

http://fleet.test

/api/v1/fleet/auth/password/reset

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

token

string

required

Example:

magni

string

required

Le champ value doit être une adresse e-mail valide.

Example:

bartholome.champlin@example.net

password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

`'S4oA0Hf*

Headers

Body

{ "token": "magni", "email": "bartholome.champlin@example.net", "password": "`'S4oA0Hf*" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/auth/password/reset" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"magni\",
    \"email\": \"bartholome.champlin@example.net\",
    \"password\": \"`\'S4oA0Hf*\"
}"

Logout user

POST

http://fleet.test

/api/v1/fleet/auth/logout

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/auth/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

2- User management

Get user details

GET

http://fleet.test

/api/v1/fleet/user/show

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/user/show" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update user profile

POST

http://fleet.test

/api/v1/fleet/user/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

dfm

first_name

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

mvfmhehdxiroiakzvciutggg

last_name

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

xnnutkwusllnfzfr

siren_number

string

required

Le champ value doit contenir 9 chiffres.

Example:

781177279

string

required

Le champ value doit être une adresse e-mail valide. Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

imelda.oreilly@example.com

phone

string

required

Example:

optio

activity_code

string

required

Le texte value doit contenir au moins 5 caractères. Le texte de value ne peut contenir plus de 5 caractères.

Example:

tva_number

string

required

Example:

non

full_address

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

dhprlnkzgmbrdcqnjhkhnkgxv

country

string

Must be one of:

France
Greece

Example:

Greece

company_profile

string

required

Must be one of:

Example:

Auth

Bearer

Headers

Body

{ "name": "dfm", "first_name": "mvfmhehdxiroiakzvciutggg", "last_name": "xnnutkwusllnfzfr", "siren_number": "781177279", "email": "imelda.oreilly@example.com", "phone": "optio", "activity_code": "m", "tva_number": "non", "full_address": "dhprlnkzgmbrdcqnjhkhnkgxv", "country": "Greece", "company_profile": "C" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/user/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dfm\",
    \"first_name\": \"mvfmhehdxiroiakzvciutggg\",
    \"last_name\": \"xnnutkwusllnfzfr\",
    \"siren_number\": \"781177279\",
    \"email\": \"imelda.oreilly@example.com\",
    \"phone\": \"optio\",
    \"activity_code\": \"m\",
    \"tva_number\": \"non\",
    \"full_address\": \"dhprlnkzgmbrdcqnjhkhnkgxv\",
    \"country\": \"Greece\",
    \"company_profile\": \"C\"
}"

Update password

POST

http://fleet.test

/api/v1/fleet/user/password/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

current_password

string

required

Example:

voluptatum

password

string

required

The value and current_password must be different. Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

z(N$SEKWum

Auth

Bearer

Headers

Body

{ "current_password": "voluptatum", "password": "z(N$SEKWum" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/user/password/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"current_password\": \"voluptatum\",
    \"password\": \"z(N$SEKWum\"
}"

Store temp email

POST

http://fleet.test

/api/v1/fleet/temp-email/store

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/temp-email/store" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Verify temp email

POST

http://fleet.test

/api/v1/fleet/temp-email/verify

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Must be a valid UUID.

Example:

155e8247-8d86-336f-961f-2578cce50d0d

otp

string

required

Le champ value doit contenir 6 chiffres.

Example:

766012

Headers

Body

{ "uuid": "155e8247-8d86-336f-961f-2578cce50d0d", "otp": "766012" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/temp-email/verify" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"155e8247-8d86-336f-961f-2578cce50d0d\",
    \"otp\": \"766012\"
}"

POST api/v1/fleet/profile/complete

POST

http://fleet.test

/api/v1/fleet/profile/complete

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

country

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

qyhbrpwfcnadfqpt

name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

myeatpmafnbkphh

siret

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

ptpngnvsqulouhjsepm

company_size_id

string

required

Example:

quisquam

fleet_size_id

string

required

Example:

doloribus

industries_ids

integer[]

required

Example:

[12]

company_role_id

string

required

Example:

explicabo

experience

integer

required

La valeur de value doit être supérieure ou égale à 0. La valeur de value ne peut être supérieure à 100.

Example:

Auth

Bearer

Headers

Body

{ "country": "qyhbrpwfcnadfqpt", "name": "myeatpmafnbkphh", "siret": "ptpngnvsqulouhjsepm", "company_size_id": "quisquam", "fleet_size_id": "doloribus", "industries_ids": [ 12 ], "company_role_id": "explicabo", "experience": 1 }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/profile/complete" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country\": \"qyhbrpwfcnadfqpt\",
    \"name\": \"myeatpmafnbkphh\",
    \"siret\": \"ptpngnvsqulouhjsepm\",
    \"company_size_id\": \"quisquam\",
    \"fleet_size_id\": \"doloribus\",
    \"industries_ids\": [
        12
    ],
    \"company_role_id\": \"explicabo\",
    \"experience\": 1
}"

GET api/v1/fleet/profile/company-sizes

GET

http://fleet.test

/api/v1/fleet/profile/company-sizes

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/profile/company-sizes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/profile/fleet-sizes

GET

http://fleet.test

/api/v1/fleet/profile/fleet-sizes

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/profile/fleet-sizes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/profile/industries

GET

http://fleet.test

/api/v1/fleet/profile/industries

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/profile/industries" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/profile/company-roles

GET

http://fleet.test

/api/v1/fleet/profile/company-roles

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/profile/company-roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/profile/all-data

GET

http://fleet.test

/api/v1/fleet/profile/all-data

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/profile/all-data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

3- Vehicle management

Get client vehicles list

GET

http://fleet.test

/api/v1/fleet/vehicles/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/export-json

GET

http://fleet.test

/api/v1/fleet/vehicles/export-json

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/export-json" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all vehicles

GET

http://fleet.test

/api/v1/fleet/vehicles/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get vehicle details

GET

http://fleet.test

/api/v1/fleet/vehicles/show/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get vehicle overview data

GET

http://fleet.test

/api/v1/fleet/vehicles/overview/{vehicle}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle

string

required

Example:

delectus

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/overview/delectus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Switch car sharing status

POST

http://fleet.test

/api/v1/fleet/vehicles/switch/carsharing/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/switch/carsharing/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update vehicle lifecycle

POST

http://fleet.test

/api/v1/fleet/vehicles/update/lifecycle/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Body Parameters

vehicle_id

string

in_service_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:31

in_service_odometer

integer

La valeur de value doit être supérieure ou égale à 0.

Example:

estimated_service_life_months

integer

La valeur de value doit être supérieure ou égale à 1.

Example:

estimated_service_life_km

integer

La valeur de value doit être supérieure ou égale à 1.

Example:

estimated_resale_value

number

La valeur de value doit être supérieure ou égale à 0.

Example:

out_of_service_date

string

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au in_service_date.

Example:

2077-05-03

out_of_service_odometer

integer

La valeur de value doit être supérieure ou égale à 0.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "vehicle_id": null, "in_service_date": "2025-03-14T08:17:31", "in_service_odometer": 9, "estimated_service_life_months": 34, "estimated_service_life_km": 41, "estimated_resale_value": 0, "out_of_service_date": "2077-05-03", "out_of_service_odometer": 24 }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/update/lifecycle/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"in_service_date\": \"2025-03-14T08:17:31\",
    \"in_service_odometer\": 9,
    \"estimated_service_life_months\": 34,
    \"estimated_service_life_km\": 41,
    \"estimated_resale_value\": 0,
    \"out_of_service_date\": \"2077-05-03\",
    \"out_of_service_odometer\": 24
}"

Update vehicle financial

POST

http://fleet.test

/api/v1/fleet/vehicles/update/financial/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Body Parameters

purchase_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:31

purchase_price

number

La valeur de value doit être supérieure ou égale à 0.

Example:

odometer

integer

La valeur de value doit être supérieure ou égale à 0.

Example:

vendor_id

string

financial_status

string

Must be one of:

no
loaned
leased

Example:

loaned

date_of_lease

string

Le champ value n'est pas une date valide. This field is required when financial_status is leased.

Example:

2025-03-14T08:17:31

capitalized_cost

number

This field is required when financial_status is leased. La valeur de value doit être supérieure ou égale à 0.

Example:

down_payment

number

La valeur de value doit être supérieure ou égale à 0.

Example:

first_payment_date

string

Le champ value n'est pas une date valide. This field is required when financial_status is leased.

Example:

2025-03-14T08:17:31

monthly_payment

number

This field is required when financial_status is leased. La valeur de value doit être supérieure ou égale à 0.

Example:

number_of_payments

integer

This field is required when financial_status is leased. La valeur de value doit être supérieure ou égale à 1.

Example:

residual_value

number

This field is required when financial_status is leased. La valeur de value doit être supérieure ou égale à 0.

Example:

excess_km_charge

number

La valeur de value doit être supérieure ou égale à 0.

Example:

contract_km

integer

La valeur de value doit être supérieure ou égale à 0.

Example:

lease_number

string

Example:

facilis

generate_expenses

boolean

date_of_loan

string

Le champ value n'est pas une date valide. This field is required when financial_status is loaned.

Example:

2025-03-14T08:17:31

amount_of_loan

number

This field is required when financial_status is loaned. La valeur de value doit être supérieure ou égale à 0.

Example:

annual_percentage_rate

number

This field is required when financial_status is loaned. La valeur de value doit être supérieure ou égale à 0.

Example:

loan_end_date

string

Le champ value n'est pas une date valide. This field is required when financial_status is loaned.

Example:

2025-03-14T08:17:31

loan_number

string

Example:

velit

renter_id

string

in_service_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:31

in_service_odometer

integer

La valeur de value doit être supérieure ou égale à 0.

Example:

estimated_service_life_months

integer

La valeur de value doit être supérieure ou égale à 1.

Example:

estimated_service_life_km

integer

La valeur de value doit être supérieure ou égale à 1.

Example:

estimated_resale_value

number

La valeur de value doit être supérieure ou égale à 0.

Example:

out_of_service_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:31

out_of_service_odometer

integer

La valeur de value doit être supérieure ou égale à 0.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "purchase_date": "2025-03-14T08:17:31", "purchase_price": 38, "odometer": 17, "vendor_id": null, "financial_status": "loaned", "date_of_lease": "2025-03-14T08:17:31", "capitalized_cost": 80, "down_payment": 49, "first_payment_date": "2025-03-14T08:17:31", "monthly_payment": 45, "number_of_payments": 73, "residual_value": 44, "excess_km_charge": 11, "contract_km": 53, "lease_number": "facilis", "generate_expenses": false, "date_of_loan": "2025-03-14T08:17:31", "amount_of_loan": 88, "annual_percentage_rate": 23, "loan_end_date": "2025-03-14T08:17:31", "loan_number": "velit", "renter_id": null, "in_service_date": "2025-03-14T08:17:31", "in_service_odometer": 28, "estimated_service_life_months": 60, "estimated_service_life_km": 10, "estimated_resale_value": 82, "out_of_service_date": "2025-03-14T08:17:31", "out_of_service_odometer": 28 }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/update/financial/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"purchase_date\": \"2025-03-14T08:17:31\",
    \"purchase_price\": 38,
    \"odometer\": 17,
    \"financial_status\": \"loaned\",
    \"date_of_lease\": \"2025-03-14T08:17:31\",
    \"capitalized_cost\": 80,
    \"down_payment\": 49,
    \"first_payment_date\": \"2025-03-14T08:17:31\",
    \"monthly_payment\": 45,
    \"number_of_payments\": 73,
    \"residual_value\": 44,
    \"excess_km_charge\": 11,
    \"contract_km\": 53,
    \"lease_number\": \"facilis\",
    \"generate_expenses\": false,
    \"date_of_loan\": \"2025-03-14T08:17:31\",
    \"amount_of_loan\": 88,
    \"annual_percentage_rate\": 23,
    \"loan_end_date\": \"2025-03-14T08:17:31\",
    \"loan_number\": \"velit\",
    \"in_service_date\": \"2025-03-14T08:17:31\",
    \"in_service_odometer\": 28,
    \"estimated_service_life_months\": 60,
    \"estimated_service_life_km\": 10,
    \"estimated_resale_value\": 82,
    \"out_of_service_date\": \"2025-03-14T08:17:31\",
    \"out_of_service_odometer\": 28
}"

Update vehicle inspection

POST

http://fleet.test

/api/v1/fleet/vehicles/update/inspection/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Body Parameters

inspection_id

string

Auth

Bearer

Headers

URL Parameters

Body

{ "inspection_id": null }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/update/inspection/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

POST api/v1/fleet/vehicles/maintenance/update/{vehicle_id}

POST

http://fleet.test

/api/v1/fleet/vehicles/maintenance/update/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Body Parameters

inspection_forms

string[]

last_maintenance_date

string

Le champ value n'est pas une date valide. Must be a valid date in the format Y-m-d. Le champ value doit être une date antérieure ou égale au today.

Example:

2024-12-25

next_maintenance_date

string

Le champ value n'est pas une date valide. Must be a valid date in the format Y-m-d. Le champ value doit être une date postérieure ou égale au today.

Example:

2048-01-02

last_maintenance_mileage

number

La valeur de value doit être supérieure ou égale à 0.

Example:

next_maintenance_mileage

number

La valeur de value doit être supérieure ou égale à 0.

Example:

last_technical_control_date

string

Le champ value n'est pas une date valide. Must be a valid date in the format Y-m-d. Le champ value doit être une date antérieure ou égale au today.

Example:

2010-06-21

next_technical_control_date

string

Le champ value n'est pas une date valide. Must be a valid date in the format Y-m-d. Le champ value doit être une date postérieure ou égale au today.

Example:

2062-02-05

Auth

Bearer

Headers

URL Parameters

Body

{ "inspection_forms": null, "last_maintenance_date": "2024-12-25", "next_maintenance_date": "2048-01-02", "last_maintenance_mileage": 90, "next_maintenance_mileage": 56, "last_technical_control_date": "2010-06-21", "next_technical_control_date": "2062-02-05" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/maintenance/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"last_maintenance_date\": \"2024-12-25\",
    \"next_maintenance_date\": \"2048-01-02\",
    \"last_maintenance_mileage\": 90,
    \"next_maintenance_mileage\": 56,
    \"last_technical_control_date\": \"2010-06-21\",
    \"next_technical_control_date\": \"2062-02-05\"
}"

Delete a vehicle

DELETE

http://fleet.test

/api/v1/fleet/vehicles/delete/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vehicles/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/vehicles/restore/{vehicle}

POST

http://fleet.test

/api/v1/fleet/vehicles/restore/{vehicle}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle

string

required

Example:

similique

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/restore/similique" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE api/v1/fleet/vehicles/delete-all

DELETE

http://fleet.test

/api/v1/fleet/vehicles/delete-all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vehicles/delete-all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/vehicles/exitparc/{vehicle}

POST

http://fleet.test

/api/v1/fleet/vehicles/exitparc/{vehicle}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle

string

required

Example:

necessitatibus

Body Parameters

parc_exit_date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:31

custom_motive_id

string

Auth

Bearer

Headers

URL Parameters

Body

{ "parc_exit_date": "2025-03-14T08:17:31", "custom_motive_id": null }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/exitparc/necessitatibus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"parc_exit_date\": \"2025-03-14T08:17:31\"
}"

POST api/v1/fleet/vehicles/changestatus/{vehicle_id}

POST

http://fleet.test

/api/v1/fleet/vehicles/changestatus/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Body Parameters

custom_status_id

string

required

Example:

minima

Auth

Bearer

Headers

URL Parameters

Body

{ "custom_status_id": "minima" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/changestatus/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"custom_status_id\": \"minima\"
}"

GET api/v1/fleet/vehicles/over-view/{vehicle_id}

GET

http://fleet.test

/api/v1/fleet/vehicles/over-view/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/over-view/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/pr-1/{vehicle_id}

GET

http://fleet.test

/api/v1/fleet/vehicles/pr-1/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/pr-1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/pr-2/{vehicle_id}

GET

http://fleet.test

/api/v1/fleet/vehicles/pr-2/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/pr-2/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/pr-2/telemetry/{vehicle_id}

GET

http://fleet.test

/api/v1/fleet/vehicles/pr-2/telemetry/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/pr-2/telemetry/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/pr-2/history/{vehicle_id}

GET

http://fleet.test

/api/v1/fleet/vehicles/pr-2/history/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/pr-2/history/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/pr-2/sensor-alert/list

GET

http://fleet.test

/api/v1/fleet/vehicles/pr-2/sensor-alert/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/pr-2/sensor-alert/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/pr-2/sensor-alert-item/list/{vehicle_id}

GET

http://fleet.test

/api/v1/fleet/vehicles/pr-2/sensor-alert-item/list/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/pr-2/sensor-alert-item/list/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

POST api/v1/fleet/vehicles/pr-2/sensor-alert-item/update/{sensor_id}

POST

http://fleet.test

/api/v1/fleet/vehicles/pr-2/sensor-alert-item/update/{sensor_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

sensor_id

integer

required

The ID of the sensor.

Example:

Body Parameters

conditions

object[]

required

Auth

Bearer

Headers

URL Parameters

Body

{ "conditions": [ { "sensor_alert_id": 20, "value": 0.7261 } ] }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/pr-2/sensor-alert-item/update/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"conditions\": [
        {
            \"sensor_alert_id\": 20,
            \"value\": 0.7261
        }
    ]
}"

POST api/v1/fleet/vehicles/pr-2/sensor-alert-item/reset/{sensor_id}

POST

http://fleet.test

/api/v1/fleet/vehicles/pr-2/sensor-alert-item/reset/{sensor_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

sensor_id

integer

required

The ID of the sensor.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/pr-2/sensor-alert-item/reset/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/vehicles/pr-2/device/update/{vehicle_id}

POST

http://fleet.test

/api/v1/fleet/vehicles/pr-2/device/update/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/pr-2/device/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE api/v1/fleet/vehicles/pr-2/sensor/delete/{sensor_id}

DELETE

http://fleet.test

/api/v1/fleet/vehicles/pr-2/sensor/delete/{sensor_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

sensor_id

integer

required

The ID of the sensor.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vehicles/pr-2/sensor/delete/12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/fleet/vehicles/brands

GET

http://fleet.test

/api/v1/fleet/vehicles/brands

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/brands" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/models/{brand_id}

GET

http://fleet.test

/api/v1/fleet/vehicles/models/{brand_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

brand_id

string

required

The ID of the brand.

Example:

voluptatem

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/models/voluptatem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/versions/{model_id}

GET

http://fleet.test

/api/v1/fleet/vehicles/versions/{model_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

model_id

string

required

The ID of the model.

Example:

vitae

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/versions/vitae" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/find/{number_plate}

GET

http://fleet.test

/api/v1/fleet/vehicles/find/{number_plate}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

number_plate

string

required

Example:

non

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/find/non" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/matriculation/search/{matriculation}

GET

http://fleet.test

/api/v1/fleet/vehicles/matriculation/search/{matriculation}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

matriculation

string

required

Example:

fugit

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/matriculation/search/fugit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/vroomly/search

GET

http://fleet.test

/api/v1/fleet/vehicles/vroomly/search

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/vroomly/search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/vroomly/search-one

GET

http://fleet.test

/api/v1/fleet/vehicles/vroomly/search-one

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/vroomly/search-one" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/idgarages/search

GET

http://fleet.test

/api/v1/fleet/vehicles/idgarages/search

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/idgarages/search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/idgarages/search-one

GET

http://fleet.test

/api/v1/fleet/vehicles/idgarages/search-one

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/idgarages/search-one" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

POST api/v1/fleet/vehicles/import-list

POST

http://fleet.test

/api/v1/fleet/vehicles/import-list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/import-list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/vehicles/update-vehicles

POST

http://fleet.test

/api/v1/fleet/vehicles/update-vehicles

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/update-vehicles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE api/v1/fleet/vehicles/delete-list

DELETE

http://fleet.test

/api/v1/fleet/vehicles/delete-list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vehicles/delete-list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/vehicles/connect-vehicles

POST

http://fleet.test

/api/v1/fleet/vehicles/connect-vehicles

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/connect-vehicles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/vehicles/connect-vehicle/{vehicle_id}

POST

http://fleet.test

/api/v1/fleet/vehicles/connect-vehicle/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/connect-vehicle/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/fleet/vehicles/connected-vehicles

GET

http://fleet.test

/api/v1/fleet/vehicles/connected-vehicles

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/connected-vehicles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

POST api/v1/fleet/vehicles/disconnect-vehicle/{vehicle_id}

POST

http://fleet.test

/api/v1/fleet/vehicles/disconnect-vehicle/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/disconnect-vehicle/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/vehicles/disconnect-vehicles

POST

http://fleet.test

/api/v1/fleet/vehicles/disconnect-vehicles

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/disconnect-vehicles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get vehicle car trips

GET

http://fleet.test

/api/v1/fleet/vehicles/cartrips/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/cartrips/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get vehicle car trips V2

GET

http://fleet.test

/api/v1/fleet/vehicles/cartripsv2/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/cartripsv2/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/cartrips/import/{vehicle_id}

GET

http://fleet.test

/api/v1/fleet/vehicles/cartrips/import/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/cartrips/import/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/vehicles/carlocations/list

GET

http://fleet.test

/api/v1/fleet/vehicles/carlocations/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/carlocations/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Export vehicles table

GET

http://fleet.test

/api/v1/fleet/vehicles/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicles/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

POST api/v1/fleet/vehicles/privatemode/{vehicle_id}

POST

http://fleet.test

/api/v1/fleet/vehicles/privatemode/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/privatemode/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE api/v1/fleet/vehicles/antai/delete

DELETE

http://fleet.test

/api/v1/fleet/vehicles/antai/delete

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vehicles/antai/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/vehicles/antai/add

POST

http://fleet.test

/api/v1/fleet/vehicles/antai/add

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/antai/add" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE api/v1/fleet/vehicles/antai/delete/{vehicle_id}

DELETE

http://fleet.test

/api/v1/fleet/vehicles/antai/delete/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vehicles/antai/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/vehicles/antai/add/{vehicle_id}

POST

http://fleet.test

/api/v1/fleet/vehicles/antai/add/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicles/antai/add/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get all vehicles

GET

http://fleet.test

/api/v1/fleet/vehicle/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicle/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get antai client vehicles list

GET

http://fleet.test

/api/v1/fleet/antaivehicles/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/antaivehicles/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

4- Site management

Get client sites list

GET

http://fleet.test

/api/v1/fleet/site/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/site/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Export sites table

GET

http://fleet.test

/api/v1/fleet/site/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/site/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get client all sites list

GET

http://fleet.test

/api/v1/fleet/site/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/site/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get site details

GET

http://fleet.test

/api/v1/fleet/site/show/{site_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

site_id

integer

required

The ID of the site.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/site/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get site vehicles

GET

http://fleet.test

/api/v1/fleet/site/{site_id}/vehicles

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

site_id

integer

required

The ID of the site.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/site/1/vehicles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get site workers

GET

http://fleet.test

/api/v1/fleet/site/{site_id}/workers

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

site_id

integer

required

The ID of the site.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/site/1/workers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Delete a site

DELETE

http://fleet.test

/api/v1/fleet/site/delete/{site_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

site_id

integer

required

The ID of the site.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/site/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

5- Parkings management

Get client parkings list

GET

http://fleet.test

/api/v1/fleet/parking/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/parking/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get parking details

GET

http://fleet.test

/api/v1/fleet/parking/show/{parking_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

parking_id

integer

required

The ID of the parking.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/parking/show/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a parking

POST

http://fleet.test

/api/v1/fleet/parking/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

yryismahxxdqa

address

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

parking_map

string

Le texte de value ne peut contenir plus de 2048 caractères.

Example:

zaxqnvrizs

Auth

Bearer

Headers

Body

{ "name": "yryismahxxdqa", "address": "z", "parking_map": "zaxqnvrizs" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/parking/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"yryismahxxdqa\",
    \"address\": \"z\",
    \"parking_map\": \"zaxqnvrizs\"
}"

Update a parking

POST

http://fleet.test

/api/v1/fleet/parking/update/{parking_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

parking_id

integer

required

The ID of the parking.

Example:

Body Parameters

name

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

address

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

yqkmxazxpvavxjeeo

parking_map

string

Le texte de value ne peut contenir plus de 2048 caractères.

Example:

ziyxtcdek

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "cv", "address": "yqkmxazxpvavxjeeo", "parking_map": "ziyxtcdek" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/parking/update/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"cv\",
    \"address\": \"yqkmxazxpvavxjeeo\",
    \"parking_map\": \"ziyxtcdek\"
}"

Delete a parking

DELETE

http://fleet.test

/api/v1/fleet/parking/delete/{parking_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

parking_id

integer

required

The ID of the parking.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/parking/delete/5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

6- Sites Managers management

Get client site managers list

GET

http://fleet.test

/api/v1/fleet/site-manager/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/site-manager/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get site manager details

GET

http://fleet.test

/api/v1/fleet/site-manager/show/{user_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/site-manager/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a site manager

POST

http://fleet.test

/api/v1/fleet/site-manager/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

first_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

ewajtkdm

last_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

rghpkcncpsfyvjgyerzlvxd

title

string

Must be one of:

Mr
Mlle
Mm

Example:

phone

string

required

Le champ value doit contenir 10 chiffres.

Example:

8145202915

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

kunde.gracie@example.net

password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

tfIedupuEr6lh~y

site_id

integer

Example:

address

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

xadubdnacntu

Auth

Bearer

Headers

Body

{ "first_name": "ewajtkdm", "last_name": "rghpkcncpsfyvjgyerzlvxd", "title": "Mm", "phone": "8145202915", "email": "kunde.gracie@example.net", "password": "tfIedupuEr6lh~y", "site_id": 6, "address": "xadubdnacntu" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/site-manager/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"ewajtkdm\",
    \"last_name\": \"rghpkcncpsfyvjgyerzlvxd\",
    \"title\": \"Mm\",
    \"phone\": \"8145202915\",
    \"email\": \"kunde.gracie@example.net\",
    \"password\": \"tfIedupuEr6lh~y\",
    \"site_id\": 6,
    \"address\": \"xadubdnacntu\"
}"

Update a site manager

POST

http://fleet.test

/api/v1/fleet/site-manager/update/{user_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Body Parameters

first_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

last_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

zxqbtvydzdhsfcev

title

string

Must be one of:

Mr
Mlle
Mm

Example:

phone

string

required

Le champ value doit contenir 10 chiffres.

Example:

1981546556

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

jorge48@example.com

password

string

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

,lkX;=

site_id

integer

Example:

address

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

jwutbgrfeonjnzqkmk

Auth

Bearer

Headers

URL Parameters

Body

{ "first_name": "fv", "last_name": "zxqbtvydzdhsfcev", "title": "Mr", "phone": "1981546556", "email": "jorge48@example.com", "password": ",lkX;=", "site_id": 16, "address": "jwutbgrfeonjnzqkmk" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/site-manager/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"fv\",
    \"last_name\": \"zxqbtvydzdhsfcev\",
    \"title\": \"Mr\",
    \"phone\": \"1981546556\",
    \"email\": \"jorge48@example.com\",
    \"password\": \",lkX;=\",
    \"site_id\": 16,
    \"address\": \"jwutbgrfeonjnzqkmk\"
}"

Delete a site manager

DELETE

http://fleet.test

/api/v1/fleet/site-manager/delete/{user_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/site-manager/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

7- Drivers management

Get client drivers list

GET

http://fleet.test

/api/v1/fleet/driver/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/driver/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get driver details

GET

http://fleet.test

/api/v1/fleet/driver/show/{user_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/driver/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a driver

POST

http://fleet.test

/api/v1/fleet/driver/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

first_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

hbrozjaz

last_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

gmqfhwvszzhmfkmmamp

phone

string

required

Le champ value doit contenir 10 chiffres.

Example:

9019604797

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

waino.wolff@example.com

password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

?%nn5O

address

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

mwcnpculxvxjiybcz

sites

integer[]

Example:

[11]

license_categories

integer[]

Example:

[2]

driver_license_number

string

Le champ value doit contenir 12 chiffres.

Example:

540753587945

driving_license_issue_date

string

Le champ value n'est pas une date valide. Le champ value doit être une date antérieure ou égale au 2025-03-14 08:17:31.

Example:

2010-04-26

driving_license_issue_place

string

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

ycedzepbc

driver_license_picture

string

Le texte de value ne peut contenir plus de 2048 caractères.

Example:

yciiiiawj

Auth

Bearer

Headers

Body

{ "first_name": "hbrozjaz", "last_name": "gmqfhwvszzhmfkmmamp", "phone": "9019604797", "email": "waino.wolff@example.com", "password": "?%nn5O", "address": "mwcnpculxvxjiybcz", "sites": [ 11 ], "license_categories": [ 2 ], "driver_license_number": "540753587945", "driving_license_issue_date": "2010-04-26", "driving_license_issue_place": "ycedzepbc", "driver_license_picture": "yciiiiawj" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/driver/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"hbrozjaz\",
    \"last_name\": \"gmqfhwvszzhmfkmmamp\",
    \"phone\": \"9019604797\",
    \"email\": \"waino.wolff@example.com\",
    \"password\": \"?%nn5O\",
    \"address\": \"mwcnpculxvxjiybcz\",
    \"sites\": [
        11
    ],
    \"license_categories\": [
        2
    ],
    \"driver_license_number\": \"540753587945\",
    \"driving_license_issue_date\": \"2010-04-26\",
    \"driving_license_issue_place\": \"ycedzepbc\",
    \"driver_license_picture\": \"yciiiiawj\"
}"

Update a driver

POST

http://fleet.test

/api/v1/fleet/driver/update/{user_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Body Parameters

first_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

eprxoab

last_name

string

required

Le texte value doit contenir au moins 2 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

ulcdpuupoctblmu

phone

string

required

Le champ value doit contenir 10 chiffres.

Example:

4759608045

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

cormier.telly@example.net

password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

a3v3|#)Gz]E2C-$}n

address

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

dqwuuubtsilikxgz

sites

integer[]

Example:

[2]

license_categories

integer[]

Example:

[3]

driver_license_number

string

Le champ value doit contenir 12 chiffres.

Example:

051551351403

driving_license_issue_date

string

Le champ value n'est pas une date valide. Le champ value doit être une date antérieure ou égale au 2025-03-14 08:17:31.

Example:

2006-08-03

driving_license_issue_place

string

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

hgfdbdehctmgrygpk

driver_license_picture

string

Le texte de value ne peut contenir plus de 2048 caractères.

Example:

enrmcz

Auth

Bearer

Headers

URL Parameters

Body

{ "first_name": "eprxoab", "last_name": "ulcdpuupoctblmu", "phone": "4759608045", "email": "cormier.telly@example.net", "password": "a3v3|#)Gz]E2C-$}n", "address": "dqwuuubtsilikxgz", "sites": [ 2 ], "license_categories": [ 3 ], "driver_license_number": "051551351403", "driving_license_issue_date": "2006-08-03", "driving_license_issue_place": "hgfdbdehctmgrygpk", "driver_license_picture": "enrmcz" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/driver/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"eprxoab\",
    \"last_name\": \"ulcdpuupoctblmu\",
    \"phone\": \"4759608045\",
    \"email\": \"cormier.telly@example.net\",
    \"password\": \"a3v3|#)Gz]E2C-$}n\",
    \"address\": \"dqwuuubtsilikxgz\",
    \"sites\": [
        2
    ],
    \"license_categories\": [
        3
    ],
    \"driver_license_number\": \"051551351403\",
    \"driving_license_issue_date\": \"2006-08-03\",
    \"driving_license_issue_place\": \"hgfdbdehctmgrygpk\",
    \"driver_license_picture\": \"enrmcz\"
}"

Assign a driver to a vehicle

POST

http://fleet.test

/api/v1/fleet/driver/assign-vehicle/{user_id}/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

vehicle_id

integer

required

The ID of the vehicle.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/driver/assign-vehicle/1/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete a driver

DELETE

http://fleet.test

/api/v1/fleet/driver/delete/{user_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/driver/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

8- Service management

Get services list

GET

http://fleet.test

/api/v1/fleet/service/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/service/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get sub services list

GET

http://fleet.test

/api/v1/fleet/subservices/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/subservices/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

9- Vendor management

Get user vendors list

GET

http://fleet.test

/api/v1/fleet/vendor/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendor/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Search vendors

GET

http://fleet.test

/api/v1/fleet/vendor/search

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

the search value.

Example:

Garage

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendor/search?query=Garage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Filter vendors

GET

http://fleet.test

/api/v1/fleet/vendor/filter

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

service_id

integer

required

The ID of the service.

Example:

lat

string

required

The latitude coordinate.

Example:

48.859

long

string

required

The longitude coordinate.

Example:

2.347

radius

string

required

The filter radius in kilometers.

Example:

100.0

Body Parameters

vehicle_id

string

required

Example:

deserunt

service_id

integer

required

Example:

lat

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

ugfxo

long

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

xytnswdqqnjschdcmmt

Auth

Bearer

Headers

Query Parameters

Body

{ "vehicle_id": "deserunt", "service_id": 5, "lat": "ugfxo", "long": "xytnswdqqnjschdcmmt" }

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendor/filter?vehicle_id=15&service_id=2&lat=48.859&long=2.347&radius=100.0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"deserunt\",
    \"service_id\": 5,
    \"lat\": \"ugfxo\",
    \"long\": \"xytnswdqqnjschdcmmt\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store vendor

POST

http://fleet.test

/api/v1/fleet/vendor/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

qmzipjscxmaeweruitsgvwuy

first_name

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

lcefeoiqvfazbkdgz

last_name

string

required

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

joelspfvrebstkmdadbdbnosj

string

required

Le champ value doit être une adresse e-mail valide.

Example:

concepcion.bashirian@example.org

phone_number

string

required

Le champ value doit contenir entre 8 et 15 chiffres.

Example:

5716968408596

address

string

required

Example:

placeat

city

string

required

Example:

sapiente

siret_number

string

Le champ value doit contenir 14 chiffres.

Example:

03434177798005

rcs_number

string

Example:

impedit

postal_code

number

required

Example:

5388649

lat

number

required

Example:

384002.85569541

lng

number

required

Example:

465078291

Auth

Bearer

Headers

Body

{ "name": "qmzipjscxmaeweruitsgvwuy", "first_name": "lcefeoiqvfazbkdgz", "last_name": "joelspfvrebstkmdadbdbnosj", "email": "concepcion.bashirian@example.org", "phone_number": "5716968408596", "address": "placeat", "city": "sapiente", "siret_number": "03434177798005", "rcs_number": "impedit", "postal_code": 5388649, "lat": 384002.855695413, "lng": 465078291 }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vendor/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"qmzipjscxmaeweruitsgvwuy\",
    \"first_name\": \"lcefeoiqvfazbkdgz\",
    \"last_name\": \"joelspfvrebstkmdadbdbnosj\",
    \"email\": \"concepcion.bashirian@example.org\",
    \"phone_number\": \"5716968408596\",
    \"address\": \"placeat\",
    \"city\": \"sapiente\",
    \"siret_number\": \"03434177798005\",
    \"rcs_number\": \"impedit\",
    \"postal_code\": 5388649,
    \"lat\": 384002.855695413,
    \"lng\": 465078291
}"

Link vendor

POST

http://fleet.test

/api/v1/fleet/vendor/link/{vendorId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendorId

string

required

Example:

praesentium

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vendor/link/praesentium" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

10- Appointment management

Get appointments list

GET

http://fleet.test

/api/v1/fleet/appointment/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/appointment/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Show an appointment/estimation

GET

http://fleet.test

/api/v1/fleet/appointment/show/{appointment_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment_id

string

required

The ID of the appointment.

Example:

sit

Query Parameters

appointment_id

integer

required

The ID of the appointment.

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/appointment/show/sit?appointment_id=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Refuse an estimation

PUT

http://fleet.test

/api/v1/fleet/appointment/refuse/{appointment_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment_id

string

required

The ID of the appointment.

Example:

esse

Query Parameters

appointment_id

integer

required

The ID of the appointment.

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request PUT \
    "http://fleet.test/api/v1/fleet/appointment/refuse/esse?appointment_id=15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get invoices list

GET

http://fleet.test

/api/v1/fleet/appointment/invoices

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/appointment/invoices" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get estimations list

GET

http://fleet.test

/api/v1/fleet/appointment/estimations

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/appointment/estimations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an appointment

POST

http://fleet.test

/api/v1/fleet/appointment/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

service_id

integer

required

The ID of the service.

Example:

provider_id

integer

required

The ID of the provider.

Example:

appointment_date

date

The appointment date.

Example:

2024-12-31

appointment_time

date

The appointment time.

Example:

12:00

Auth

Bearer

Headers

Body

{ "vehicle_id": 15, "service_id": 2, "provider_id": 3, "appointment_date": "2024-12-31", "appointment_time": "12:00" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/appointment/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": 15,
    \"service_id\": 2,
    \"provider_id\": 3,
    \"appointment_date\": \"2024-12-31\",
    \"appointment_time\": \"12:00\"
}"

Store an estimation

POST

http://fleet.test

/api/v1/fleet/appointment/estimations/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

service_id

integer

required

The ID of the service.

Example:

provider_id

integer

required

The ID of the provider.

Example:

note

string

nullable The note.

Example:

"Please take care of the car"

Auth

Bearer

Headers

Body

{ "vehicle_id": 15, "service_id": 2, "provider_id": 3, "note": "\"Please take care of the car\"" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/appointment/estimations/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": 15,
    \"service_id\": 2,
    \"provider_id\": 3,
    \"note\": \"\\\"Please take care of the car\\\"\"
}"

Accept an appointment date

POST

http://fleet.test

/api/v1/fleet/appointment/date/accept/{appointmentId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointmentId

string

required

Example:

non

Body Parameters

boolean

required

The accept.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "accept": true }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/appointment/date/accept/non" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"accept\": true
}"

Create an appointment from an estimation

POST

http://fleet.test

/api/v1/fleet/appointment/store/{estimationId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

estimationId

string

required

Example:

Body Parameters

appointment_date

date

required

The appointment date.

Example:

2024-12-31

appointment_time

date

required

The appointment time.

Example:

12:00

Auth

Bearer

Headers

URL Parameters

Body

{ "appointment_date": "2024-12-31", "appointment_time": "12:00" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/appointment/store/et" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"appointment_date\": \"2024-12-31\",
    \"appointment_time\": \"12:00\"
}"

10- Certify Appointment

Get certify appointments list for fleet client

GET

http://fleet.test

/api/v1/fleet/appointment/certify/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/appointment/certify/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

11- Conveying management

Get conveyings list

GET

http://fleet.test

/api/v1/fleet/conveying/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/conveying/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get conveying details

GET

http://fleet.test

/api/v1/fleet/conveying/show/{conveying}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

conveying

string

required

Example:

doloremque

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/conveying/show/doloremque" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Cancel conveying

POST

http://fleet.test

/api/v1/fleet/conveying/cancel/{conveying}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

conveying

string

required

Example:

quis

Body Parameters

description

string

Le texte value doit contenir au moins 3 caractères. Le texte de value ne peut contenir plus de 1000 caractères.

Example:

Impedit consequatur incidunt distinctio error accusamus.

Auth

Bearer

Headers

URL Parameters

Body

{ "description": "Impedit consequatur incidunt distinctio error accusamus." }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/conveying/cancel/quis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Impedit consequatur incidunt distinctio error accusamus.\"
}"

Get conveyings contracts list

GET

http://fleet.test

/api/v1/fleet/conveying/contract/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/conveying/contract/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

12- License Categories management

GET

http://fleet.test

/api/v1/fleet/license-category/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/license-category/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

13- Label management

Get user labels list

GET

http://fleet.test

/api/v1/fleet/labels/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/labels/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all user labels without pagination

GET

http://fleet.test

/api/v1/fleet/labels/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/labels/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get label details

GET

http://fleet.test

/api/v1/fleet/labels/show/{label_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

label_id

integer

required

The ID of the label.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/labels/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a label

POST

http://fleet.test

/api/v1/fleet/labels/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

qplcqrxx

color

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

nqsbimaaxytrt

description

string

Example:

Optio iure eaque harum eos.

Auth

Bearer

Headers

Body

{ "name": "qplcqrxx", "color": "nqsbimaaxytrt", "description": "Optio iure eaque harum eos." }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/labels/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"qplcqrxx\",
    \"color\": \"nqsbimaaxytrt\",
    \"description\": \"Optio iure eaque harum eos.\"
}"

Update a label

POST

http://fleet.test

/api/v1/fleet/labels/update/{label_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

label_id

integer

required

The ID of the label.

Example:

Body Parameters

name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

pyiu

color

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

description

string

Example:

Cupiditate corrupti recusandae et.

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "pyiu", "color": "fj", "description": "Cupiditate corrupti recusandae et." }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/labels/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"pyiu\",
    \"color\": \"fj\",
    \"description\": \"Cupiditate corrupti recusandae et.\"
}"

Delete a label

DELETE

http://fleet.test

/api/v1/fleet/labels/delete/{label_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

label_id

integer

required

The ID of the label.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/labels/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

14- Issue management

Get client issues list

GET

http://fleet.test

/api/v1/fleet/issues/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/issues/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Export issues table

GET

http://fleet.test

/api/v1/fleet/issues/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/issues/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get issue details

GET

http://fleet.test

/api/v1/fleet/issues/show/{issue}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

issue

string

required

Example:

exercitationem

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/issues/show/exercitationem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an issue

POST

http://fleet.test

/api/v1/fleet/issues/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

yjcpejjbuoehbflvmwrjrhggc

description

string

Example:

In sed ipsum quia omnis sit.

priority

string

required

Must be one of:

No Priority
Low
Medium
High
Critical

Example:

Critical

vehicle_id

string

required

Example:

officia

label_id

string

reported_by

string

required

Example:

quae

assigned_to

string

reported_at

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

due_date

string

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure ou égale au reported_at.

Example:

2101-10-20

odometer

number

La valeur de value doit être supérieure ou égale à 0.

Example:

source

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/issues/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=yjcpejjbuoehbflvmwrjrhggc"\
    --form "description=In sed ipsum quia omnis sit."\
    --form "priority=Critical"\
    --form "vehicle_id=officia"\
    --form "reported_by=quae"\
    --form "reported_at=2025-03-14T08:17:32"\
    --form "due_date=2101-10-20"\
    --form "odometer=62"\
    --form "source=i"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpD8A3.tmp"

Update an issue

POST

http://fleet.test

/api/v1/fleet/issues/update/{issue_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

issue_id

integer

required

The ID of the issue.

Example:

Body Parameters

name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

detpypqgntpbb

description

string

Example:

Enim minima necessitatibus praesentium.

priority

string

required

Must be one of:

No Priority
Low
Medium
High
Critical

Example:

High

status

string

required

Must be one of:

Open
Resolved
Closed

Example:

Resolved

vehicle_id

string

required

Example:

suscipit

label_id

string

reported_by

string

required

Example:

aut

assigned_to

string

reported_at

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

due_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

odometer

number

La valeur de value doit être supérieure ou égale à 0.

Example:

source

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

ohhjyalzehyaliusgtafdunr

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/issues/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=detpypqgntpbb"\
    --form "description=Enim minima necessitatibus praesentium."\
    --form "priority=High"\
    --form "status=Resolved"\
    --form "vehicle_id=suscipit"\
    --form "reported_by=aut"\
    --form "reported_at=2025-03-14T08:17:32"\
    --form "due_date=2025-03-14T08:17:32"\
    --form "odometer=76"\
    --form "source=ohhjyalzehyaliusgtafdunr"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpD8B4.tmp"

POST api/v1/fleet/issues/partner/{issue_id}

POST

http://fleet.test

/api/v1/fleet/issues/partner/{issue_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

issue_id

integer

required

The ID of the issue.

Example:

Body Parameters

provider_id

integer

required

Example:

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

odometer

integer

Example:

schedule_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

operator_id

string

enable_notifications

boolean

Auth

Bearer

Headers

URL Parameters

Body

{ "provider_id": 15, "service_id": 4, "priority": "N", "odometer": 11, "schedule_date": "2025-03-14T08:17:32", "operator_id": null, "enable_notifications": false }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/issues/partner/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"provider_id\": 15,
    \"service_id\": 4,
    \"priority\": \"N\",
    \"odometer\": 11,
    \"schedule_date\": \"2025-03-14T08:17:32\",
    \"enable_notifications\": false
}"

POST api/v1/fleet/issues/inhouse/{issue_id}

POST

http://fleet.test

/api/v1/fleet/issues/inhouse/{issue_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

issue_id

integer

required

The ID of the issue.

Example:

Body Parameters

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

odometer

integer

Example:

schedule_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

operator_id

string

enable_notifications

boolean

Auth

Bearer

Headers

URL Parameters

Body

{ "service_id": 12, "priority": "N", "odometer": 13, "schedule_date": "2025-03-14T08:17:32", "operator_id": null, "enable_notifications": false }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/issues/inhouse/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"service_id\": 12,
    \"priority\": \"N\",
    \"odometer\": 13,
    \"schedule_date\": \"2025-03-14T08:17:32\",
    \"enable_notifications\": false
}"

Resolve an issue

POST

http://fleet.test

/api/v1/fleet/issues/resolve/{issue_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

issue_id

integer

required

The ID of the issue.

Example:

Body Parameters

resolve_note

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

lfd

Auth

Bearer

Headers

URL Parameters

Body

{ "resolve_note": "lfd" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/issues/resolve/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"resolve_note\": \"lfd\"
}"

Delete an issue

DELETE

http://fleet.test

/api/v1/fleet/issues/delete/{issue_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

issue_id

integer

required

The ID of the issue.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/issues/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

15- Inhouse Service management

Get inhouse services list

GET

http://fleet.test

/api/v1/fleet/inhouseservices/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inhouseservices/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get inhouse service details

GET

http://fleet.test

/api/v1/fleet/inhouseservices/show/{inhouseservice}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inhouseservice

string

required

Example:

quia

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inhouseservices/show/quia" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an inhouse service

POST

http://fleet.test

/api/v1/fleet/inhouseservices/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

illum

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

status

string

required

Must be one of:

Example:

odometer

integer

Example:

schedule_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

operator_id

string

enable_notifications

string

required

Must be one of:

true
false

Example:

false

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/inhouseservices/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=illum"\
    --form "service_id=12"\
    --form "priority=N"\
    --form "status=O"\
    --form "odometer=6"\
    --form "schedule_date=2025-03-14T08:17:32"\
    --form "enable_notifications=false"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpD8F4.tmp"

Update an inhouse service

POST

http://fleet.test

/api/v1/fleet/inhouseservices/update/{inhouseservice_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

inhouseservice_id

integer

required

The ID of the inhouseservice.

Example:

Body Parameters

vehicle_id

string

required

Example:

sed

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

status

string

required

Must be one of:

Example:

odometer

integer

Example:

schedule_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

operator_id

string

enable_notifications

string

required

Must be one of:

true
false

Example:

true

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/inhouseservices/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=sed"\
    --form "service_id=9"\
    --form "priority=N"\
    --form "status=R"\
    --form "odometer=14"\
    --form "schedule_date=2025-03-14T08:17:32"\
    --form "enable_notifications=true"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpD904.tmp"

Delete an inhouse service

DELETE

http://fleet.test

/api/v1/fleet/inhouseservices/delete/{inhouseservice_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inhouseservice_id

integer

required

The ID of the inhouseservice.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/inhouseservices/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

16- Partner Service management

Get partner services list

GET

http://fleet.test

/api/v1/fleet/partnerservices/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/partnerservices/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get partner service details

GET

http://fleet.test

/api/v1/fleet/partnerservices/show/{partnerservice}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

partnerservice

string

required

Example:

aut

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/partnerservices/show/aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an partner service

POST

http://fleet.test

/api/v1/fleet/partnerservices/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

molestiae

provider_id

integer

required

Example:

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

status

string

required

Must be one of:

Example:

odometer

integer

Example:

schedule_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

operator_id

string

enable_notifications

string

required

Must be one of:

true
false

Example:

true

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

date_back_in_site

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

out_of_site_custom_status_id

string

back_in_site_custom_status_id

string

required

Example:

quia

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/partnerservices/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=molestiae"\
    --form "provider_id=10"\
    --form "service_id=3"\
    --form "priority=U"\
    --form "status=R"\
    --form "odometer=6"\
    --form "schedule_date=2025-03-14T08:17:32"\
    --form "enable_notifications=true"\
    --form "date_back_in_site=2025-03-14T08:17:32"\
    --form "back_in_site_custom_status_id=quia"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpD934.tmp"

Update an partner service

POST

http://fleet.test

/api/v1/fleet/partnerservices/update/{partnerservice_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

partnerservice_id

integer

required

The ID of the partnerservice.

Example:

Body Parameters

vehicle_id

string

required

Example:

voluptatem

provider_id

integer

required

Example:

service_id

integer

required

Example:

priority

string

required

Must be one of:

Example:

status

string

required

Must be one of:

Example:

odometer

integer

Example:

schedule_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

operator_id

string

enable_notifications

string

required

Must be one of:

true
false

Example:

true

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

date_back_in_site

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

out_of_site_custom_status_id

string

back_in_site_custom_status_id

string

required

Example:

totam

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/partnerservices/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=voluptatem"\
    --form "provider_id=8"\
    --form "service_id=7"\
    --form "priority=S"\
    --form "status=O"\
    --form "odometer=10"\
    --form "schedule_date=2025-03-14T08:17:32"\
    --form "enable_notifications=true"\
    --form "date_back_in_site=2025-03-14T08:17:32"\
    --form "back_in_site_custom_status_id=totam"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpD945.tmp"

Delete an partner service

DELETE

http://fleet.test

/api/v1/fleet/partnerservices/delete/{partnerservice_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

partnerservice_id

integer

required

The ID of the partnerservice.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/partnerservices/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

17- Vendor management

Get vendors list

GET

http://fleet.test

/api/v1/fleet/vendors/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendors/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get user vendors list

GET

http://fleet.test

/api/v1/fleet/vendors/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendors/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Export vendors table

GET

http://fleet.test

/api/v1/fleet/vendors/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendors/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a vendor

POST

http://fleet.test

/api/v1/fleet/vendors/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

ojludqci

phone

string

required

Le texte de value ne peut contenir plus de 20 caractères.

Example:

iqkiooldmnjob

address

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

opawypzddgcifjzlcokuopj

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

upton.bianka@example.com

note

string

Example:

website

string

Must be a valid URL. Le texte de value ne peut contenir plus de 255 caractères.

Example:

uqgt

siret

string

Le texte de value ne peut contenir plus de 14 caractères.

Example:

wnpivqbnbhkiky

contact_person_name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

emxghhvnqynyenvuclcv

contact_person_phone_number

string

required

Le texte de value ne peut contenir plus de 20 caractères.

Example:

qxeeqtdlm

contact_person_email

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

will.webster@example.net

contact_person_occupation

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

tcnuiewjowgnsiw

contract_start_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

contract_end_date

string

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au contract_start_date.

Example:

2105-10-30

classifications

string[]

required

Example:

["nulla"]

Auth

Bearer

Headers

Body

{ "name": "ojludqci", "phone": "iqkiooldmnjob", "address": "opawypzddgcifjzlcokuopj", "email": "upton.bianka@example.com", "note": "et", "website": "uqgt", "siret": "wnpivqbnbhkiky", "contact_person_name": "emxghhvnqynyenvuclcv", "contact_person_phone_number": "qxeeqtdlm", "contact_person_email": "will.webster@example.net", "contact_person_occupation": "tcnuiewjowgnsiw", "contract_start_date": "2025-03-14T08:17:32", "contract_end_date": "2105-10-30", "classifications": [ "nulla" ] }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vendors/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ojludqci\",
    \"phone\": \"iqkiooldmnjob\",
    \"address\": \"opawypzddgcifjzlcokuopj\",
    \"email\": \"upton.bianka@example.com\",
    \"note\": \"et\",
    \"website\": \"uqgt\",
    \"siret\": \"wnpivqbnbhkiky\",
    \"contact_person_name\": \"emxghhvnqynyenvuclcv\",
    \"contact_person_phone_number\": \"qxeeqtdlm\",
    \"contact_person_email\": \"will.webster@example.net\",
    \"contact_person_occupation\": \"tcnuiewjowgnsiw\",
    \"contract_start_date\": \"2025-03-14T08:17:32\",
    \"contract_end_date\": \"2105-10-30\",
    \"classifications\": [
        \"nulla\"
    ]
}"

Get all vendors classifications without pagination

GET

http://fleet.test

/api/v1/fleet/vendors/classifications

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendors/classifications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update a vendor

POST

http://fleet.test

/api/v1/fleet/vendors/update/{vendor_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor_id

integer

required

The ID of the vendor.

Example:

Body Parameters

name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

iwhfqlxlpw

phone

string

required

Le texte de value ne peut contenir plus de 20 caractères.

Example:

wvvqrrw

address

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

nzunfjkivshlfrahsci

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

zboncak.helen@example.com

note

string

Example:

expedita

website

string

Must be a valid URL. Le texte de value ne peut contenir plus de 255 caractères.

Example:

rijkgwpbvjkpgqvmeci

siret

string

Le texte de value ne peut contenir plus de 14 caractères.

Example:

nnna

contact_person_name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

hbpibkghulvpegqyga

contact_person_phone_number

string

required

Le texte de value ne peut contenir plus de 20 caractères.

Example:

mhqjuo

contact_person_email

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

botsford.audreanne@example.net

contact_person_occupation

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

kjhynggrpoxstjmyyxzxsb

contract_start_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

contract_end_date

string

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au contract_start_date.

Example:

2066-07-03

classifications

string[]

required

Example:

["mollitia"]

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "iwhfqlxlpw", "phone": "wvvqrrw", "address": "nzunfjkivshlfrahsci", "email": "zboncak.helen@example.com", "note": "expedita", "website": "rijkgwpbvjkpgqvmeci", "siret": "nnna", "contact_person_name": "hbpibkghulvpegqyga", "contact_person_phone_number": "mhqjuo", "contact_person_email": "botsford.audreanne@example.net", "contact_person_occupation": "kjhynggrpoxstjmyyxzxsb", "contract_start_date": "2025-03-14T08:17:32", "contract_end_date": "2066-07-03", "classifications": [ "mollitia" ] }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vendors/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"iwhfqlxlpw\",
    \"phone\": \"wvvqrrw\",
    \"address\": \"nzunfjkivshlfrahsci\",
    \"email\": \"zboncak.helen@example.com\",
    \"note\": \"expedita\",
    \"website\": \"rijkgwpbvjkpgqvmeci\",
    \"siret\": \"nnna\",
    \"contact_person_name\": \"hbpibkghulvpegqyga\",
    \"contact_person_phone_number\": \"mhqjuo\",
    \"contact_person_email\": \"botsford.audreanne@example.net\",
    \"contact_person_occupation\": \"kjhynggrpoxstjmyyxzxsb\",
    \"contract_start_date\": \"2025-03-14T08:17:32\",
    \"contract_end_date\": \"2066-07-03\",
    \"classifications\": [
        \"mollitia\"
    ]
}"

Get vendor details

GET

http://fleet.test

/api/v1/fleet/vendors/show/{vendor}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor

string

required

Example:

sed

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendors/show/sed" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Add a document to a vendor

POST

http://fleet.test

/api/v1/fleet/vendors/{vendor}/documents

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

vendor

integer

required

The vendor.

Example:

Body Parameters

document

file

required

Must be a file. La taille du fichier de value ne peut pas dépasser 10240 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpD9E2.tmp

description

string

required

10MB max file size. Le texte de value ne peut contenir plus de 255 caractères.

Example:

Sunt quibusdam accusamus consequatur dolor.

file_name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

cpfffiqixqplpllohfcqfuv

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vendors/1/documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "description=Sunt quibusdam accusamus consequatur dolor."\
    --form "file_name=cpfffiqixqplpllohfcqfuv"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpD9E2.tmp"

Edit a document of a vendor

POST

http://fleet.test

/api/v1/fleet/vendors/{vendor}/documents/{document}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

vendor

integer

required

The vendor.

Example:

document

string

required

The document.

Example:

neque

Body Parameters

document

file

Must be a file. La taille du fichier de value ne peut pas dépasser 10240 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDA03.tmp

description

string

10MB max file size, optional. Le texte de value ne peut contenir plus de 255 caractères.

Example:

Ex omnis consequatur inventore aperiam soluta labore molestiae.

file_name

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

ygpjqtzedowmtbjypazaru

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vendors/1/documents/neque" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "description=Ex omnis consequatur inventore aperiam soluta labore molestiae."\
    --form "file_name=ygpjqtzedowmtbjypazaru"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpDA03.tmp"

get a document of a vendor

GET

http://fleet.test

/api/v1/fleet/vendors/{vendor}/documents/{document}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor

integer

required

The vendor.

Example:

document

string

required

The document.

Example:

aut

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendors/1/documents/aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Delete a document of a vendor

DELETE

http://fleet.test

/api/v1/fleet/vendors/{vendor}/documents/{document}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor

integer

required

The vendor.

Example:

document

string

required

The document.

Example:

sequi

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vendors/1/documents/sequi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get all documents of a specific vendor

GET

http://fleet.test

/api/v1/fleet/vendors/{vendor}/documents

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor

integer

required

The vendor.

Example:

Body Parameters

created_at

string

Must be a valid date in the format Y-m-d.

Example:

2025-03-14

Auth

Bearer

Headers

URL Parameters

Body

{ "created_at": "2025-03-14" }

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendors/1/documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"created_at\": \"2025-03-14\"
}"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all vehicles of a specific vendor

GET

http://fleet.test

/api/v1/fleet/vendors/{vendor}/vehicles

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor

integer

required

The vendor.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendors/1/vehicles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all entries of a specific vendor

GET

http://fleet.test

/api/v1/fleet/vendors/{vendor}/entries

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor

integer

required

The vendor.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vendors/1/entries" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Delete a vendor

DELETE

http://fleet.test

/api/v1/fleet/vendors/delete/{vendor_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor_id

integer

required

The ID of the vendor.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vendors/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get user vendors list without pagination

GET

http://fleet.test

/api/v1/fleet/uservendors/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/uservendors/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Link vendor

POST

http://fleet.test

/api/v1/fleet/uservendors/link

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vendor_id

string

required

Example:

quo

contact_person_name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

xldssjybuakoqxufsnddra

contact_person_phone_number

string

required

Le texte de value ne peut contenir plus de 20 caractères.

Example:

qgzclryaavzgzuo

contact_person_email

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

johathan.welch@example.org

contact_person_occupation

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

wsxrzwtvmnrt

contract_start_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

contract_end_date

string

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au contract_start_date.

Example:

2043-11-12

classifications

string[]

required

Example:

["quae"]

Auth

Bearer

Headers

Body

{ "vendor_id": "quo", "contact_person_name": "xldssjybuakoqxufsnddra", "contact_person_phone_number": "qgzclryaavzgzuo", "contact_person_email": "johathan.welch@example.org", "contact_person_occupation": "wsxrzwtvmnrt", "contract_start_date": "2025-03-14T08:17:32", "contract_end_date": "2043-11-12", "classifications": [ "quae" ] }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/uservendors/link" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vendor_id\": \"quo\",
    \"contact_person_name\": \"xldssjybuakoqxufsnddra\",
    \"contact_person_phone_number\": \"qgzclryaavzgzuo\",
    \"contact_person_email\": \"johathan.welch@example.org\",
    \"contact_person_occupation\": \"wsxrzwtvmnrt\",
    \"contract_start_date\": \"2025-03-14T08:17:32\",
    \"contract_end_date\": \"2043-11-12\",
    \"classifications\": [
        \"quae\"
    ]
}"

Update a linked vendor

POST

http://fleet.test

/api/v1/fleet/uservendors/link/update/{vendor_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor_id

integer

required

The ID of the vendor.

Example:

Body Parameters

contact_person_name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

duq

contact_person_phone_number

string

required

Le texte de value ne peut contenir plus de 20 caractères.

Example:

wiakzxzrxktzgzi

contact_person_email

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

aglae71@example.com

contact_person_occupation

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

tluw

contract_start_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

contract_end_date

string

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au contract_start_date.

Example:

2043-06-03

classifications

string[]

required

Example:

["esse"]

Auth

Bearer

Headers

URL Parameters

Body

{ "contact_person_name": "duq", "contact_person_phone_number": "wiakzxzrxktzgzi", "contact_person_email": "aglae71@example.com", "contact_person_occupation": "tluw", "contract_start_date": "2025-03-14T08:17:32", "contract_end_date": "2043-06-03", "classifications": [ "esse" ] }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/uservendors/link/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_person_name\": \"duq\",
    \"contact_person_phone_number\": \"wiakzxzrxktzgzi\",
    \"contact_person_email\": \"aglae71@example.com\",
    \"contact_person_occupation\": \"tluw\",
    \"contract_start_date\": \"2025-03-14T08:17:32\",
    \"contract_end_date\": \"2043-06-03\",
    \"classifications\": [
        \"esse\"
    ]
}"

Unlink a vendor

DELETE

http://fleet.test

/api/v1/fleet/uservendors/unlink/{vendor_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vendor_id

integer

required

The ID of the vendor.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/uservendors/unlink/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

18- Fuel History management

Get client fuel histories list

GET

http://fleet.test

/api/v1/fleet/fuelhistories/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/fuelhistories/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Export fuel histories table

GET

http://fleet.test

/api/v1/fleet/fuelhistories/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/fuelhistories/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

POST api/v1/fleet/fuelhistories/import

POST

http://fleet.test

/api/v1/fleet/fuelhistories/import

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/fuelhistories/import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get fuel history details

GET

http://fleet.test

/api/v1/fleet/fuelhistories/show/{fuelhistory}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

fuelhistory

string

required

Example:

tempora

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/fuelhistories/show/tempora" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a fuel history

POST

http://fleet.test

/api/v1/fleet/fuelhistories/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

vendor_id

string

required

Example:

qui

entry_date

string

required

Must be a valid date in the format Y-m-d.

Example:

2025-03-14

entry_hour

string

required

Must be a valid date in the format H:i.

Example:

08:17

odometer

number

La valeur de value doit être supérieure ou égale à 0.

Example:

liters

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

total_price

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

fuel_cost

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

is_partial_fuel_up

string

Must be one of:

true
false

Example:

true

reset_usage

string

Must be one of:

true
false

Example:

false

personal

string

Must be one of:

true
false

Example:

true

acceptance_point

string

Le texte de value ne peut contenir plus de 50 caractères.

Example:

iwrm

postal_code

string

Le champ value doit contenir 5 chiffres.

Example:

80121

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/fuelhistories/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=et"\
    --form "vendor_id=qui"\
    --form "entry_date=2025-03-14"\
    --form "entry_hour=08:17"\
    --form "odometer=55"\
    --form "liters=77"\
    --form "total_price=6"\
    --form "fuel_cost=71"\
    --form "is_partial_fuel_up=true"\
    --form "reset_usage=false"\
    --form "personal=true"\
    --form "acceptance_point=iwrm"\
    --form "postal_code=80121"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpDADF.tmp"

Update a fuel history

POST

http://fleet.test

/api/v1/fleet/fuelhistories/update/{fuelhistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

fuelhistory_id

integer

required

The ID of the fuelhistory.

Example:

Body Parameters

vehicle_id

string

vendor_id

string

entry_date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

entry_hour

string

Must be a valid date in the format H:i.

Example:

08:17

odometer

number

La valeur de value doit être supérieure ou égale à 0.

Example:

liters

number

La valeur de value doit être supérieure ou égale à 0.

Example:

total_price

number

La valeur de value doit être supérieure ou égale à 0.

Example:

fuel_cost

number

La valeur de value doit être supérieure ou égale à 0.

Example:

is_partial_fuel_up

string

Must be one of:

true
false

Example:

true

reset_usage

string

Must be one of:

true
false

Example:

false

acceptance_point

string

Le texte de value ne peut contenir plus de 50 caractères.

Example:

yfwewwcicp

postal_code

string

Le champ value doit contenir 5 chiffres.

Example:

60076

personal

string

Must be one of:

true
false

Example:

true

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/fuelhistories/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "entry_date=2025-03-14T08:17:32"\
    --form "entry_hour=08:17"\
    --form "odometer=78"\
    --form "liters=18"\
    --form "total_price=60"\
    --form "fuel_cost=89"\
    --form "is_partial_fuel_up=true"\
    --form "reset_usage=false"\
    --form "acceptance_point=yfwewwcicp"\
    --form "postal_code=60076"\
    --form "personal=true"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpDAF0.tmp"

Delete a fuel history

DELETE

http://fleet.test

/api/v1/fleet/fuelhistories/delete/{fuelhistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

fuelhistory_id

integer

required

The ID of the fuelhistory.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/fuelhistories/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

19- Charging History management

Get client charging histories list

GET

http://fleet.test

/api/v1/fleet/charginghistories/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/charginghistories/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get charging history details

GET

http://fleet.test

/api/v1/fleet/charginghistories/show/{charginghistory}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

charginghistory

string

required

Example:

iusto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/charginghistories/show/iusto" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a charging history

POST

http://fleet.test

/api/v1/fleet/charginghistories/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

vendor_id

string

required

Example:

chargin_started

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

chargin_ended

string

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au chargin_started.

Example:

2075-12-20

duration

integer

La valeur de value doit être supérieure ou égale à 0.

Example:

total_energy

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

energy_price

number

La valeur de value doit être supérieure ou égale à 0.

Example:

energy_cost

number

La valeur de value doit être supérieure ou égale à 0.

Example:

personal

string

Must be one of:

true
false

Example:

false

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/charginghistories/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=id"\
    --form "vendor_id=et"\
    --form "chargin_started=2025-03-14T08:17:32"\
    --form "chargin_ended=2075-12-20"\
    --form "duration=45"\
    --form "total_energy=29"\
    --form "energy_price=29"\
    --form "energy_cost=71"\
    --form "personal=false"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpDB1F.tmp"

Update a charging history

POST

http://fleet.test

/api/v1/fleet/charginghistories/update/{charginghistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

charginghistory_id

integer

required

The ID of the charginghistory.

Example:

Body Parameters

vehicle_id

string

vendor_id

string

chargin_started

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

chargin_ended

string

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au chargin_started.

Example:

2033-02-13

duration

integer

La valeur de value doit être supérieure ou égale à 0.

Example:

total_energy

number

La valeur de value doit être supérieure ou égale à 0.

Example:

energy_price

number

La valeur de value doit être supérieure ou égale à 0.

Example:

energy_cost

number

La valeur de value doit être supérieure ou égale à 0.

Example:

personal

string

Must be one of:

true
false

Example:

false

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/charginghistories/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "chargin_started=2025-03-14T08:17:32"\
    --form "chargin_ended=2033-02-13"\
    --form "duration=84"\
    --form "total_energy=52"\
    --form "energy_price=69"\
    --form "energy_cost=9"\
    --form "personal=false"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpDB30.tmp"

Delete a charging history

DELETE

http://fleet.test

/api/v1/fleet/charginghistories/delete/{charginghistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

charginghistory_id

integer

required

The ID of the charginghistory.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/charginghistories/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

20- Sinistre management

Get client sinistres list

GET

http://fleet.test

/api/v1/fleet/sinistres/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/sinistres/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get sinistre details

GET

http://fleet.test

/api/v1/fleet/sinistres/show/{sinistre}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

sinistre

string

required

Example:

consequuntur

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/sinistres/show/consequuntur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a sinistre

POST

http://fleet.test

/api/v1/fleet/sinistres/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

driver_id

string

vehicle_id

string

required

Example:

autem

date_of_accident

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

date_of_reparation

string

required

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure ou égale au date_of_accident.

Example:

2082-02-15

address

string

Example:

ipsum

city

string

Example:

eaque

postal_code

string

Example:

tempore

responsability

string

Must be one of:

Example:

status

string

Must be one of:

Example:

commentaire

string

Example:

est

document

file

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDB50.tmp

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/sinistres/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=autem"\
    --form "date_of_accident=2025-03-14T08:17:32"\
    --form "date_of_reparation=2082-02-15"\
    --form "address=ipsum"\
    --form "city=eaque"\
    --form "postal_code=tempore"\
    --form "responsability=F"\
    --form "status=W"\
    --form "commentaire=est"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpDB50.tmp"

Update a sinistre

POST

http://fleet.test

/api/v1/fleet/sinistres/update/{sinistre_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

sinistre_id

integer

required

The ID of the sinistre.

Example:

Body Parameters

driver_id

string

vehicle_id

string

required

Example:

eius

date_of_accident

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

date_of_reparation

string

required

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure ou égale au date_of_accident.

Example:

2116-02-05

address

string

Example:

city

string

Example:

postal_code

string

Example:

quos

responsability

string

Must be one of:

Example:

status

string

Must be one of:

Example:

commentaire

string

Example:

qui

document

file

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDB51.tmp

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/sinistres/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=eius"\
    --form "date_of_accident=2025-03-14T08:17:32"\
    --form "date_of_reparation=2116-02-05"\
    --form "address=id"\
    --form "city=in"\
    --form "postal_code=quos"\
    --form "responsability=S"\
    --form "status=R"\
    --form "commentaire=qui"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpDB51.tmp"

Delete a sinistre

DELETE

http://fleet.test

/api/v1/fleet/sinistres/delete/{sinistre_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

sinistre_id

integer

required

The ID of the sinistre.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/sinistres/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

21- Address management

Get distances and prices

POST

http://fleet.test

/api/v1/fleet/address/distances/{vehicle_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicle_id

integer

required

The ID of the vehicle.

Example:

Body Parameters

departure_lat

number

required

La valeur de value doit être comprise entre -90 et 90.

Example:

-89

departure_lng

number

required

La valeur de value doit être comprise entre -180 et 180.

Example:

-180

arrival_lat

number

required

La valeur de value doit être comprise entre -90 et 90.

Example:

-89

arrival_lng

number

required

La valeur de value doit être comprise entre -180 et 180.

Example:

-179

coming_lat

number

La valeur de value doit être comprise entre -90 et 90.

Example:

-89

coming_lng

number

La valeur de value doit être comprise entre -180 et 180.

Example:

-179

Auth

Bearer

Headers

URL Parameters

Body

{ "departure_lat": -89, "departure_lng": -180, "arrival_lat": -89, "arrival_lng": -179, "coming_lat": -89, "coming_lng": -179 }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/address/distances/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"departure_lat\": -89,
    \"departure_lng\": -180,
    \"arrival_lat\": -89,
    \"arrival_lng\": -179,
    \"coming_lat\": -89,
    \"coming_lng\": -179
}"

22- Dashboard

Get dashboard data

GET

http://fleet.test

/api/v1/fleet/dashboard

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/dashboard" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get dashboard preferences

GET

http://fleet.test

/api/v1/fleet/dashboard-preferences

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/dashboard-preferences" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update dashboard preference

POST

http://fleet.test

/api/v1/fleet/dashboard-preferences/update

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

cards_order

object

required

Example:

[]

cards_visibility

object

required

Example:

[]

Auth

Bearer

Headers

Body

{ "cards_order": [], "cards_visibility": [] }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/dashboard-preferences/update" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"cards_order\": [],
    \"cards_visibility\": []
}"

23- Custom Status Management

Get user custom statuses list

GET

http://fleet.test

/api/v1/fleet/customstatuses/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/customstatuses/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all custom statuses without pagination

GET

http://fleet.test

/api/v1/fleet/customstatuses/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/customstatuses/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get custom status details

GET

http://fleet.test

/api/v1/fleet/customstatuses/show/{customStatus_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

customStatus_id

integer

required

The ID of the customStatus.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/customstatuses/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a custom status

POST

http://fleet.test

/api/v1/fleet/customstatuses/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

label

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

atbldyhdhlqvghbitxufhhwi

color

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

description

string

Example:

Beatae qui deserunt dignissimos occaecati ab.

Auth

Bearer

Headers

Body

{ "label": "atbldyhdhlqvghbitxufhhwi", "color": "xk", "description": "Beatae qui deserunt dignissimos occaecati ab." }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/customstatuses/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"atbldyhdhlqvghbitxufhhwi\",
    \"color\": \"xk\",
    \"description\": \"Beatae qui deserunt dignissimos occaecati ab.\"
}"

Update a custom status

POST

http://fleet.test

/api/v1/fleet/customstatuses/update/{customStatus_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

customStatus_id

integer

required

The ID of the customStatus.

Example:

Body Parameters

label

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

bshzojebeg

color

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

description

string

Example:

Eaque pariatur et modi laboriosam quo iste.

Auth

Bearer

Headers

URL Parameters

Body

{ "label": "bshzojebeg", "color": "kz", "description": "Eaque pariatur et modi laboriosam quo iste." }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/customstatuses/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"bshzojebeg\",
    \"color\": \"kz\",
    \"description\": \"Eaque pariatur et modi laboriosam quo iste.\"
}"

Delete a custom status

DELETE

http://fleet.test

/api/v1/fleet/customstatuses/delete/{customStatus_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

customStatus_id

integer

required

The ID of the customStatus.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/customstatuses/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

24- Custom Motive Management

Get user custom motives list

GET

http://fleet.test

/api/v1/fleet/custommotives/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/custommotives/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all custom motives without pagination

GET

http://fleet.test

/api/v1/fleet/custommotives/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/custommotives/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get custom motive details

GET

http://fleet.test

/api/v1/fleet/custommotives/show/{customMotive_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

customMotive_id

integer

required

The ID of the customMotive.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/custommotives/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a custom motive

POST

http://fleet.test

/api/v1/fleet/custommotives/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

label

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

prezfvowmqf

color

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

olyulqalrkqkxato

description

string

Example:

Reprehenderit qui enim doloremque voluptas incidunt et quo.

Auth

Bearer

Headers

Body

{ "label": "prezfvowmqf", "color": "olyulqalrkqkxato", "description": "Reprehenderit qui enim doloremque voluptas incidunt et quo." }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/custommotives/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"prezfvowmqf\",
    \"color\": \"olyulqalrkqkxato\",
    \"description\": \"Reprehenderit qui enim doloremque voluptas incidunt et quo.\"
}"

Update a custom motive

POST

http://fleet.test

/api/v1/fleet/custommotives/update/{customMotive_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

customMotive_id

integer

required

The ID of the customMotive.

Example:

Body Parameters

label

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

kowtn

color

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

wtt

description

string

Example:

Cupiditate aut ut ut rem aliquam animi.

Auth

Bearer

Headers

URL Parameters

Body

{ "label": "kowtn", "color": "wtt", "description": "Cupiditate aut ut ut rem aliquam animi." }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/custommotives/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"kowtn\",
    \"color\": \"wtt\",
    \"description\": \"Cupiditate aut ut ut rem aliquam animi.\"
}"

Delete a custom motive

DELETE

http://fleet.test

/api/v1/fleet/custommotives/delete/{customMotive_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

customMotive_id

integer

required

The ID of the customMotive.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/custommotives/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

25- Employee management

Get client employees list

GET

http://fleet.test

/api/v1/fleet/employees/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/employees/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Export employees table

GET

http://fleet.test

/api/v1/fleet/employees/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/employees/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all employees without pagination

GET

http://fleet.test

/api/v1/fleet/employees/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/employees/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get employee details

GET

http://fleet.test

/api/v1/fleet/employees/show/{user_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/employees/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get employee vehicle assignments

GET

http://fleet.test

/api/v1/fleet/employees/{user_id}/vehicleassignments

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/employees/1/vehicleassignments" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get employee assigned issues

GET

http://fleet.test

/api/v1/fleet/employees/{user_id}/issues

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/employees/1/issues" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get employee documents

GET

http://fleet.test

/api/v1/fleet/employees/{user_id}/documents

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/employees/1/documents" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Delete an employee

DELETE

http://fleet.test

/api/v1/fleet/employees/delete/{user_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/employees/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

26- Infraction management

Store infraction designation

POST

http://fleet.test

/api/v1/fleet/infractions/{infraction_id}/designate

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

infraction_id

integer

required

The ID of the infraction.

Example:

158

Body Parameters

fleet_name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

kqynlvoocvjdrogfxmsq

fleet_siret

string

required

Le champ value doit contenir 14 chiffres.

Example:

32411514794737

fleet_email

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

kessler.jasper@example.org

fleet_address

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

lthfffpiu

fleet_postal_code

string

required

Le texte de value ne peut contenir plus de 10 caractères.

Example:

dqbqjllo

fleet_city

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

fleet_country

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

iegeiunkytucmiu

driver_id

string

driver_title

string

required

Le texte de value ne peut contenir plus de 10 caractères.

Example:

yrdllqfo

driver_civility

string

required

Must be one of:

Mr
Mrs
Ms

Example:

Mrs

driver_lastname

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

wftfrxtshfcilvqdooutfwu

driver_firstname

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

wjirjnfdfcewzqibufe

driver_birth_date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

driver_birth_place

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

ainhwrhfaditklxp

driver_email

string

required

Le champ value doit être une adresse e-mail valide. Le texte de value ne peut contenir plus de 255 caractères.

Example:

collins.ara@example.net

driver_address

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

baifgoaiomijptmybkqmjcq

driver_postal_code

string

required

Le texte de value ne peut contenir plus de 10 caractères.

Example:

zfdkcxjxru

driver_city

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

vqwcqequbtzjniytpy

driver_country

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

yxnvwmiu

license_number

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

nfacnvrp

license_issue_date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:32

license_issue_place

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

upeekecuq

Auth

Bearer

Headers

URL Parameters

Body

{ "fleet_name": "kqynlvoocvjdrogfxmsq", "fleet_siret": "32411514794737", "fleet_email": "kessler.jasper@example.org", "fleet_address": "lthfffpiu", "fleet_postal_code": "dqbqjllo", "fleet_city": "q", "fleet_country": "iegeiunkytucmiu", "driver_id": null, "driver_title": "yrdllqfo", "driver_civility": "Mrs", "driver_lastname": "wftfrxtshfcilvqdooutfwu", "driver_firstname": "wjirjnfdfcewzqibufe", "driver_birth_date": "2025-03-14T08:17:32", "driver_birth_place": "ainhwrhfaditklxp", "driver_email": "collins.ara@example.net", "driver_address": "baifgoaiomijptmybkqmjcq", "driver_postal_code": "zfdkcxjxru", "driver_city": "vqwcqequbtzjniytpy", "driver_country": "yxnvwmiu", "license_number": "nfacnvrp", "license_issue_date": "2025-03-14T08:17:32", "license_issue_place": "upeekecuq" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/infractions/158/designate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"fleet_name\": \"kqynlvoocvjdrogfxmsq\",
    \"fleet_siret\": \"32411514794737\",
    \"fleet_email\": \"kessler.jasper@example.org\",
    \"fleet_address\": \"lthfffpiu\",
    \"fleet_postal_code\": \"dqbqjllo\",
    \"fleet_city\": \"q\",
    \"fleet_country\": \"iegeiunkytucmiu\",
    \"driver_title\": \"yrdllqfo\",
    \"driver_civility\": \"Mrs\",
    \"driver_lastname\": \"wftfrxtshfcilvqdooutfwu\",
    \"driver_firstname\": \"wjirjnfdfcewzqibufe\",
    \"driver_birth_date\": \"2025-03-14T08:17:32\",
    \"driver_birth_place\": \"ainhwrhfaditklxp\",
    \"driver_email\": \"collins.ara@example.net\",
    \"driver_address\": \"baifgoaiomijptmybkqmjcq\",
    \"driver_postal_code\": \"zfdkcxjxru\",
    \"driver_city\": \"vqwcqequbtzjniytpy\",
    \"driver_country\": \"yxnvwmiu\",
    \"license_number\": \"nfacnvrp\",
    \"license_issue_date\": \"2025-03-14T08:17:32\",
    \"license_issue_place\": \"upeekecuq\"
}"

Get client infractions list

GET

http://fleet.test

/api/v1/fleet/infractions/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/infractions/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get infraction details

GET

http://fleet.test

/api/v1/fleet/infractions/show/{infraction_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

infraction_id

integer

required

The ID of the infraction.

Example:

158

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/infractions/show/158" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Check Fleet for infraction

GET

http://fleet.test

/api/v1/fleet/infractions/fleet/{infraction_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

infraction_id

integer

required

The ID of the infraction.

Example:

158

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/infractions/fleet/158" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Delete infraction

DELETE

http://fleet.test

/api/v1/fleet/infractions/delete/{infraction_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

infraction_id

integer

required

The ID of the infraction.

Example:

158

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/infractions/delete/158" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

27- UploadedDocument management

Get Uploaded documents list

GET

http://fleet.test

/api/v1/fleet/uploadeddocuments/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/uploadeddocuments/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get Uploaded Document details

GET

http://fleet.test

/api/v1/fleet/uploadeddocuments/show/{uploadedDocument}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uploadedDocument

string

required

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/uploadeddocuments/show/ea" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an uploaded document

POST

http://fleet.test

/api/v1/fleet/uploadeddocuments/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

type

string

required

Must be one of:

CG
CJ
CA
CL
CT
D

Example:

vehicle_id

string

required

Example:

perspiciatis

provider_id

integer

Example:

vendor_id

string

required

Example:

sed

document

file

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDCC9.tmp

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/uploadeddocuments/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "type=CT"\
    --form "vehicle_id=perspiciatis"\
    --form "provider_id=2"\
    --form "vendor_id=sed"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpDCC9.tmp"

Update an uploaded document

POST

http://fleet.test

/api/v1/fleet/uploadeddocuments/update/{uploadedDocument_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

uploadedDocument_id

integer

required

The ID of the uploadedDocument.

Example:

Body Parameters

provider_id

integer

Example:

vendor_id

string

required

Example:

debitis

document

file

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDCDA.tmp

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/uploadeddocuments/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "provider_id=3"\
    --form "vendor_id=debitis"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpDCDA.tmp"

Delete an uploaded document

DELETE

http://fleet.test

/api/v1/fleet/uploadeddocuments/delete/{uploadedDocument_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

uploadedDocument_id

integer

required

The ID of the uploadedDocument.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/uploadeddocuments/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/expenses/analyze

POST

http://fleet.test

/api/v1/fleet/expenses/analyze

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

invoice

file

required

Must be a file. La taille du fichier de value ne peut pas dépasser 10240 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDD0A.tmp

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/expenses/analyze" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "invoice=@C:\Users\21355\AppData\Local\Temp\phpDD0A.tmp"

28- Expense management

Get expense types list

GET

http://fleet.test

/api/v1/fleet/expenses/types

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/expenses/types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get client expenses list

GET

http://fleet.test

/api/v1/fleet/expenses/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/expenses/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Export expenses table

GET

http://fleet.test

/api/v1/fleet/expenses/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/expenses/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get expense details

GET

http://fleet.test

/api/v1/fleet/expenses/show/{expense}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

expense

string

required

Example:

error

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/expenses/show/error" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store an expense

POST

http://fleet.test

/api/v1/fleet/expenses/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vendor_id

string

required

Example:

qui

expense_type_id

string

required

Example:

nihil

amount_ht

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

amount

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

recurrent_expense

string

Must be one of:

true
false

Example:

true

date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:33

start_date

string

Le champ value n'est pas une date valide. This field is required when recurrent_expense is true.

Example:

2025-03-14T08:17:33

end_date

string

Le champ value n'est pas une date valide. This field is required when recurrent_expense is true. Le champ value doit être une date postérieure ou égale au start_date.

Example:

2115-12-29

frequency

string

This field is required when recurrent_expense is true.

Must be one of:

Example:

amount_type

integer

required

Must be one of:

Example:

notes

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

ygmxpzlxqyjobppme

select_all

string

Example:

voluptas

vehicles

string[]

required

Example:

["maiores"]

invoice_number

string

This field is required when invoice is present.

Example:

commodi

invoice

file

Must be a file. This field is required when invoice_number is present. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDD1B.tmp

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/expenses/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vendor_id=qui"\
    --form "expense_type_id=nihil"\
    --form "amount_ht=28"\
    --form "amount=32"\
    --form "recurrent_expense=true"\
    --form "date=2025-03-14T08:17:33"\
    --form "start_date=2025-03-14T08:17:33"\
    --form "end_date=2115-12-29"\
    --form "frequency=M"\
    --form "amount_type=1"\
    --form "notes=ygmxpzlxqyjobppme"\
    --form "select_all=voluptas"\
    --form "vehicles[]=maiores"\
    --form "invoice_number=commodi"\
    --form "invoice=@C:\Users\21355\AppData\Local\Temp\phpDD1B.tmp" \
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpDD2C.tmp"

Update an expense

POST

http://fleet.test

/api/v1/fleet/expenses/update/{expense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

expense_id

integer

required

The ID of the expense.

Example:

Body Parameters

vendor_id

string

required

Example:

debitis

expense_type_id

string

required

Example:

aliquam

amount_ht

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

amount

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

invoice_number

string

Example:

aut

date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:33

end_date

string

Le champ value n'est pas une date valide. This field is required when recurrent_expense is true. Le champ value doit être une date postérieure ou égale au start_date.

Example:

2026-09-27

frequency

string

This field is required when recurrent_expense is true.

Must be one of:

Example:

amount_type

integer

required

Must be one of:

Example:

notes

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

kkweaxkqkhkvjwcvmtzrdrna

select_all

string

Example:

tempore

vehicles

string[]

required

Example:

["sit"]

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/expenses/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vendor_id=debitis"\
    --form "expense_type_id=aliquam"\
    --form "amount_ht=82"\
    --form "amount=66"\
    --form "invoice_number=aut"\
    --form "date=2025-03-14T08:17:33"\
    --form "end_date=2026-09-27"\
    --form "frequency=M"\
    --form "amount_type=1"\
    --form "notes=kkweaxkqkhkvjwcvmtzrdrna"\
    --form "select_all=tempore"\
    --form "vehicles[]=sit"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpDD3D.tmp"

Delete an expense

DELETE

http://fleet.test

/api/v1/fleet/expenses/delete/{expense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

expense_id

integer

required

The ID of the expense.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/expenses/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

29- Mobility Expense management

Get mobility expense types list

GET

http://fleet.test

/api/v1/fleet/mobilityexpenses/types

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/mobilityexpenses/types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get client mobility expenses list

GET

http://fleet.test

/api/v1/fleet/mobilityexpenses/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/mobilityexpenses/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Export mobility expenses table

GET

http://fleet.test

/api/v1/fleet/mobilityexpenses/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/mobilityexpenses/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get mobility expense details

GET

http://fleet.test

/api/v1/fleet/mobilityexpenses/show/{mobilityExpense}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mobilityExpense

string

required

Example:

hic

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/mobilityexpenses/show/hic" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a mobility expense

POST

http://fleet.test

/api/v1/fleet/mobilityexpenses/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

employee_id

string

required

Example:

sint

mobility_expense_type_id

string

required

Example:

facilis

amount_ht

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

amount

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

recurrent_expense

string

required

Must be one of:

true
false

Example:

true

date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:33

start_date

string

Le champ value n'est pas une date valide. This field is required when recurrent_expense is true.

Example:

2025-03-14T08:17:33

end_date

string

Le champ value n'est pas une date valide. This field is required when recurrent_expense is true. Le champ value doit être une date postérieure ou égale au start_date.

Example:

2025-10-12

frequency

string

This field is required when recurrent_expense is true.

Must be one of:

Example:

notes

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/mobilityexpenses/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "employee_id=sint"\
    --form "mobility_expense_type_id=facilis"\
    --form "amount_ht=69"\
    --form "amount=30"\
    --form "recurrent_expense=true"\
    --form "date=2025-03-14T08:17:33"\
    --form "start_date=2025-03-14T08:17:33"\
    --form "end_date=2025-10-12"\
    --form "frequency=Y"\
    --form "notes=y"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpDD7C.tmp"

Update a mobility expense

POST

http://fleet.test

/api/v1/fleet/mobilityexpenses/update/{mobilityExpense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

mobilityExpense_id

integer

required

The ID of the mobilityExpense.

Example:

Body Parameters

employee_id

string

required

Example:

impedit

mobility_expense_type_id

string

required

Example:

est

amount_ht

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

amount

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

date

string

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:33

start_date

string

Le champ value n'est pas une date valide. This field is required when recurrent_expense is true.

Example:

2025-03-14T08:17:33

end_date

string

Le champ value n'est pas une date valide. This field is required when recurrent_expense is true. Le champ value doit être une date postérieure ou égale au start_date.

Example:

2095-11-29

frequency

string

This field is required when recurrent_expense is true.

Must be one of:

Example:

notes

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

lwhdxbqsrsjcqaunebibei

documents

file[]

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/mobilityexpenses/update/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "employee_id=impedit"\
    --form "mobility_expense_type_id=est"\
    --form "amount_ht=38"\
    --form "amount=14"\
    --form "date=2025-03-14T08:17:33"\
    --form "start_date=2025-03-14T08:17:33"\
    --form "end_date=2095-11-29"\
    --form "frequency=M"\
    --form "notes=lwhdxbqsrsjcqaunebibei"\
    --form "documents[]=@C:\Users\21355\AppData\Local\Temp\phpDD8D.tmp"

Delete a mobility expense

DELETE

http://fleet.test

/api/v1/fleet/mobilityexpenses/delete/{mobilityExpense_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mobilityExpense_id

integer

required

The ID of the mobilityExpense.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/mobilityexpenses/delete/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

30- Notifications management

Get user notifications list.

GET

http://fleet.test

/api/v1/fleet/notification/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/notification/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

31- Settings management

Get user profile

GET

http://fleet.test

/api/v1/fleet/settings/userprofile

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/userprofile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update user profile

POST

http://fleet.test

/api/v1/fleet/settings/userprofile

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

first_name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

azkirdbd

last_name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

fcdkmhuprk

string

required

Le champ value doit être une adresse e-mail valide.

Example:

sydney.considine@example.com

phone

string

required

Le texte value doit contenir au moins 10 caractères. Le texte de value ne peut contenir plus de 20 caractères.

Example:

mnytrjyslgjapjueln

profile_picture

file

Le champ value doit être une image. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDDBD.tmp

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/userprofile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "first_name=azkirdbd"\
    --form "last_name=fcdkmhuprk"\
    --form "email=sydney.considine@example.com"\
    --form "phone=mnytrjyslgjapjueln"\
    --form "profile_picture=@C:\Users\21355\AppData\Local\Temp\phpDDBD.tmp"

Get company profile

GET

http://fleet.test

/api/v1/fleet/settings/companyprofile

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/companyprofile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update company profile

POST

http://fleet.test

/api/v1/fleet/settings/companyprofile

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

name

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

ullnchaqiexd

siret

string

Le texte de value ne peut contenir plus de 14 caractères.

Example:

mnuiweuhsyigx

logo

file

Must be a file. La taille du fichier de value ne peut pas dépasser 1024 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDDCD.tmp

address

string

Le texte de value ne peut contenir plus de 255 caractères.

Example:

oycbywcxpkscxanqleqacjbln

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/companyprofile" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=ullnchaqiexd"\
    --form "siret=mnuiweuhsyigx"\
    --form "address=oycbywcxpkscxanqleqacjbln"\
    --form "logo=@C:\Users\21355\AppData\Local\Temp\phpDDCD.tmp"

Get user language

GET

http://fleet.test

/api/v1/fleet/settings/userlanguage

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/userlanguage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update user language

POST

http://fleet.test

/api/v1/fleet/settings/userlanguage

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

preferred_language

string

required

Must be one of:

FR
EN

Example:

Auth

Bearer

Headers

Body

{ "preferred_language": "FR" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/userlanguage" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"preferred_language\": \"FR\"
}"

Get company billing information

GET

http://fleet.test

/api/v1/fleet/settings/companybilling

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/companybilling" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update company billing information

POST

http://fleet.test

/api/v1/fleet/settings/companybilling

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

billing_address

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

vcrirbvrdsvvpf

Auth

Bearer

Headers

Body

{ "billing_address": "vcrirbvrdsvvpf" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/companybilling" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"billing_address\": \"vcrirbvrdsvvpf\"
}"

Get user 2fa

GET

http://fleet.test

/api/v1/fleet/settings/user2fa

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/user2fa" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update user language

POST

http://fleet.test

/api/v1/fleet/settings/user2fa

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

enable_2fa

boolean

required

Auth

Bearer

Headers

Body

{ "enable_2fa": false }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/user2fa" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"enable_2fa\": false
}"

Send reset password

POST

http://fleet.test

/api/v1/fleet/settings/send-otp-reset-password

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/send-otp-reset-password" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Reset password

POST

http://fleet.test

/api/v1/fleet/settings/reset-password

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

old_password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

nmbrmuayvgzwvqpbfvc

password

string

required

Le texte value doit contenir au moins 8 caractères. Le texte de value ne peut contenir plus de 255 caractères.

Example:

=!wZe]F9gV,;XWNjo3

Auth

Bearer

Headers

Body

{ "old_password": "nmbrmuayvgzwvqpbfvc", "password": "=!wZe]F9gV,;XWNjo3" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/reset-password" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"old_password\": \"nmbrmuayvgzwvqpbfvc\",
    \"password\": \"=!wZe]F9gV,;XWNjo3\"
}"

Verify OTP

POST

http://fleet.test

/api/v1/fleet/settings/verify-otp

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

uuid

string

required

Must be a valid UUID.

Example:

0af4841f-4428-3056-be72-5fed93ffffda

otp

string

required

Le texte value doit contenir au moins 6 caractères. Le texte de value ne peut contenir plus de 6 caractères.

Example:

otrgck

Auth

Bearer

Headers

Body

{ "uuid": "0af4841f-4428-3056-be72-5fed93ffffda", "otp": "otrgck" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/verify-otp" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"0af4841f-4428-3056-be72-5fed93ffffda\",
    \"otp\": \"otrgck\"
}"

Get company subscription & invoices

GET

http://fleet.test

/api/v1/fleet/settings/companysubinvoices

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/companysubinvoices" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Update company subscription

POST

http://fleet.test

/api/v1/fleet/settings/companysubinvoices

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

subscription_plan_id

string

required

Example:

nulla

Auth

Bearer

Headers

Body

{ "subscription_plan_id": "nulla" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/companysubinvoices" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"subscription_plan_id\": \"nulla\"
}"

GET api/v1/fleet/settings/companyprivatemode

GET

http://fleet.test

/api/v1/fleet/settings/companyprivatemode

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/companyprivatemode" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

POST api/v1/fleet/settings/companyprivatemode

POST

http://fleet.test

/api/v1/fleet/settings/companyprivatemode

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

private_mode

boolean

required

Example:

schedules

object[]

This field is required when private_mode is true.

day_of_week

integer

required

La valeur de value doit être comprise entre 0 et 6.

Example:

is_active

boolean

required

Example:

time_ranges

object[]

This field is required when schedules.*.is_active is true.

Auth

Bearer

Headers

Body

{ "private_mode": true, "schedules": [ { "day_of_week": 0, "is_active": true, "time_ranges": [ { "start_time": "08:17", "end_time": "2103-11-12" } ] } ] }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/companyprivatemode" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"private_mode\": true,
    \"schedules\": [
        {
            \"day_of_week\": 0,
            \"is_active\": true,
            \"time_ranges\": [
                {
                    \"start_time\": \"08:17\",
                    \"end_time\": \"2103-11-12\"
                }
            ]
        }
    ]
}"

Switch add vehicles in antai

PUT

http://fleet.test

/api/v1/fleet/settings/switchantai

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request PUT \
    "http://fleet.test/api/v1/fleet/settings/switchantai" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get add vehicles in antai

GET

http://fleet.test

/api/v1/fleet/settings/antai

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/antai" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/settings/companycreditcard/show/{creditCardId}

GET

http://fleet.test

/api/v1/fleet/settings/companycreditcard/show/{creditCardId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

creditCardId

string

required

Example:

blanditiis

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/companycreditcard/show/blanditiis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/settings/companycreditcard/hide/{creditCardId}

GET

http://fleet.test

/api/v1/fleet/settings/companycreditcard/hide/{creditCardId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

creditCardId

string

required

Example:

unde

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/settings/companycreditcard/hide/unde" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

POST api/v1/fleet/settings/companycreditcard/update/{creditCardId}

POST

http://fleet.test

/api/v1/fleet/settings/companycreditcard/update/{creditCardId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

creditCardId

string

required

Example:

sunt

Body Parameters

name_on_card

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

aygo

card_number

string

required

Le champ value doit contenir entre 13 et 19 chiffres.

Example:

9352326521340526

cvv

string

required

Le champ value doit contenir entre 3 et 4 chiffres.

Example:

6214

exp_date

string

required

Must be a valid date in the format Y-m. Le champ value doit être une date postérieure au today.

Example:

2072-04-09

Auth

Bearer

Headers

URL Parameters

Body

{ "name_on_card": "aygo", "card_number": "9352326521340526", "cvv": "6214", "exp_date": "2072-04-09" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/companycreditcard/update/sunt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_on_card\": \"aygo\",
    \"card_number\": \"9352326521340526\",
    \"cvv\": \"6214\",
    \"exp_date\": \"2072-04-09\"
}"

DELETE api/v1/fleet/settings/companycreditcard/delete/{creditCardId}

DELETE

http://fleet.test

/api/v1/fleet/settings/companycreditcard/delete/{creditCardId}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

creditCardId

string

required

Example:

non

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/settings/companycreditcard/delete/non" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST api/v1/fleet/settings/companycreditcard/create

POST

http://fleet.test

/api/v1/fleet/settings/companycreditcard/create

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name_on_card

string

required

Le texte de value ne peut contenir plus de 255 caractères.

Example:

qzzpehlrnturn

card_number

string

required

Le champ value doit contenir entre 13 et 19 chiffres.

Example:

7395757692891378

cvv

string

required

Le champ value doit contenir entre 3 et 4 chiffres.

Example:

563

exp_date

string

required

Must be a valid date in the format Y-m. Le champ value doit être une date postérieure au today.

Example:

2049-02-17

Auth

Bearer

Headers

Body

{ "name_on_card": "qzzpehlrnturn", "card_number": "7395757692891378", "cvv": "563", "exp_date": "2049-02-17" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/settings/companycreditcard/create" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name_on_card\": \"qzzpehlrnturn\",
    \"card_number\": \"7395757692891378\",
    \"cvv\": \"563\",
    \"exp_date\": \"2049-02-17\"
}"

32- Document management

Delete a document

DELETE

http://fleet.test

/api/v1/fleet/documents/delete/{document_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

document_id

integer

required

The ID of the document.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/documents/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

GET api/v1/fleet/documents/invoices/vehicle

GET

http://fleet.test

/api/v1/fleet/documents/invoices/vehicle

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/documents/invoices/vehicle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

GET api/v1/fleet/documents/invoices/mobility

GET

http://fleet.test

/api/v1/fleet/documents/invoices/mobility

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/documents/invoices/mobility" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

33- TechnicalControl management

Get Technical controls list

GET

http://fleet.test

/api/v1/fleet/technicalcontrols/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/technicalcontrols/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get Technical control details

GET

http://fleet.test

/api/v1/fleet/technicalcontrols/show/{technicalControl}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

technicalControl

string

required

Example:

voluptas

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/technicalcontrols/show/voluptas" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a technical control

POST

http://fleet.test

/api/v1/fleet/technicalcontrols/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

saepe

provider_id

integer

required

Example:

document

file

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDEA9.tmp

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/technicalcontrols/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "vehicle_id=saepe"\
    --form "provider_id=7"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpDEA9.tmp"

Update a technical control

POST

http://fleet.test

/api/v1/fleet/technicalcontrols/update/{technicalControl_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

technicalControl_id

integer

required

The ID of the technicalControl.

Example:

Body Parameters

provider_id

integer

required

Example:

document

file

Must be a file. La taille du fichier de value ne peut pas dépasser 2048 kilo-octets.

Example:

C:\Users\21355\AppData\Local\Temp\phpDEAA.tmp

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/technicalcontrols/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "provider_id=6"\
    --form "document=@C:\Users\21355\AppData\Local\Temp\phpDEAA.tmp"

Delete a technical control

DELETE

http://fleet.test

/api/v1/fleet/technicalcontrols/delete/{technicalControl_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

technicalControl_id

integer

required

The ID of the technicalControl.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/technicalcontrols/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

34- Sensor Alert management

Get sensor alerts list

GET

http://fleet.test

/api/v1/fleet/sensoralerts/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/sensoralerts/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

35- Device management

Get all company devices without pagination

GET

http://fleet.test

/api/v1/fleet/devices/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/devices/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

36- Vehicle Reminder management

Get client vehicle reminders list

GET

http://fleet.test

/api/v1/fleet/vehiclereminders/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehiclereminders/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get vehicle reminder details

GET

http://fleet.test

/api/v1/fleet/vehiclereminders/show/{vehiclereminder}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehiclereminder

string

required

Example:

sapiente

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehiclereminders/show/sapiente" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a vehicle reminder

POST

http://fleet.test

/api/v1/fleet/vehiclereminders/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

esse

type

string

required

Must be one of:

Example:

due_date

string

required

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au today.

Example:

2064-08-20

remind_before

integer

required

La valeur de value doit être supérieure ou égale à 1.

Example:

remind_before_unit

string

required

Must be one of:

Example:

responsable_id

string

enable_notifications

boolean

comment

string

Example:

quis

Auth

Bearer

Headers

Body

{ "vehicle_id": "esse", "type": "I", "due_date": "2064-08-20", "remind_before": 12, "remind_before_unit": "Y", "responsable_id": null, "enable_notifications": false, "comment": "quis" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehiclereminders/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"esse\",
    \"type\": \"I\",
    \"due_date\": \"2064-08-20\",
    \"remind_before\": 12,
    \"remind_before_unit\": \"Y\",
    \"enable_notifications\": false,
    \"comment\": \"quis\"
}"

Update a vehicle reminder

POST

http://fleet.test

/api/v1/fleet/vehiclereminders/update/{vehiclereminder_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehiclereminder_id

integer

required

The ID of the vehiclereminder.

Example:

Body Parameters

vehicle_id

string

required

Example:

type

string

required

Must be one of:

Example:

due_date

string

required

Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au today.

Example:

2080-11-28

remind_before

integer

required

La valeur de value doit être supérieure ou égale à 1.

Example:

remind_before_unit

string

required

Must be one of:

Example:

responsable_id

string

enable_notifications

boolean

comment

string

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "vehicle_id": "ad", "type": "T", "due_date": "2080-11-28", "remind_before": 62, "remind_before_unit": "M", "responsable_id": null, "enable_notifications": false, "comment": "et" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehiclereminders/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"ad\",
    \"type\": \"T\",
    \"due_date\": \"2080-11-28\",
    \"remind_before\": 62,
    \"remind_before_unit\": \"M\",
    \"enable_notifications\": false,
    \"comment\": \"et\"
}"

Delete a vehicle reminder

DELETE

http://fleet.test

/api/v1/fleet/vehiclereminders/delete/{vehiclereminder_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehiclereminder_id

integer

required

The ID of the vehiclereminder.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vehiclereminders/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Close a vehicle reminder

DELETE

http://fleet.test

/api/v1/fleet/vehiclereminders/close/{vehiclereminder_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehiclereminder_id

integer

required

The ID of the vehiclereminder.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vehiclereminders/close/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

37- Meter History management

Get client meter histories list

GET

http://fleet.test

/api/v1/fleet/meterhistories/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/meterhistories/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Export meter histories table

GET

http://fleet.test

/api/v1/fleet/meterhistories/export

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/meterhistories/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get meter history details

GET

http://fleet.test

/api/v1/fleet/meterhistories/show/{meterhistory}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

meterhistory

string

required

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/meterhistories/show/ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a meter history

POST

http://fleet.test

/api/v1/fleet/meterhistories/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

voluptatem

meter

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

meter_date

string

required

Le champ value n'est pas une date valide.

Example:

2025-03-14T08:17:33

Auth

Bearer

Headers

Body

{ "vehicle_id": "voluptatem", "meter": 3, "meter_date": "2025-03-14T08:17:33" }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/meterhistories/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"voluptatem\",
    \"meter\": 3,
    \"meter_date\": \"2025-03-14T08:17:33\"
}"

Update a meter history

POST

http://fleet.test

/api/v1/fleet/meterhistories/update/{meterhistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

meterhistory_id

integer

required

The ID of the meterhistory.

Example:

Body Parameters

meter

number

required

La valeur de value doit être supérieure ou égale à 0.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "meter": 34 }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/meterhistories/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"meter\": 34
}"

Delete a meter history

DELETE

http://fleet.test

/api/v1/fleet/meterhistories/delete/{meterhistory_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

meterhistory_id

integer

required

The ID of the meterhistory.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/meterhistories/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

38- Vehicle Assignment management

GET api/v1/fleet/vehicleassignments/table/list

GET

http://fleet.test

/api/v1/fleet/vehicleassignments/table/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicleassignments/table/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get client vehicle assignments list

GET

http://fleet.test

/api/v1/fleet/vehicleassignments/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicleassignments/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get vehicle assignment details

GET

http://fleet.test

/api/v1/fleet/vehicleassignments/show/{vehicleassignment}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicleassignment

string

required

Example:

quia

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/vehicleassignments/show/quia" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a vehicle assignment

POST

http://fleet.test

/api/v1/fleet/vehicleassignments/store

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

vehicle_id

string

required

Example:

quo

driver_id

string

required

Example:

nulla

start_date

string

required

Must be a valid date in the format Y-m-d.

Example:

2025-03-14

start_time

string

required

Must be a valid date in the format H:i.

Example:

08:17

end_date

string

Must be a valid date in the format Y-m-d.

Example:

2025-03-14

end_time

string

Must be a valid date in the format H:i. This field is required when end_date is present.

Example:

08:17

odometer

number

La valeur de value doit être supérieure ou égale à 0.

Example:

Auth

Bearer

Headers

Body

{ "vehicle_id": "quo", "driver_id": "nulla", "start_date": "2025-03-14", "start_time": "08:17", "end_date": "2025-03-14", "end_time": "08:17", "odometer": 73 }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicleassignments/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"quo\",
    \"driver_id\": \"nulla\",
    \"start_date\": \"2025-03-14\",
    \"start_time\": \"08:17\",
    \"end_date\": \"2025-03-14\",
    \"end_time\": \"08:17\",
    \"odometer\": 73
}"

Unassign a vehicle

POST

http://fleet.test

/api/v1/fleet/vehicleassignments/unassign/{vehicleassignment_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicleassignment_id

integer

required

The ID of the vehicleassignment.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicleassignments/unassign/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update a vehicle assignment

POST

http://fleet.test

/api/v1/fleet/vehicleassignments/update/{vehicleassignment_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicleassignment_id

integer

required

The ID of the vehicleassignment.

Example:

Body Parameters

vehicle_id

string

required

Example:

sit

driver_id

string

required

Example:

start_date

string

required

Must be a valid date in the format Y-m-d.

Example:

2025-03-14

start_time

string

required

Must be a valid date in the format H:i.

Example:

08:17

end_date

string

Must be a valid date in the format Y-m-d.

Example:

2025-03-14

end_time

string

Must be a valid date in the format H:i. This field is required when end_date is present.

Example:

08:17

odometer

number

La valeur de value doit être supérieure ou égale à 0.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "vehicle_id": "sit", "driver_id": "et", "start_date": "2025-03-14", "start_time": "08:17", "end_date": "2025-03-14", "end_time": "08:17", "odometer": 83 }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/vehicleassignments/update/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"vehicle_id\": \"sit\",
    \"driver_id\": \"et\",
    \"start_date\": \"2025-03-14\",
    \"start_time\": \"08:17\",
    \"end_date\": \"2025-03-14\",
    \"end_time\": \"08:17\",
    \"odometer\": 83
}"

Delete a vehicle assignment

DELETE

http://fleet.test

/api/v1/fleet/vehicleassignments/delete/{vehicleassignment_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

vehicleassignment_id

integer

required

The ID of the vehicleassignment.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/vehicleassignments/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

39- Inspections management

Display a listing of the inspections.

GET

http://fleet.test

/api/v1/fleet/inspections/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspections/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Display the inspection details.

GET

http://fleet.test

/api/v1/fleet/inspections/show/{inspection_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_id

integer

required

The ID of the inspection.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspections/show/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Remove the specified inspection.

DELETE

http://fleet.test

/api/v1/fleet/inspections/delete/{inspection_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_id

integer

required

The ID of the inspection.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "http://fleet.test/api/v1/fleet/inspections/delete/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

40- Inspection forms management

Display a listing of the inspection forms.

GET

http://fleet.test

/api/v1/fleet/inspectionforms/list

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Display all inspection forms with their items

GET

http://fleet.test

/api/v1/fleet/inspectionforms/items/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/items/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all user vehicles list without already linked to form

GET

http://fleet.test

/api/v1/fleet/inspectionforms/vehicles/{inspection_form}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_form

integer

required

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/vehicles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Display all the inspection forms.

GET

http://fleet.test

/api/v1/fleet/inspectionforms/list/all

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/list/all" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Display the items of the specified inspection form.

GET

http://fleet.test

/api/v1/fleet/inspectionforms/show/items/{inspection_form}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_form

string

required

Example:

excepturi

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/show/items/excepturi" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Display the items of the specified inspection form. (as a select)

GET

http://fleet.test

/api/v1/fleet/inspectionforms/select/items/{inspection_form}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_form

string

required

Example:

sint

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/select/items/sint" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Display the vehicles of the specified inspection form.

GET

http://fleet.test

/api/v1/fleet/inspectionforms/show/vehicles/{inspection_form}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_form

integer

required

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/show/vehicles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Get all vehicles of the specified inspection form.

GET

http://fleet.test

/api/v1/fleet/inspectionforms/get/vehicles/{inspection_form}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_form

integer

required

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/get/vehicles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Add a vehicle to the inspection form.

POST

http://fleet.test

/api/v1/fleet/inspectionforms/add/vehicle/{inspection_form_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

inspection_form_id

integer

required

The ID of the inspection form.

Example:

Body Parameters

Auth

Bearer

Headers

URL Parameters

Body

{ "vehicles": null }

Received response

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/inspectionforms/add/vehicle/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Display the submissions of the specified inspection form.

GET

http://fleet.test

/api/v1/fleet/inspectionforms/show/submissions/{inspection_form}

requires authentication

Headers

Example:

URL Parameters

required

Example:

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/show/submissions/dolorem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Display the conditions of the specified inspection form.

GET

http://fleet.test

/api/v1/fleet/inspectionforms/show/conditions/{inspection_form}

requires authentication

Headers

URL Parameters

Auth

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/show/conditions/quam" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Display the specified inspection form.

GET

http://fleet.test

/api/v1/fleet/inspectionforms/show/{inspection_form}

requires authentication

Headers

URL Parameters

Example request:

curl --request GET \
    --get "http://fleet.test/api/v1/fleet/inspectionforms/show/debitis" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    vary
                                                            : Origin

{
    "error": "Unauthenticated."
}

Store a newly created inspection form.

POST

http://fleet.test

/api/v1/fleet/inspectionforms/store

requires authentication

Headers

Body Parameters

Example request:

curl --request POST \
    "http://fleet.test/api/v1/fleet/inspectionforms/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"pjofgr\",
    \"description\": \"Illum sequi voluptas illo esse iure voluptatem.\",
    \"start_date\": \"2025-03-14\",
    \"time_interval\": 30,
    \"time_interval_unit\": \"Y\",
    \"items\": [
        {
            \"type\": \"photo\",
            \"is_required\": true,
            \"short_description\": \"voluptatibus\",
            \"item_title\": \"excepturi\",
            \"order\": 15,
            \"date_type\": \"DO\",
            \"pass_label\": \"wvsaetfozyrl\",
            \"fail_label\": \"kuybgldhtjxcvhfeybgnnkrgk\",
            \"minimum\": 2,
            \"maximum\": 118492377.917,
            \"require_secondary_meter\": false,
            \"require_photo_verification\": true,
            \"require_comment_for_pass\": true,
            \"require_comment_for_fail\": false,
            \"require_photo_for_pass\": false,
            \"require_photo_for_fail\": true,
            \"choices\": [
                {
                    \"choice_text\": \"quia\",
                    \"fail_item_if_chosen\": false
                }
            ]
        }
    ]
}"

Store a newly created condition in storage.

POST

http://fleet.test

/api/v1/fleet/inspectionforms/conditions/{inspection_form}/store

requires authentication

Headers

URL Parameters

Body Parameters

Display the specified condition.

GET

http://fleet.test

/api/v1/fleet/inspectionforms/conditions/{inspection_form}/show/{condition}

requires authentication

Headers

URL Parameters

Remove the specified condition from storage.

DELETE

requires authentication

Fleet Documentation

Fleet Documentation

Introduction

Authenticating requests

Fleet Mobile

1- Authentification

Login client

Headers

Body Parameters

Store temp email

Headers

Body Parameters

Verify temp email

Headers

Body Parameters

Update password

Headers

Body Parameters

Logout user

Headers

2- User Profile management

Update user profile

Headers

Body Parameters

Update user profile picture

Headers

Body Parameters

Update user password

Headers

Body Parameters

Update user signature

Headers

Body Parameters

Update user preferences

Headers

Body Parameters

3- Vehicle management

Get assigned vehicles

Headers

Get vehicle details

Headers

URL Parameters

Get vehicle home data

Headers

URL Parameters

Get vehicle details

Headers

URL Parameters

Get vehicle device data

Headers

URL Parameters

Update private mode

Headers

URL Parameters

4- Issue management

Get issues list

Headers

Get issue details

Headers

URL Parameters

Store an issue

Headers

Body Parameters

Update an issue

Headers

URL Parameters

Body Parameters

Delete an issue

Headers

URL Parameters

5- Label management

Get all user labels without pagination

Headers

6- Meter History management

Get meter histories list

Headers

Get meter history details

Headers

URL Parameters

Store a meter history