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.

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 Vehicle

Must be one of:

  • "Vehicle"

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"
  • "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"

root allOf item 3 category
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:

root allOf item 3 category items
Type: enum (of string)

Must be one of:

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

root allOf item 3 previousLocation
Type: object

root allOf item 3 previousLocation oneOf GeoJSON Point
Type: object

root allOf item 3 previousLocation oneOf GeoJSON Point type
Type: enum (of string)

Must be one of:

  • "Point"

root allOf item 3 previousLocation 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 3 previousLocation oneOf GeoJSON Point coordinates items
Type: number

root allOf item 3 previousLocation 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 3 previousLocation oneOf GeoJSON Point bbox items
Type: number
root allOf item 3 previousLocation oneOf GeoJSON LineString
Type: object

root allOf item 3 previousLocation oneOf GeoJSON LineString type
Type: enum (of string)

Must be one of:

  • "LineString"

root allOf item 3 previousLocation 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 3 previousLocation 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 3 previousLocation oneOf GeoJSON LineString coordinates items items
Type: number

root allOf item 3 previousLocation 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 3 previousLocation oneOf GeoJSON LineString bbox items
Type: number
root allOf item 3 previousLocation oneOf GeoJSON Polygon
Type: object

root allOf item 3 previousLocation oneOf GeoJSON Polygon type
Type: enum (of string)

Must be one of:

  • "Polygon"

root allOf item 3 previousLocation oneOf GeoJSON Polygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 3 previousLocation 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 3 previousLocation 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 3 previousLocation oneOf GeoJSON Polygon coordinates items items items
Type: number

root allOf item 3 previousLocation 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 3 previousLocation oneOf GeoJSON Polygon bbox items
Type: number
root allOf item 3 previousLocation oneOf GeoJSON MultiPoint
Type: object

root allOf item 3 previousLocation oneOf GeoJSON MultiPoint type
Type: enum (of string)

Must be one of:

  • "MultiPoint"

root allOf item 3 previousLocation oneOf GeoJSON MultiPoint coordinates
Type: array of array

Each item of this array must be:

root allOf item 3 previousLocation 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 3 previousLocation oneOf GeoJSON MultiPoint coordinates items items
Type: number

root allOf item 3 previousLocation 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 3 previousLocation oneOf GeoJSON MultiPoint bbox items
Type: number
root allOf item 3 previousLocation oneOf GeoJSON MultiLineString
Type: object

root allOf item 3 previousLocation oneOf GeoJSON MultiLineString type
Type: enum (of string)

Must be one of:

  • "MultiLineString"

root allOf item 3 previousLocation oneOf GeoJSON MultiLineString coordinates
Type: array of array

Each item of this array must be:

root allOf item 3 previousLocation 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 3 previousLocation 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 3 previousLocation oneOf GeoJSON MultiLineString coordinates items items items
Type: number

root allOf item 3 previousLocation 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 3 previousLocation oneOf GeoJSON MultiLineString bbox items
Type: number
root allOf item 3 previousLocation oneOf GeoJSON MultiPolygon
Type: object

root allOf item 3 previousLocation oneOf GeoJSON MultiPolygon type
Type: enum (of string)

Must be one of:

  • "MultiPolygon"

root allOf item 3 previousLocation oneOf GeoJSON MultiPolygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 3 previousLocation oneOf GeoJSON MultiPolygon coordinates items
Type: array of array

Each item of this array must be:

root allOf item 3 previousLocation 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 3 previousLocation 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 3 previousLocation oneOf GeoJSON MultiPolygon coordinates items items items items
Type: number

root allOf item 3 previousLocation 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 3 previousLocation oneOf GeoJSON MultiPolygon bbox items
Type: number

root allOf item 3 speed

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)'

root allOf item 3 speed oneOf item 0
Type: number

Value must be greater or equal to 0

root allOf item 3 speed oneOf item 1
Type: enum (of integer)

Must be one of:

  • -1

root allOf item 3 heading

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)'

root allOf item 3 heading oneOf item 0
Type: number

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

root allOf item 3 heading oneOf item 1
Type: const
Specific value: -1

root allOf item 3 cargoWeight
Type: number

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

Value must be strictly greater than 0

root allOf item 3 vehicleIdentificationNumber
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'.

root allOf item 3 vehiclePlateIdentifier
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

root allOf item 3 fleetVehicleId
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'.

root allOf item 3 dateVehicleFirstRegistered
Type: string

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

root allOf item 3 dateFirstUsed
Type: string

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

root allOf item 3 purchaseDate
Type: string

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

root allOf item 3 mileageFromOdometer
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'.

root allOf item 3 vehicleConfiguration
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'.

root allOf item 3 feature
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:

root allOf item 3 feature items
Type: enum (of string)

Must be one of:

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

root allOf item 3 serviceProvided
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:

root allOf item 3 serviceProvided items
Type: enum (of string)

Must be one of:

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

root allOf item 3 vehicleSpecialUsage
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"

root allOf item 3 refVehicleModel

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

root allOf item 3 refVehicleModel 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 3 refVehicleModel anyOf item 1
Type: string

Property. Identifier format of any NGSI entity

root allOf item 3 serviceStatus
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: