Get All Vehicles

GET /tms/vehicles

Description

This endpoint retrieves a list of all vehicles based on specified query parameters. You can filter the results by various attributes such as country code, tenant ID, vehicle model, and more.

Parameters

• countryCode (string, header, required): The country code for the vehicles.
• tenantId (string, header, required): The tenant ID for the vehicles.
• pageNumber (integer, query, optional): The page number for pagination (default is 1).
• pageSize (integer, query, optional): The number of items per page (default is 10).
• model (array[string], query, optional): Filter vehicles by model.
• manufacturer (array[string], query, optional): Filter vehicles by manufacturer.
• year (array[string], query, optional): Filter vehicles by year.
• type (array[string], query, optional): Filter vehicles by type.
• licensePlate (array[string], query, optional): Filter vehicles by license plate.
• carrierPhoneNumber (array[string], query, optional): Filter vehicles by carrier phone number.
• carrierId (array[string], query, optional): Filter vehicles by carrier ID.
• driverUserId (array[string], query, optional): Filter vehicles by driver user ID.
• spaceId (string, query, optional): Filter vehicles by space ID.
• startDate (string, query, optional): Filter vehicles by start date (in ISO 8601 format).
• endDate (string, query, optional): Filter vehicles by end date (in ISO 8601 format).
• condition (array[string], query, optional): Filter vehicles by condition.
• searchValue (string, query, optional): Search vehicles based on a specific value.

Responses

• 200 OK
  • Media type: Controls Accept header.
  • Example Value:

{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}