document generated automatically
Global description: CrowdFlowObserved
version: 0.0.2
[*] 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/TextaverageCrowdSpeed[number]: Average speed of the crowd transiting during the observation period . Model: https://schema.org/NumberaverageHeadwayTime[number]: Average headway time. Headway time is the time
elapsed between two consecutive persons . Model: https://schema.org/Numbercongested[boolean]: Flags whether there was a crowd congestion during the observation period in the referred walkway. The absence of this attribute means no crowd congestion . Model: https://schema.org/BooleandataProvider[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 platformdateObserved[string]: The date and time of this observation in ISO8601 UTC format. It can be represented by an specific time instant or by an ISO8601 interval. As a workaround for the lack of support of Orion Context Broker for datetime intervals, it can be used two separate attributes:dateObservedFrom,dateObservedTo. Model: https://schema.org/URLdateObservedFrom[date-time]: Observation period start date and time. SeedateObserved. Model: https://schema.org/DateTimedateObservedTo[date-time]: Observation period end date and time. SeedateObserved. . Model: https://schema.org/DateTimedescription[string]: A description of this itemdirection[string]: Usual direction of travel in the walkway referred by this observation with respect to the city center. Enum:'inbound, outbound' . Model: https://schema.org/Textid[*]: Unique identifier of the entitylocation[*]: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygonname[string]: The name of this itemoccupancy[number]: Fraction of the observation time where a person has been occupying the observed walkway . Model: https://schema.org/Number))owner[array]: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)peopleCount[number]: Total number of people detected during this observationrefRoadSegment[*]: Concerned road segment on which the observation has been made . Model: https://schema.org/URLseeAlso[*]: 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 objecttype[string]: NGSI Entity type. It has to be CrowdFlowObserved
Required properties
dateObservedidtype
An observation related to the movement of people at a certain place and time.
Sorted alphabetically (click for details)
full yaml details
CrowdFlowObserved:
description: CrowdFlowObserved
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
averageCrowdSpeed:
description: Average speed of the crowd transiting during the observation period
minimum: 0
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
units: Kilometer per hour (Km/h).
averageHeadwayTime:
description: |-
Average headway time. Headway time is the time
elapsed between two consecutive persons
minimum: 0
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
units: second (s)
congested:
description: Flags whether there was a crowd congestion during the observation period in the referred walkway. The absence of this attribute means no crowd congestion
type: boolean
x-ngsi:
model: https://schema.org/Boolean
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
dateObserved:
description: 'The date and time of this observation in ISO8601 UTC format. It can be represented by an specific time instant or by an ISO8601 interval. As a workaround for the lack of support of Orion Context Broker for datetime intervals, it can be used two separate attributes: `dateObservedFrom`, `dateObservedTo`'
type: string
x-ngsi:
model: https://schema.org/URL
type: Property
dateObservedFrom:
description: Observation period start date and time. See `dateObserved`
format: date-time
type: string
x-ngsi:
model: https://schema.org/DateTime
type: Property
dateObservedTo:
description: Observation period end date and time. See `dateObserved`.
format: date-time
type: string
x-ngsi:
model: https://schema.org/DateTime
type: Property
description:
description: A description of this item
type: string
x-ngsi:
type: Property
direction:
description: 'Usual direction of travel in the walkway referred by this observation with respect to the city center. Enum:''inbound, outbound'''
enum:
- inbound
- outbound
type: string
x-ngsi:
model: https://schema.org/Text
type: Property
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
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
name:
description: The name of this item
type: string
x-ngsi:
type: Property
occupancy:
description: Fraction of the observation time where a person has been occupying the observed walkway
maximum: 1
minimum: 0
type: number
x-ngsi:
model: https://schema.org/Number)
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
peopleCount:
description: Total number of people detected during this observation
minimum: 0
type: number
x-ngsi:
type: Property
refRoadSegment:
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: Concerned road segment on which the observation has been made
x-ngsi:
model: https://schema.org/URL
type: Relationship
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
type:
description: NGSI Entity type. It has to be CrowdFlowObserved
enum:
- CrowdFlowObserved
type: string
x-ngsi:
type: Property
required:
- id
- type
- dateObserved
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/CrowdFlowObserved/LICENSE.md
x-model-schema: https://smart-data-models.github.io/dataModel.Transportation/CrowdFlowObserved/schema.json
x-model-tags: ""
x-version: 0.0.2 Here is an example of a CrowdFlowObserved 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:CrowdFlowObserved:Valladolid_1",
"type": "CrowdFlowObserved",
"dateObserved": "2018-08-07T11:10:00/2018-08-07T11:15:00",
"dateObservedFrom": "2018-08-07T11:10:00Z",
"dateObservedTo": "2018-08-07T11:15:00Z",
"peopleCount": 100,
"averageHeadwayTime": 5,
"congested": false,
"direction": "inbound",
"location": {
"type": "LineString",
"coordinates": [
[
-4.73735395519672,
41.6538181849672
],
[
-4.73414858659993,
41.6600594193478
],
[
-4.73447575302641,
41.659585195093
]
]
}
} Here is an example of a CrowdFlowObserved 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:CrowdFlowObserved:Valladolid_1",
"type": "CrowdFlowObserved",
"dateObserved": {
"type": "DateTime",
"value": "2018-08-07T11:10:00"
},
"direction": {
"type": "Text",
"value": "inbound"
},
"dateObservedFrom": {
"type": "DateTime",
"value": "2018-08-07T11:10:00Z"
},
"peopleCount": {
"type": "Number",
"value": 100
},
"averageHeadwayTime": {
"type": "Number",
"value": 5
},
"dateObservedTo": {
"type": "DateTime",
"value": "2018-08-07T11:15:00Z"
},
"location": {
"type": "geo:json",
"value": {
"type": "LineString",
"coordinates": [
[
-4.73735395519672,
41.6538181849672
],
[
-4.73414858659993,
41.6600594193478
],
[
-4.73447575302641,
41.659585195093
]
]
}
},
"congested": {
"type": "Boolean",
"value": false
}
} Here is an example of a CrowdFlowObserved 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:CrowdFlowObserved:Valladolid_1",
"type": "CrowdFlowObserved",
"averageHeadwayTime": 5,
"congested": false,
"dateObserved": "2018-08-07T11:10:00/2018-08-07T11:15:00",
"dateObservedFrom": "2018-08-07T11:10:00Z",
"dateObservedTo": "2018-08-07T11:15:00Z",
"direction": "inbound",
"location": {
"coordinates": [
[
-4.73735395519672,
41.6538181849672
],
[
-4.73414858659993,
41.6600594193478
],
[
-4.73447575302641,
41.659585195093
]
],
"type": "LineString"
},
"peopleCount": 100,
"@context": [
"https://raw.githubusercontent.com/smart-data-models/dataModel.Transportation/master/context.jsonld"
]
} Here is an example of a CrowdFlowObserved 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:CrowdFlowObserved:Valladolid_1",
"type": "CrowdFlowObserved",
"averageHeadwayTime": {
"type": "Property",
"value": 5
},
"congested": {
"type": "Property",
"value": false
},
"dateObserved": {
"type": "Property",
"value": {
"@type": "DateTime",
"@value": "2018-08-07T11:10:00"
}
},
"dateObservedFrom": {
"type": "Property",
"value": {
"@type": "DateTime",
"@value": "2018-08-07T11:10:00Z"
}
},
"dateObservedTo": {
"type": "Property",
"value": {
"@type": "DateTime",
"@value": "2018-08-07T11:15:00Z"
}
},
"direction": {
"type": "Property",
"value": "inbound"
},
"location": {
"type": "GeoProperty",
"value": {
"type": "LineString",
"coordinates": [
[
-4.73735395519672,
41.6538181849672
],
[
-4.73414858659993,
41.6600594193478
],
[
-4.73447575302641,
41.659585195093
]
]
}
},
"peopleCount": {
"type": "Property",
"value": 100
},
"@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