The WZDx specification defines the content and structure of several GeoJSON documents, each intended to be distributed as a data feed. Each GeoJSON document (colloquially "feed") contains a single feed root object. WZDx v4.2 defines the following feed objects:
- WorkZoneFeed: describes high-level information about work zone events occurring on roadways (called "road events") that impact the characteristics of the roadway and involve a change from the default state (such as a lane closure). This is the original work zone data exchange feed and the only feed that WZDx defined until version 4.0. It was previously named
WZDxFeed. - DeviceFeed: describes information (location, status, live data) about field devices deployed on the roadway in work zones.
Each feed object contains many layers of child objects. Together all the objects define the WZDx feed. All WZDx objects are located in the objects subdirectory and listed in the Objects section of this document.
The value of certain object properties is restricted to a defined set of values called an enumerated type. Enumerated types are located in the enumerated-types subdirectory and listed in the Enumerated Types section of this document.
Each WZDx object is described by a table of properties with following columns:
- Name - The property name.
- Type - The type of data being stored. This can be one of the JSON primitive types (only
String,Number,Arrayare used),Integer, as defined in the JSON schema validation specification section 6.1 (Draft 07), a formatted string as defined in JSON schema validation specification section 7 (Draft 07), a WZDx Enumerated Type, a WZDx Object, or a GeoJSON Object. - Description - A description of the value of the property.
- Conformance - An indication of the requirement for including the property in a WZDx GeoJSON document. There are three categories of conformance:
- Required - The property must be included
- Optional - The property may be omitted
- Conditional - The property's inclusion depends on the inclusion or value of a separate property
- Notes - Additional comments, guidance, notes for future consideration, or examples.
This section provides a tabular list of all objects used in the WZDx specification.
The following objects are high-level and describe either a WZDx feed or information about a WZDx feed:
| Object | Description |
|---|---|
| FeedDataSource | Information about a specific data source used to build a work zone data feed. |
| FeedInfo | Information about a WZDx feed such as metadata, contact information, and data sources. |
| DeviceFeed | The root (highest-level) object of WZDx Device Feed GeoJSON document. |
| WorkZoneFeed | The root (highest-level) object of a WZDx Work Zone Feed GeoJSON document. |
The following objects are used to describe events occurring on roadways (road events) that impact the characteristics of the roadway and involve a change from the default state:
| Object | Description |
|---|---|
| CdsCurbZonesReference | A reference to one or more CDS curb zones that are impacted by road work. |
| DetourRoadEvent | A detour on a roadway. |
| Lane | An individual lane within a road event. |
| RelatedRoadEvent | Identification a road event that is related to the road event that the RelatedRoadEvent object occurs on. |
| Restriction | A restriction on a road event or lane, including type and value. |
| RoadEventCoreDetails | The core details of an event occurring on a roadway (i.e. a road event) that is shared by all types of road events. |
| RoadEventFeature | The GeoJSON Feature container object for a WZDx road event. |
| TypeOfWork | A description of the type of work being done in a road event and an indication of if that work will result in an architectural change to the roadway. |
| WorkerPresence | Information about the presence of workers in the road event area. |
| WorkZoneRoadEvent | A work zone road event including where, when, and what activities are taking place within a work zone on a roadway. |
| Relationship (DEPRECATED) | All properties that use this object are deprecated so this object will be removed in a future release, use RelatedRoadEvent instead. Identification of both sequential and hierarchical relationships between road events and other entities. |
The following objects are used to describe deployed roadside ITS devices:
| Object | Description |
|---|---|
| ArrowBoard | An electronic, connected arrow board which can display an arrow pattern to direct traffic. |
| Camera | A camera device deployed in the field, capable of capturing still images. |
| DynamicMessagesSign | An electronic traffic sign deployed on the roadway, used to provide information to travelers. |
| FieldDeviceCoreDetails | The core details—both configuration and current state—of a field device that are shared by all types of field devices. |
| FieldDeviceFeature | The GeoJSON Feature container object for a deployed field device. |
| FlashingBeacon | Describes a flashing warning beacon used to supplement a temporary traffic control device. A flashing warning beacon is mounted on a sign or channelizing device and used to indicate a warning condition and capture driver attention. |
| HybridSign | A hybrid sign that contains static text (e.g. on an aluminum sign) along with a single electronic message display, used to provide information to travelers. |
| LocationMarker | Describes any GPS-enabled ITS device that is placed at a point on a roadway to dynamically know the location of something (often the beginning or end of a work zone). |
| MarkedLocation | Describes a specific location where a LocationMarker is placed, such as the start or end of a work zone road event. |
| TrafficSensor | A traffic sensor deployed on a roadway which captures traffic metrics (e.g. speed, volume, occupancy) over a collection interval. |
| TrafficSensorLaneData | Data for a single lane within a road event (e.g. WorkZoneRoadEvent) measured by a TrafficSensor deployed on the roadway. |
| TrafficSignal | A temporary traffic signal deployed on a roadway. |
The object diagrams below depict the relationship between the data objects for each WZDx feed.
The object diagram below indicates the relationship between the data objects used in the WorkZoneFeed:
The object diagram below indicates the relationship between the data objects used in the DeviceFeed:
When making changes to the specification, the object diagram needs to be updated as well. To modify the object diagram, open /images/WZDx_WorkZoneFeed_object_diagram.drawio or /images/WZDx_DeviceFeed_object_diagram.drawio
at https://app.diagrams.net (or any drawio editor). Make necessary changes to the diagram using the web editor, then download the drawio file and replace the appropriate file in the /images directory with the new file. Additionally export the diagram as a PNG, using the diagram name as the file name, and replace /images/WZDx_WorkZoneFeed_object_diagram.png or /images/WZDx_DeviceFeed_object_diagram.png with the new image file.
Many object properties are restricted to a finite set of values defined by an enumerated type. The enumerations for each enumerated type as well as what object properties it is used by is described in its own file in the enumerated-types directory.
This section provides a tabular list of all enumerated types used in the WZDx specification.
The following enumerated types are used by objects that describe road events:
| Enumerated Type | Description |
|---|---|
| Direction | The direction for a road event based on standard naming for US roads. |
| EventType | The type of a WZDx road event. |
| LaneStatus | The status of a lane for the traveling public. |
| LaneType | An indication of the type of lane or shoulder. |
| LocationMethod | The typical method used to locate the beginning and end of a work zone impact area. |
| RelatedRoadEventType | The type of relationship with a road event that is being identified |
| RestrictionType | The type of vehicle restriction on a roadway or lane. |
| UnitOfMeasurement | Unit of measurement (e.g. "pounds", "centimeters"). |
| VehicleImpact | The impact to vehicular lanes along a single road in a single direction. |
| WorkerPresenceConfidence | High-level description of the feed publisher's confidence in worker presence. |
| WorkerPresenceDefinition | Method of knowing the presence of workers in the road event area. |
| WorkerPresenceMethod | Methods for how worker presence in a work zone event area is determined. |
| WorkTypeName | A high-level text description of the type of work being done in a road event. |
| WorkZoneType | The type of work zone road event. |
| EventStatus (DEPRECATED) | This enumerated type is deprecated and will be removed in a future release The status of a road event. |
| SpatialVerification (DEPRECATED) | This enumerated type is deprecated and will be removed in a future release An indication of how a geographical coordinate was defined. |
| TimeVerification (DEPRECATED) | This enumerated type is deprecated and will be removed in a future release A measure of how accurate a date-time is. |
The following enumerated types are used in describing deployed roadside ITS devices:
| Enumerated Type | Description |
|---|---|
| ArrowBoardPattern | A list of options for the posted pattern on an ArrowBoard. |
| FlashingBeaconFunction | Describes options for what a FlashingBeacon is being used to indicate. |
| HybridSignDynamicMessageFunction | Describes options for the function of the dynamic message displayed by the electronic display on a HybridSign. |
| FieldDeviceStatus | The operational status of a field device. |
| FieldDeviceType | The type of a field device. |
| MarkedLocationType | Describes options for what a MarkedLocation can mark, such as the start or end of a road event. |
| TrafficSignalMode | The current operating mode of a TrafficSignal. |