- Vehicle / Vehicle Model


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

root allOf GSMA-Commons
Type: object

All from GSMA-Commons https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons

root allOf item 0 id
Type: object

Property. Unique identifier of the entity

root allOf item 0 id anyOf item 0
Type: string

Property. Identifier format of any NGSI entity

Must match regular expression: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$

Must be at least 1 characters long

Must be at most 256 characters long

root allOf item 0 id anyOf item 1
Type: string

Property. Identifier format of any NGSI entity

root allOf item 0 dateCreated
Type: string

Property. Entity creation timestamp. This will usually be allocated by the storage platform.

root allOf item 0 dateModified
Type: string

Property. Timestamp of the last modification of the entity. This will usually be allocated by the storage platform.

root allOf item 0 source
Type: string

Property. A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object.

root allOf item 0 name
Type: string

Property. The name of this item.

root allOf item 0 alternateName
Type: string

Property. An alternative name for this item

root allOf item 0 description
Type: string

Property. A description of this item

root allOf item 0 dataProvider
Type: string

Property. A sequence of characters identifying the provider of the harmonised data entity.

root allOf item 0 owner
Type: array

Property. A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)

Each item of this array must be:

root allOf item 0 owner EntityIdentifierType
Type: object

Property. Unique identifier of the entity

Same definition as id

root allOf item 0 seeAlso

Property. list of uri pointing to additional resources about the item

root allOf item 0 seeAlso oneOf item 0
Type: array of string

Must contain a minimum of 1 items

Each item of this array must be:

root allOf item 0 seeAlso oneOf item 0 items
Type: string
root allOf item 0 seeAlso oneOf item 1
Type: string
root allOf Location-Commons
Type: object

All from Location-Commons https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons

root allOf item 1 location

Geoproperty. Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon

root allOf item 1 location oneOf GeoJSON Point
Type: object

Geoproperty. Geojson reference to the item. Point

root allOf item 1 location oneOf GeoJSON Point type
Type: enum (of string)

Must be one of:

  • "Point"

root allOf item 1 location oneOf GeoJSON Point coordinates
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Point coordinates items
Type: number

root allOf item 1 location oneOf GeoJSON Point bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Point bbox items
Type: number
root allOf item 1 location oneOf GeoJSON LineString
Type: object

Geoproperty. Geojson reference to the item. LineString

root allOf item 1 location oneOf GeoJSON LineString type
Type: enum (of string)

Must be one of:

  • "LineString"

root allOf item 1 location oneOf GeoJSON LineString coordinates
Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString coordinates items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString coordinates items items
Type: number

root allOf item 1 location oneOf GeoJSON LineString bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString bbox items
Type: number
root allOf item 1 location oneOf GeoJSON Polygon
Type: object

Geoproperty. Geojson reference to the item. Polygon

root allOf item 1 location oneOf GeoJSON Polygon type
Type: enum (of string)

Must be one of:

  • "Polygon"

root allOf item 1 location oneOf GeoJSON Polygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates items
Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates items items items
Type: number

root allOf item 1 location oneOf GeoJSON Polygon bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiPoint
Type: object

Geoproperty. Geojson reference to the item. MultiPoint

root allOf item 1 location oneOf GeoJSON MultiPoint type
Type: enum (of string)

Must be one of:

  • "MultiPoint"

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiPoint bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiLineString
Type: object

Geoproperty. Geojson reference to the item. MultiLineString

root allOf item 1 location oneOf GeoJSON MultiLineString type
Type: enum (of string)

Must be one of:

  • "MultiLineString"

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates items
Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates items items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiLineString bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiPolygon
Type: object

Geoproperty. Geojson reference to the item. MultiLineString

root allOf item 1 location oneOf GeoJSON MultiPolygon type
Type: enum (of string)

Must be one of:

  • "MultiPolygon"

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates items
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates items items
Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates items items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates items items items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiPolygon bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon bbox items
Type: number

root allOf item 1 address
Type: object

Property. The mailing address. Model:'https://schema.org/address'

root allOf item 1 address streetAddress
Type: string

Property. The street address. Model:'https://schema.org/streetAddress'

root allOf item 1 address addressLocality
Type: string

Property. The locality in which the street address is, and which is in the region. Model:'https://schema.org/addressLocality'

root allOf item 1 address addressRegion
Type: string

Property. The region in which the locality is, and which is in the country. Model:'https://schema.org/addressRegion'

root allOf item 1 address addressCountry
Type: string

Property. The country. For example, Spain. Model:'https://schema.org/addressCountry'

root allOf item 1 address postalCode
Type: string

Property. The postal code. For example, 24004. Model:'https://schema.org/https://schema.org/postalCode'

root allOf item 1 address postOfficeBoxNumber
Type: string

Property. The post office box number for PO box addresses. For example, 03578. Model:'https://schema.org/postOfficeBoxNumber'

root allOf item 1 areaServed
Type: string

Property. The geographic area where a service or offered item is provided. Model:'https://schema.org/Text'
root allOf PhysicalObject-Commons
Type: object

