Smart Data Models - Vehicle -


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

Type: object

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

Type: object

Property. Unique identifier of the entity

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

Type: string

Property. Identifier format of any NGSI entity

Type: string

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

Type: string

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

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.

Type: string

Property. The name of this item.

Type: string

Property. An alternative name for this item

Type: string

Property. A description of this item

Type: string

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

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:

Type: object

Property. Unique identifier of the entity

Same definition as id


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

Type: array of string

Must contain a minimum of 1 items

Each item of this array must be:

Type: string
Type: string
Type: object

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


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

Type: object

Geoproperty. Geojson reference to the item. Point

Type: enum (of string)

Must be one of:

  • "Point"

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Geoproperty. Geojson reference to the item. LineString

Type: enum (of string)

Must be one of:

  • "LineString"

Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Geoproperty. Geojson reference to the item. Polygon

Type: enum (of string)

Must be one of:

  • "Polygon"

Type: array of array

Each item of this array must be:

Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Geoproperty. Geojson reference to the item. MultiPoint

Type: enum (of string)

Must be one of:

  • "MultiPoint"

Type: array of array

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Geoproperty. Geojson reference to the item. MultiLineString

Type: enum (of string)

Must be one of:

  • "MultiLineString"

Type: array of array

Each item of this array must be:

Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Geoproperty. Geojson reference to the item. MultiLineString

Type: enum (of string)

Must be one of:

  • "MultiPolygon"

Type: array of array

Each item of this array must be:

Type: array of array

Each item of this array must be:

Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

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

Type: string

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

Type: string

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

Type: string

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

Type: string

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

Type: string

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

Type: string

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

Type: string

Property. The geographic area where a service or offered item is provided. Model:'https://schema.org/Text'

Type: object

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

Type: string

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

Type: string

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

Type: array of string

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

Each item of this array must be:

Type: string
Type: object

Type: enum (of string)

Property. NGSI Entity type. It has to be Vehicle

Must be one of:

  • "Vehicle"

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"
  • "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"
  • "trolley"
  • "twoWheeledVehicle"
  • "van"
  • "vehicleWithoutCatalyticConverter"
  • "vehicleWithCaravan"
  • "vehicleWithTrailer"
  • "withEvenNumberedRegistrationPlates"
  • "withOddNumberedRegistrationPlates"
  • "other"

Type: array of enum (of string)

Property. Vehicle category(ies) from an external point of view. This is different than the vehicle type (car, lorry, etc.) represented by the vehicleType property. Model:'https://schema.org/Text'. Enum:'municipalServices, nonTracked, private, public, specialUsage, tracked'. Tracked vehicles are those vehicles which position is permanently tracked by a remote system. Or any other needed by an application They incorporate a GPS receiver together with a network connection to periodically update a reported position (location, speed, heading ...).

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "municipalServices"
  • "nonTracked"
  • "private"
  • "public"
  • "specialUsage"
  • "tracked"

Type: object

Type: object

Type: enum (of string)

Must be one of:

  • "Point"

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Type: enum (of string)

Must be one of:

  • "LineString"

Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Type: enum (of string)

Must be one of:

  • "Polygon"

Type: array of array

Each item of this array must be:

Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Type: enum (of string)

Must be one of:

  • "MultiPoint"

Type: array of array

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Type: enum (of string)

Must be one of:

  • "MultiLineString"

Type: array of array

Each item of this array must be:

Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

Type: object

Type: enum (of string)

Must be one of:

  • "MultiPolygon"

Type: array of array

Each item of this array must be:

Type: array of array

Each item of this array must be:

Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:


Property. Denotes the magnitude of the horizontal component of the vehicle's current velocity and is specified in Kilometers per Hour. If provided, the value of the speed attribute must be a non-negative real number. -1 MAY be used if speed is transiently unknown for some reason. Model:'https://schema.org/Number'. Units:'Kilometer per hour (Km/h)'

Type: number

Value must be greater or equal to 0

Type: enum (of integer)

Must be one of:

  • -1


Property. Denotes the direction of travel of the vehicle and is specified in decimal degrees, where 0 <= heading < 360, counting clockwise relative to the true north. If the vehicle is stationary (i.e. the value of the speed attribute is 0), then the value of the heading attribute must be equal to -1. Model:'https://schema.org/Number'. Units:'Kilometer per hour (Km/h)'

Type: number

Value must be greater or equal to 0 and lesser or equal to 360

