Vehicle Model


This entity models a particular vehicle model, including all properties which are common to multiple vehicle instances belonging to such model.

Data Model

The data model is defined as shown below:

  • id : Entity's unique identifier.

  • type : Entity type. It must be equal to VehicleModel.

  • source : A sequence of characters giving the source of the entity data.

    • Attribute type: Text or URL
    • Optional
  • dataProvider : Specifies the URL to information about the provider of this information

    • Attribute type: URL
    • Optional
  • name : Name given to this vehicle model.

  • description : Vehicle model description.

  • vehicleType : Type of vehicle from the point of view of its structural characteristics.

    • See definition at Vehicle.
    • Mandatory
  • brandName : Vehicle's brand name.

  • modelName : Vehicle's model name.

  • manufacturerName : Vehicle's manufacturer name.

  • vehicleModelDate : The release date of a vehicle model (often used to differentiate versions of the same make and model).

  • cargoVolume : The available volume for cargo or luggage. For automobiles, this is usually the trunk volume.

    • Normative References:
    • Default Unit: Liters
    • Optional
    • Note: If only a single value is provided (type Number) it will refer to the maximum volume.
  • fuelType : The type of fuel suitable for the engine or engines of the vehicle.

    • Normative References:
    • Allowed values: one Of (gasoline, petrol(unleaded), petrol(leaded), petrol, diesel, electric, hydrogen, lpg, autogas, cng, biodiesel ethanol, hybrid electric/petrol, hybrid electric/diesel, other)
    • Optional
  • fuelConsumption : The amount of fuel consumed for traveling a particular distance or temporal duration with the given vehicle (e.g. liters per 100 km).

  • height : Vehicle's height.

  • width : Vehicle's width.

  • depth : Vehicle's depth.

  • weight : Vehicle's weight.

  • vehicleEngine : Information about the engine or engines of the vehicle.

  • url : URL which provides a description of this vehicle model.

  • image: Image which depicts this vehicle model.

  • dateModified : Last update timestamp of this entity.

    • Attribute type: DateTime
    • Read-Only. Automatically generated.
  • dateCreated : Creation timestamp of this entity.

    • Attribute type: DateTime
    • Read-Only. Automatically generated.

Note: JSON Schemas only capture the NGSI simplified representation, this means that to test the JSON schema examples with a FIWARE NGSI version 2 API implementation, you need to use the keyValues mode (options=keyValues).


Normalized Example

Normalized NGSI response

    "id": "vehiclemodel:econic",
    "type": "VehicleModel",
    "name": {
        "value": "MBenz-Econic2014"
    "cargoVolume": {
        "value": 1000
    "modelName": {
        "value": "Econic"
    "brandName": {
        "value": "Mercedes Benz"
    "manufacturerName": {
        "value": "Daimler"
    "fuelType": {
        "value": "diesel"
    "vehicleType": {
        "value": "lorry"

key-value pairs Example

Sample uses simplified representation for data consumers ?options=keyValues

    "id": "vehiclemodel:econic",
    "type": "VehicleModel",
    "name": "MBenz-Econic2014",
    "brandName": "Mercedes Benz",
    "modelName": "Econic",
    "manufacturerName": "Daimler",
    "vehicleType": "lorry",
    "cargoVolume": 1000,
    "fuelType": "diesel"

Test it with a real service

Open issues

  • Model fuelConsumption depending on the situation (urban or road)