Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 3.33 KB

RoadEventCoreDetails.md

File metadata and controls

24 lines (21 loc) · 3.33 KB
Raw

RoadEventCoreDetails Object

The RoadEventCoreDetails object represents the core details of an event occurring on a roadway (i.e. a "road event") that is shared by all types of road events, such as work zones (see WorkZoneRoadEvent), detours (see DetourRoadEvent), and road restrictions (see RestrictionRoadEvent). The RoadEventCoreDetails cannot exist directly in a data feed and on its own does not represent a road event. It is used as the value of core_details property on every specific type of road event, each of which is represented by its own object.

Properties

Name Type Description Conformance Notes
event_type EventType The type/classification of road event. Required
data_source_id String Identifies the data source from which the road event originates. Required The value must match to the data_source_id property of a FeedDataSource included within the same WZDx GeoJSON document.
road_names Array; [String] A list of publicly known names of the road on which the event occurs. This may include the road number designated by a jurisdiction such as a county, state or interstate (e.g. I-5, VT 133). Required
direction Direction The digitization direction of the road that is impacted by the event. This value is based on the standard naming for US roadways and indicates the direction of the traffic flow regardless of the real heading angle. Required Example northbound (for I-5 North)
relationship Relationship Identifies both sequential and hierarchical relationships between the road events and other entities. For example, a relationship can be used to link multiple road events to a common 'parent', such as a project or phase, or identify a sequence of road events Optional
description String Short free text description of road event. Optional
creation_date String; date-time The UTC time and date when the activity or event was created. Optional All datetime formats shall follow RFC 3339 Section 5.6. Example: 2016-11-03T19:37:00Z.
update_date String; date-time The UTC time and date when the activity or event was updated. Optional All datetime formats shall follow RFC 3339 Section 5.6. Example: 2016-11-03T19:37:00Z.

Used By

Property Object
core_details DetourRoadEvent
core_details WorkZoneRoadEvent
core_details RestrictionRoadEvent

Important Notes

The value of the RoadEventCoreDetails's data_source_id property MUST match the value of the data_source_id property of a FeedDataSource that is included in the same WZDx GeoJSON document.