All from PhysicalObject-Commons https://smart-data-models.github.io/data-models/common-schema.json#/definitions/PhysicalObject-Commons

root allOf item 2 color
Type: string

Property. The color of the product. Model:'https://schema.org/color'

root allOf item 2 image
Type: string

Property. An image of the item. Model:'https://schema.org/URL'

root allOf item 2 annotations
Type: array of string

Property. Annotations about the item. Model:'https://schema.org/Text'

Each item of this array must be:

root allOf item 2 annotations items
Type: string
root allOf item 3
Type: object

root allOf item 3 type
Type: enum (of string)

Property. NGSI Entity type. It has to be VehicleModel

Must be one of:

  • "VehicleModel"

root allOf item 3 vehicleType
Type: enum (of string)

Property. Type of vehicle from the point of view of its structural characteristics. This is different than the vehicle category . Model:'https://schema.org/Text'. Enum:'agriculturalVehicle, anyVehicle, articulatedVehicle, bicycle, binTrolley, bus, car, caravan, carOrLightVehicle, carWithCaravan, carWithTrailer, cleaningTrolley, constructionOrMaintenanceVehicle, fourWheelDrive, highSidedVehicle, lorry, minibus, moped, motorcycle, motorcycleWithSideCar, motorscooter, sweepingMachine, tanker, threeWheeledVehicle, trailer, tram, twoWheeledVehicle, trolley, van, vehicleWithoutCatalyticConverter, vehicleWithCaravan, vehicleWithTrailer, withEvenNumberedRegistrationPlates, withOddNumberedRegistrationPlates, other'. The following values defined by VehicleTypeEnum and VehicleTypeEnum2, DATEX 2 version 2.3

Must be one of:

  • "agriculturalVehicle"
  • "bicycle"
  • "binTrolley"
  • "bus"
  • "car"
  • "caravan"
  • "carWithCaravan"
  • "carWithTrailer"
  • "cleaningTrolley"
  • "constructionOrMaintenanceVehicle"
  • "lorry"
  • "minibus"
  • "moped"
  • "motorcycle"
  • "motorcycleWithSideCar"
  • "motorscooter"
  • "sweepingMachine"
  • "tanker"
  • "trailer"
  • "tram"
  • "van"
  • "trolley"

root allOf item 3 brandName
Type: string

Property. Vehicle's brand name. Model:'https://schema.org/brand'.

root allOf item 3 modelName
Type: string

Property. Vehicle's model name. Model:'https://schema.org/model'.

root allOf item 3 manufacturerName
Type: string

Property. Vehicle's manufacturer name. Model:'https://schema.org/Text'.

root allOf item 3 vehicleModelDate
Type: string

Property. The release date of a vehicle model (often used to differentiate versions of the same make and model). Model:'https://schema.org/vehicleModelDate'.

root allOf item 3 cargoVolume
Type: number

Property. The available volume for cargo or luggage. For automobiles, this is usually the trunk volume. Model:'https://schema.org/cargoVolume'. Units:'Liters'. If only a single value is provided (type Number) it will refer to the maximum volume.

Value must be greater or equal to 0

root allOf item 3 fuelType
Type: enum (of string)

Property. The type of fuel suitable for the engine or engines of the vehicle. Model:'https://schema.org/DateTime'. Enum:'autogas, biodiesel, ethanol, cng, diesel, electric, gasoline, hybrid electric/diesel, hybrid electric/petrol, hydrogen, lpg, petrol, petrol(unleaded), petrol(leaded), other'

Must be one of:

  • "autogas"
  • "biodiesel"
  • "cng"
  • "diesel"
  • "electric"
  • "ethanol"
  • "gasoline"
  • "hybrid_electric_diesel"
  • "hybrid_electric_petrol"
  • "hydrogen"
  • "lpg"
  • "petrol"
  • "petrol(unleaded)"
  • "petrol(leaded)"
  • "other"

root allOf item 3 fuelConsumption
Type: number

Property. The amount of fuel consumed for traveling a particular distance or temporal duration with the given vehicle (e.g. liters per 100 km). Model:'https://schema.org/fuelConsumption'. Units:'liters per 100 kilometer'

Value must be greater or equal to 0

root allOf item 3 height
Type: number

Property. Vehicle's height. Model:'https://schema.org/height'.

Value must be greater or equal to 0

root allOf item 3 width
Type: number

Property. Vehicle's width. Model:'https://schema.org/width'.

Value must be greater or equal to 0

root allOf item 3 depth
Type: number

Property. Vehicle's depth. Model:'https://schema.org/depth'.

Value must be greater or equal to 0

root allOf item 3 weight
Type: number

Property. Vehicle's weigth. Model:'https://schema.org/weigth'.

Value must be greater or equal to 0

root allOf item 3 vehicleEngine
Type: string

Property. Information about the engine or engines of the vehicle. Model:'https://schema.org/vehicleEngine'.

root allOf item 3 url
Type: string

Property. URL which provides a description of this vehicle model. Model:'https://schema.org/URL'.

The following properties are required: