document generated automatically
Global description: This entity contains a harmonised description of the status of a generic fleet vehicle. This entity is primarily associated with the vertical segment of the transport and logistics but may also be used many other related IoT applications.
version: 0.0.1
[*] If there is not a type in an attribute is because it could have several types or different formats/patterns
address[object]
: The mailing address . Model: https://schema.org/addressaddressCountry[string]
: The country. For example, Spain . Model: https://schema.org/addressCountryaddressLocality[string]
: The locality in which the street address is, and which is in the region . Model: https://schema.org/addressLocalityaddressRegion[string]
: The region in which the locality is, and which is in the country . Model: https://schema.org/addressRegiondistrict[string]
: A district is a type of administrative division that, in some countries, is managed by the local governmentpostOfficeBoxNumber[string]
: The post office box number for PO box addresses. For example, 03578 . Model: https://schema.org/postOfficeBoxNumberpostalCode[string]
: The postal code. For example, 24004 . Model: https://schema.org/https://schema.org/postalCodestreetAddress[string]
: The street address . Model: https://schema.org/streetAddress
alternateName[string]
: An alternative name for this itemareaServed[string]
: The geographic area where a service or offered item is provided . Model: https://schema.org/Textbattery[number]
: The current percentage of battery left in case of an electric vehicle, or a device connected to the vehiclebearing[number]
: The current bearing of the fleet vehicle in degrees relative to North. The timestamp element of the attribute should indicate when the reading was obtainedcurrentOperative[object]
: The current operative (e.g. driver) of the vehicle described as a Schema.org person . Model: https://schema.org/PersongivenName
:
currentStatus[string]
: A description of the current status of the vehicle e.g. Enum:'deployed, finished, terminated, servicing, starting'dataProvider[string]
: A sequence of characters identifying the provider of the harmonised data entitydateCreated[date-time]
: Entity creation timestamp. This will usually be allocated by the storage platformdateModified[date-time]
: Timestamp of the last modification of the entity. This will usually be allocated by the storage platformdescription[string]
: A description of this itemfleetVehicle[*]
: Reference to the FleetVehicle entity to which this status entity relatesfleetVehicleOperation[*]
: Reference to the FleetVehicleOperation entity to which this status entity relatesid[*]
: Unique identifier of the entityinRestrictedArea[boolean]
: Indicates if the vehicle is known to be in a restricted area at the time of the status updatelastFuellingAmount[number]
: The level of fuel added to the vehicle at the last fuelling. The timestamp element of the attribute should indicate when the vehicle was fuelled. Data to be recorded in LitreslastKnownPosition[*]
: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygonlastKnownPositionUpdatedAt[date-time]
: The timestamp of the last known position update for the fleet vehiclelocation[*]
: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygonmileageFromOdometer[number]
: The total distance the fleet vehicle has travelled according to the on-board odometer in kilometres (unitCode KMT) or miles (unitCode SMI). See also Schema.org Vehicle/ mileageFromOdometer. The timestamp element records when the odometer reading was takenname[string]
: The name of this itemowner[array]
: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)restFuelAmount[number]
: The level of fuel recorded when the vehicle was last at rest (i.e. stopped). The timestamp element of the attribute should indicate when the vehicle was last at rest. Data to be recorded in LitresseeAlso[*]
: list of uri pointing to additional resources about the itemsource[string]
: 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 objectspeed[number]
: The current speed of the fleet vehicle (km/h). The timestamp element of the attribute should indicate when the reading was obtainedtype[string]
: NGSI Entity identifier. It has to be FleetVehicleStatus
Required properties
id
type
This data model comes from the original project GSMA IoT project, https://www.gsma.com/iot/iot-big-data/. There are some minor adaptations to meet requirements of smart data models.
Sorted alphabetically (click for details)
full yaml details
FleetVehicleStatus:
description: This entity contains a harmonised description of the status of a generic fleet vehicle. This entity is primarily associated with the vertical segment of the transport and logistics but may also be used many other related IoT applications.
properties:
address:
description: The mailing address
properties:
addressCountry:
description: 'The country. For example, Spain'
type: string
x-ngsi:
model: https://schema.org/addressCountry
type: Property
addressLocality:
description: 'The locality in which the street address is, and which is in the region'
type: string
x-ngsi:
model: https://schema.org/addressLocality
type: Property
addressRegion:
description: 'The region in which the locality is, and which is in the country'
type: string
x-ngsi:
model: https://schema.org/addressRegion
type: Property
district:
description: 'A district is a type of administrative division that, in some countries, is managed by the local government'
type: string
x-ngsi:
type: Property
postOfficeBoxNumber:
description: 'The post office box number for PO box addresses. For example, 03578'
type: string
x-ngsi:
model: https://schema.org/postOfficeBoxNumber
type: Property
postalCode:
description: 'The postal code. For example, 24004'
type: string
x-ngsi:
model: https://schema.org/https://schema.org/postalCode
type: Property
streetAddress:
description: The street address
type: string
x-ngsi:
model: https://schema.org/streetAddress
type: Property
streetNr:
description: Number identifying a specific property on a public street
type: string
x-ngsi:
type: Property
type: object
x-ngsi:
model: https://schema.org/address
type: Property
alternateName:
description: An alternative name for this item
type: string
x-ngsi:
type: Property
areaServed:
description: The geographic area where a service or offered item is provided
type: string
x-ngsi:
model: https://schema.org/Text
type: Property
battery:
description: 'The current percentage of battery left in case of an electric vehicle, or a device connected to the vehicle'
maximum: 1
minimum: 0
type: number
x-ngsi:
type: Property
bearing:
description: The current bearing of the fleet vehicle in degrees relative to North. The timestamp element of the attribute should indicate when the reading was obtained
type: number
x-ngsi:
type: Property
currentOperative:
description: The current operative (e.g. driver) of the vehicle described as a Schema.org person
properties:
givenName:
type: string
jobTitle:
type: string
type: object
x-ngsi:
model: https://schema.org/Person
type: Property
currentStatus:
description: 'A description of the current status of the vehicle e.g. Enum:''deployed, finished, terminated, servicing, starting'''
enum:
- deployed
- finished
- servicing
- starting
- terminated
type: string
x-ngsi:
type: Property
dataProvider:
description: A sequence of characters identifying the provider of the harmonised data entity
type: string
x-ngsi:
type: Property
dateCreated:
description: Entity creation timestamp. This will usually be allocated by the storage platform
format: date-time
type: string
x-ngsi:
type: Property
dateModified:
description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform
format: date-time
type: string
x-ngsi:
type: Property
description:
description: A description of this item
type: string
x-ngsi:
type: Property
fleetVehicle:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
description: Reference to the FleetVehicle entity to which this status entity relates
x-ngsi:
type: Relationship
fleetVehicleOperation:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
description: Reference to the FleetVehicleOperation entity to which this status entity relates
x-ngsi:
type: Relationship
id:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
description: Unique identifier of the entity
x-ngsi:
type: Property
inRestrictedArea:
description: Indicates if the vehicle is known to be in a restricted area at the time of the status update
type: boolean
x-ngsi:
type: Property
lastFuellingAmount:
description: The level of fuel added to the vehicle at the last fuelling. The timestamp element of the attribute should indicate when the vehicle was fuelled. Data to be recorded in Litres
type: number
x-ngsi:
type: Property
units: litres
lastKnownPosition:
description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'
oneOf:
- description: Geojson reference to the item. Point
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
type: number
minItems: 2
type: array
type:
enum:
- Point
type: string
required:
- type
- coordinates
title: GeoJSON Point
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. LineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type:
enum:
- LineString
type: string
required:
- type
- coordinates
title: GeoJSON LineString
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. Polygon
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type:
enum:
- Polygon
type: string
required:
- type
- coordinates
title: GeoJSON Polygon
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiPoint
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
type: array
type:
enum:
- MultiPoint
type: string
required:
- type
- coordinates
title: GeoJSON MultiPoint
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiLineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type: array
type:
enum:
- MultiLineString
type: string
required:
- type
- coordinates
title: GeoJSON MultiLineString
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiLineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type: array
type:
enum:
- MultiPolygon
type: string
required:
- type
- coordinates
title: GeoJSON MultiPolygon
type: object
x-ngsi:
type: GeoProperty
x-ngsi:
type: GeoProperty
lastKnownPositionUpdatedAt:
description: The timestamp of the last known position update for the fleet vehicle
format: date-time
type: string
x-ngsi:
type: Property
location:
description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'
oneOf:
- description: Geojson reference to the item. Point
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
type: number
minItems: 2
type: array
type:
enum:
- Point
type: string
required:
- type
- coordinates
title: GeoJSON Point
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. LineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type:
enum:
- LineString
type: string
required:
- type
- coordinates
title: GeoJSON LineString
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. Polygon
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type:
enum:
- Polygon
type: string
required:
- type
- coordinates
title: GeoJSON Polygon
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiPoint
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
type: array
type:
enum:
- MultiPoint
type: string
required:
- type
- coordinates
title: GeoJSON MultiPoint
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiLineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type: array
type:
enum:
- MultiLineString
type: string
required:
- type
- coordinates
title: GeoJSON MultiLineString
type: object
x-ngsi:
type: GeoProperty
- description: Geojson reference to the item. MultiLineString
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type: array
type:
enum:
- MultiPolygon
type: string
required:
- type
- coordinates
title: GeoJSON MultiPolygon
type: object
x-ngsi:
type: GeoProperty
x-ngsi:
type: GeoProperty
mileageFromOdometer:
description: The total distance the fleet vehicle has travelled according to the on-board odometer in kilometres (unitCode KMT) or miles (unitCode SMI). See also Schema.org Vehicle/ mileageFromOdometer. The timestamp element records when the odometer reading was taken
type: number
x-ngsi:
type: Property
name:
description: The name of this item
type: string
x-ngsi:
type: Property
owner:
description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)
items:
anyOf:
- description: Identifier format of any NGSI entity
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
x-ngsi:
type: Property
- description: Identifier format of any NGSI entity
format: uri
type: string
x-ngsi:
type: Property
description: Unique identifier of the entity
x-ngsi:
type: Property
type: array
x-ngsi:
type: Property
restFuelAmount:
description: The level of fuel recorded when the vehicle was last at rest (i.e. stopped). The timestamp element of the attribute should indicate when the vehicle was last at rest. Data to be recorded in Litres
type: number
x-ngsi:
type: Property
seeAlso:
description: list of uri pointing to additional resources about the item
oneOf:
- items:
format: uri
type: string
minItems: 1
type: array
- format: uri
type: string
x-ngsi:
type: Property
source:
description: '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
x-ngsi:
type: Property
speed:
description: The current speed of the fleet vehicle (km/h). The timestamp element of the attribute should indicate when the reading was obtained
type: number
x-ngsi:
type: Property
units: km/h
type:
description: NGSI Entity identifier. It has to be FleetVehicleStatus
enum:
- FleetVehicleStatus
type: string
x-ngsi:
type: Property
required:
- id
- type
type: object
x-derived-from: ""
x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted provided that the license conditions are met. Copyleft (c) 2022 Contributors to Smart Data Models Program'
x-license-url: https://github.com/smart-data-models/dataModel.Transportation/blob/master/FleetVehicleStatus/LICENSE.md
x-model-schema: https://smart-data-models.github.io/dataModel.Transportation/FleetVehicleStatus/schema.json
x-model-tags: GSMA
x-version: 0.0.1
Here is an example of a FleetVehicleStatus in JSON-LD format as key-values. This is compatible with NGSI-v2 when using options=keyValues
and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:FleetVehicleStatus:16ea1c5c-5aa6-11e8-8144-4b82063ca31c",
"type": "FleetVehicleStatus",
"battery": 0.81,
"source": "https://source.example.com",
"dataProvider": "https://provider.example.com",
"fleetVehicle": "urn:ngsi-ld:FleetVehicle:84c6a3a8-5aa6-11e8-bedc-27e105edd16f",
"fleetVehicleOperation": "urn:ngsi-ld:FleetVehicleOperation:a4f0a07a-5aa6-11e8-b70f-4b9d36e53d7b",
"restFuelAmount": 28,
"lastFuellingAmount": 95,
"currentStatus": "finished",
"currentOperative": {
"givenName": "John Smith",
"jobTitle": "Ambulance Operator"
},
"speed": 60,
"unitCode": "KMH",
"bearing": 80,
"lastKnownPosition": {
"type": "Point",
"coordinates": [
-104.99404,
39.75621
]
},
"lastKnownPositionUpdatedAt": "2016-08-28T10:18:16Z",
"inRestrictedArea": true,
"mileageFromOdometer": 18756
}
Here is an example of a FleetVehicleStatus in JSON-LD format as normalized. This is compatible with NGSI-v2 when not using options and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:FleetVehicleStatus:16ea1c5c-5aa6-11e8-8144-4b82063ca31c",
"type": "FleetVehicleStatus",
"battery": {
"type": "Number",
"value": 0.81
},
"source": {
"type": "Text",
"value": "https://source.example.com"
},
"dataProvider": {
"type": "Text",
"value": "https://provider.example.com"
},
"fleetVehicle": {
"type": "Text",
"value": "urn:ngsi-ld:FleetVehicle:84c6a3a8-5aa6-11e8-bedc-27e105edd16f"
},
"fleetVehicleOperation": {
"type": "Text",
"value": "urn:ngsi-ld:FleetVehicleOperation:a4f0a07a-5aa6-11e8-b70f-4b9d36e53d7b"
},
"restFuelAmount": {
"type": "Number",
"value": 28
},
"lastFuellingAmount": {
"type": "Number",
"value": 95
},
"currentStatus": {
"type": "Text",
"value": "finished"
},
"currentOperative": {
"type": "StructuredValue",
"value": {
"givenName": "John Smith",
"jobTitle": "Ambulance Operator"
}
},
"speed": {
"type": "Number",
"value": 60
},
"bearing": {
"type": "Number",
"value": 80
},
"lastKnownPosition": {
"type": "geo:json",
"value": {
"type": "Point",
"coordinates": [
-104.99404,
39.75621
]
}
},
"lastKnownPositionUpdatedAt": {
"type": "DateTime",
"value": "2016-08-28T10:18:16Z"
},
"inRestrictedArea": {
"type": "Boolean",
"value": true
},
"mileageFromOdometer": {
"type": "Number",
"value": 18756
}
}
Here is an example of a FleetVehicleStatus in JSON-LD format as key-values. This is compatible with NGSI-LD when using options=keyValues
and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:FleetVehicleStatus:16ea1c5c-5aa6-11e8-8144-4b82063ca31c",
"type": "FleetVehicleStatus",
"battery": 0.81,
"bearing": 80,
"currentOperative": {
"givenName": "John Smith",
"jobTitle": "Ambulance Operator"
},
"currentStatus": "finished",
"dataProvider": "https://provider.example.com",
"fleetVehicle": "urn:ngsi-ld:FleetVehicle:84c6a3a8-5aa6-11e8-bedc-27e105edd16f",
"fleetVehicleOperation": "urn:ngsi-ld:FleetVehicleOperation:a4f0a07a-5aa6-11e8-b70f-4b9d36e53d7b",
"inRestrictedArea": true,
"lastFuellingAmount": 95,
"lastKnownPosition": {
"type": "Point",
"coordinates": [
-104.99404,
39.75621
]
},
"lastKnownPositionUpdatedAt": "2016-08-28T10:18:16Z",
"mileageFromOdometer": 18756,
"restFuelAmount": 28,
"source": "https://source.example.com",
"speed": 60,
"unitCode": "KMH",
"@context": [
"https://raw.githubusercontent.com/smart-data-models/dataModel.Transportation/master/context.jsonld"
]
}
Here is an example of a FleetVehicleStatus in JSON-LD format as normalized. This is compatible with NGSI-LD when not using options and returns the context data of an individual entity.
show/hide example
{
"id": "urn:ngsi-ld:FleetVehicleStatus:16ea1c5c-5aa6-11e8-8144-4b82063ca31c",
"type": "FleetVehicleStatus",
"battery": {
"type": "Property",
"value": 0.81,
"observedAt": "2016-08-22T10:18:16Z"
},
"bearing": {
"type": "Property",
"value": 80,
"unitCode": "DD",
"observedAt": "2016-08-22T10:18:16Z"
},
"currentOperative": {
"type": "Property",
"value": {
"givenName": "John Smith",
"jobTitle": "Ambulance Operator"
}
},
"currentStatus": {
"type": "Property",
"value": "finished"
},
"dataProvider": {
"type": "Property",
"value": "https://provider.example.com"
},
"fleetVehicle": {
"type": "Relationship",
"object": "urn:ngsi-ld:FleetVehicle:84c6a3a8-5aa6-11e8-bedc-27e105edd16f"
},
"fleetVehicleOperation": {
"type": "Relationship",
"object": "urn:ngsi-ld:FleetVehicleOperation:a4f0a07a-5aa6-11e8-b70f-4b9d36e53d7b"
},
"inRestrictedArea": {
"type": "Property",
"value": true
},
"lastFuellingAmount": {
"type": "Property",
"value": 95,
"unitCode": "LTR",
"observedAt": "2016-08-22T10:18:16Z"
},
"lastKnownPosition": {
"type": "GeoProperty",
"value": {
"type": "Point",
"coordinates": [
-104.99404,
39.75621
]
}
},
"lastKnownPositionUpdatedAt": {
"type": "Property",
"value": {
"@type": "DateTime",
"@value": "2016-08-28T10:18:16Z"
}
},
"mileageFromOdometer": {
"type": "Property",
"value": 18756,
"unitCode": "SMI",
"observedAt": "2016-08-22T10:18:16Z"
},
"restFuelAmount": {
"type": "Property",
"value": 28,
"unitCode": "LTR",
"observedAt": "2016-08-22T10:18:16Z"
},
"source": {
"type": "Property",
"value": "https://source.example.com"
},
"speed": {
"type": "Property",
"value": 60,
"unitCode": "KMH",
"observedAt": "2016-08-22T10:18:16Z"
},
"@context": [
"https://raw.githubusercontent.com/smart-data-models/dataModel.Transportation/master/context.jsonld"
]
}
See FAQ 10 to get an answer on how to deal with magnitude units