Vehicle - Categories

The base url for the APIs in this page is at:

/api/vehicle-mobile

A JSON file with OpenAPI data about all vehicle-related mobile APIs can be downloaded here.

Get vehicle category data

Used to retrieve the detailed data for the specified vehicle category:

GET /v1/vehicle-category/{id}

Returns data about the vehicle category

Parameters

  • id (string) – The id of the category

Status Codes
id: The ID of the category (int)

The request will return a Json positive response and the information of the category corresponding to the provided ID:

{
  "CreatedDate": "2019-05-28T11:40:29Z",                          // DateTime
  "Guid": "109c334f-94a8-4437-96cf-e53fe81ab8de",                 // Guid
  "Labels": "{\"en\":\"Mount Everest\"}",                         // JSON Dictionary
  "Manufacturer": "Porsche AG",                                   // String (nullable)
  "Model": "Porsche Cayenne",                                     // String (nullable)
  "Year": 2017,                                                   // Int (nullable)
  "PassengerSeats": 5,                                            // Int (nullable)
  "Image": "jVBORw0KGgoAAAAN.......AAAAAElFTkSuQmCC",             // ByteArray as String (nullable)
  "ImageThumbnail": "jVBORw0KGgoAAAAN.......AAAAAElFTkSuQmCC",    // ByteArray as String (nullable)
  "IsRoot": false,                                                // Boolean
  "DeletionDate": null,                                           // DateTime (nullable)
  "ID": 8                                                         // Int
}

or a plain Json negative response if no corresponding record is found.

The properties Manufacturer, Model, Year and PassengerSeats may be valorized only if IsRoot is false.