Type: const
Specific value: -1

Type: number

Property. Current weight of the vehicle's cargo. Model:'https://schema.org/Number'. Units:'Kilograms'

Value must be strictly greater than 0

Type: string

Property. The Vehicle Identification Number (VIN) is a unique serial number used by the automotive industry to identify individual motor vehicles. Model:'https://schema.org/vehicleIdentificationNumber'.

Type: string

Property. An identifier or code displayed on a vehicle registration plate attached to the vehicle used for official identification purposes. The registration identifier is numeric or alphanumeric and is unique within the issuing authority's region. Model:'https://schema.org/Text'. Normative References: DATEXII vehicleRegistrationPlateIdentifier

Type: string

Property. The identifier of the vehicle in the context of the fleet of vehicles to which it belongs. Model:'https://schema.org/Text'.

Type: string

Property. The date of the first registration of the vehicle with the respective public authorities. Model:'https://schema.org/dateVehicleFirstRegistered'.

Type: string

Property. Timestamp which denotes when the vehicle was first used. Model:'https://schema.org/DateTime'.

Type: string

Property. The date the item e.g. vehicle was purchased by the current owner. Model:'https://schema.org/purchaseDate'.

Type: number

Property. The total distance travelled by the particular vehicle since its initial production, as read from its odometer. Model:'https://schema.org/mileageFromOdometer'.

Type: string

Property. A short text indicating the configuration of the vehicle, e.g. '5dr hatchback ST 2.5 MT 225 hp' or 'limited edition'. Model:'https://schema.org/vehicleConfiguration'.

Type: array of enum (of string)

Property. Feature(s) incorporated by the vehicle. Model:'https://schema.org/Text'. Enum:' abs, airbag, alarm, backCamera, disabledRamp, gps, internetConnection, overspeed, proximitySensor, wifi'. Or any other needed by the application. In order to represent multiple instances of a feature it can be used the following syntax: <feature>,<occurences>. For example, a car with 4 airbags will be represented by airbag,4.

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "abs"
  • "airbag"
  • "alarm"
  • "backCamera"
  • "disabledRamp"
  • "gps"
  • "internetConnection"
  • "overspeed"
  • "proximitySensor"
  • "wifi"

Type: array of enum (of string)

Property. Service(s) the vehicle is capable of providing or it is assigned to. Model:'https://schema.org/Text'. Enum:'auxiliaryServices, cargoTransport, construction, fairground, garbageCollection, goodsSelling, maintenance, parksAndGardens, roadSignalling, specialTransport, streetCleaning, streetLighting, urbanTransit, wasteContainerCleaning'. Or any other value needed by an specific application.

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "auxiliaryServices"
  • "cargoTransport"
  • "construction"
  • "fairground"
  • "garbageCollection"
  • "goodsSelling"
  • "maintenance"
  • "parksAndGardens"
  • "roadSignalling"
  • "specialTransport"
  • "streetCleaning"
  • "streetLighting"
  • "urbanTransit"
  • "wasteContainerCleaning"

Type: enum (of string)

Property. Indicates whether the vehicle is been used for special purposes, like commercial rental, driving school, or as a taxi. The legislation in many countries requires this information to be revealed when offering a car for sale. Model:'https://schema.org/vehicleSpecialUsage'. Enum:'ambulance, fireBrigade, military, police, schoolTransportation, taxi'

Must be one of:

  • "ambulance"
  • "fireBrigade"
  • "military"
  • "police"
  • "schoolTransportation"
  • "taxi"


Relationship. Model:'https://schema.org/URL'. Reference to a VehicleModel

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

Type: string

Property. Identifier format of any NGSI entity

Type: enum (of string)

Property. Vehicle status (from the point of view of the service provided, so it could not apply to private vehicles). Model:'https://schema.org/DateTime'. parked : Vehicle is parked and not providing any service at the moment. onRoute : Vehicle is performing a mission. A comma-separated modifier(s) can be added to indicate what mission is currently delivering the vehicle. For instance onRoute,garbageCollection can be used to denote that the vehicle is on route and in a garbage collection mission. broken : Vehicle is suffering a temporary breakdown. outOfService : Vehicle is on the road but not performing any mission, probably going to its parking area. Enum:'broken, onRoute, outOfService, parked'

Must be one of:

  • "broken"
  • "onRoute"
  • "outOfService"
  • "parked"

The following properties are required: