WZDxFeed.json

{
  "$id": "https://raw.githubusercontent.com/usdot-jpo-ode/wzdx/main/schemas/2.0/WZDxFeed.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "WZDx v2.0 Feed",
  "description": "The GeoJSON output of a WZDx v2.0 data feed",
  "type": "object",
  "properties": {
    "road_event_feed_info": {
      "$ref": "#/definitions/road_event_feed_info"
    },
    "type": {
      "description": "The GeoJSON type",
      "enum": ["FeatureCollection"]
    },
    "features": {
      "description": "The list of road events (GeoJSON Features)",
      "type": "array",
      "items": {
        "title": "Road Event (GeoJSON Feature)",
        "type": "object",
        "properties": {
          "type": {
            "description": "The GeoJSON Feature type",
            "enum": ["Feature"]
          },
          "properties": {
            "$ref": "#/definitions/road_event"
          },
          "geometry": {
            "oneOf": [
              {
                "$ref": "https://geojson.org/schema/LineString.json"
              },
              {
                "$ref": "https://geojson.org/schema/MultiPoint.json"
              }
            ]
          }
        },
        "required": ["type","properties","geometry"]
      }
    }
  },
  "required": ["road_event_feed_info", "type", "features"],
  "definitions": {
    "road_event_feed_info": {
      "title": "Road Event Feed Information",
      "type": "object",
      "properties": {
        "feed_update_date": {
          "description": "The UTC date and time when the data feed was last updated",
          "type": "string",
          "format": "date-time"
        },
        "metadata": {
          "description": "The URL for an associated metadata file",
          "type": "string"
        },
        "version": {
          "description": "The WZDx specification version used to create the data feed",
          "type": "string"
        }
      },
      "required": ["feed_update_date"]
    },
    "road_event": {
      "title": "Road Event",
      "type": "object",
      "properties": {
        "road_event_id": {
          "description": "A unique identifier issued by the data feed provider to identify the work zone project or activity",
          "type": "string"
        },
        "subidentifier": {
          "description": "A unique identifier issued by data feed provider that provides additional references to project or activity",
          "type": "string"
        },
        "road_name": {
          "description": "Publicly known name of the road on which the event occurs",
          "type": "string"
        },
        "road_number": {
          "description": "The road number designated by a jurisdiction such as a county, state or interstate (e.g. I-5, VT 133)",
          "type": "string"
        },
        "direction": {
          "$ref": "#/definitions/direction"
        },
        "beginning_cross_street": {
          "description": "Name or number of the nearest cross street along the roadway where the event begins",
          "type": "string"
        },
        "ending_cross_street": {
          "description": "Name or number of the nearest cross street along the roadway where the event ends",
          "type": "string"
        },
        "beginning_milepost": {
          "description": "The linear distance measured against a milepost marker along a roadway where the event begins",
          "type": "number",
          "minimum": 0
        },
        "ending_milepost": {
          "description": "The linear distance measured against a milepost marker along a roadway where the event ends",
          "type": "number",
          "minimum": 0
        },
        "beginning_accuracy": {
          "$ref": "#/definitions/spatial_verification"
        },
        "ending_accuracy": {
          "$ref": "#/definitions/spatial_verification"
        },
        "start_date": {
          "description": "The UTC date and time (formatted according to RFC 3339, Section 5.6) when the road event begins (e.g. 2020-11-03T19:37:00Z)",
          "type": "string",
          "format": "date-time"
        },
        "end_date": {
          "description": "The UTC date and time (formatted according to RFC 3339, Section 5.6) when the road event ends (e.g. 2020-11-03T19:37:00Z)",
          "type": "string",
          "format": "date-time"
        },
        "start_date_accuracy": {
          "$ref": "#/definitions/time_verification"
        },
        "end_date_accuracy": {
          "$ref": "#/definitions/time_verification"
        },
        "event_status": {
          "$ref": "#/definitions/event_status"
        },
        "total_num_lanes": {
          "description": "The total number of lanes associated with the road event",
          "type": "integer",
          "exclusiveMinimum": 0
        },
        "vehicle_impact": {
          "$ref": "#/definitions/vehicle_impact"
        },
        "workers_present": {
          "description": "A flag indicating that there are workers present in the road event",
          "type": "boolean"
        },
        "reduced_speed_limit": {
          "description": "The reduced speed limit posted within the road event",
          "type": "integer",
          "minimum": 0
        },
        "restrictions": {
          "description": "Zero or more road restrictions applying to the road event",
          "type": "array",
          "items": {
            "$ref": "#/definitions/road_restriction"
          },
          "uniqueItems": true
        },
        "description": {
          "description": "Short free text description of the road event",
          "type": "string"
        },
        "issuing_organization": {
          "description": "The organization issuing the data feed",
          "type": "string"
        },
        "creation_date": {
          "description": "The UTC date and time (formatted according to RFC 3339, Section 5.6) when the road event was created (e.g. 2020-11-03T19:37:00Z)",
          "type": "string",
          "format": "date-time"
        },
        "update_date": {
          "description": "The UTC date and time (formatted according to RFC 3339, Section 5.6) when the road event was last updated (e.g. 2020-11-03T19:37:00Z)",
          "type": "string",
          "format": "date-time"
        },
        "types_of_work": {
          "description": "A list of the types of work being done in a road event",
          "type": "array",
          "items": {
            "$ref": "#/definitions/type_of_work"
          }
        },
        "lanes": {
          "description": "A list of individual lanes within a road event (roadway segment)",
          "type": "array",
          "items": {
            "$ref": "#/definitions/lane"
          }
        }
      },
      "required": [
        "road_event_id",
        "road_name",
        "direction",
        "beginning_accuracy",
        "ending_accuracy",
        "start_date",
        "end_date",
        "start_date_accuracy",
        "end_date_accuracy",
        "vehicle_impact"
      ]
    },
    "type_of_work": {
      "title": "Type of Work",
      "description": "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",
      "type": "object",
      "properties": {
        "type_name": {
          "$ref": "#/definitions/work_type_name"
        },
        "is_architectural_change": {
          "description": "A flag indicating whether the type of work will result in an architectural change to the roadway",
          "type": "boolean"
        }
      },
      "required": ["type_name"]
    },
    "lane": {
      "title": "Lane",
      "description": "An individual lane within a road event",
      "type": "object",
      "properties": {
        "lane_status": {
          "$ref": "#/definitions/lane_status"
        },
        "lane_type": {
          "$ref": "#/definitions/lane_type"
        },
        "lane_number": {
          "description": "The number (index) assigned to the lane (not including shoulders)",
          "type": "integer",
          "minimum": 0
        },
        "lane_edge_reference": {
          "$ref": "#/definitions/lane_edge_reference"
        },
        "lane_restrictions": {
          "description": "A list of restrictions specific to the lane",
          "type": "array",
          "items": {
            "$ref": "#/definitions/lane_restriction"
          }
        }
      },
      "required": ["lane_status", "lane_type"],
      "dependencies": {
        "lane_number": ["lane_edge_reference"]
      }
    },
    "lane_restriction": {
      "title": "Lane Restriction",
      "description": "A lane-level restriction, including type and value",
      "type": "object",
      "properties": {
        "restriction_type": {
          "$ref": "#/definitions/road_restriction"
        },
        "restriction_value": {
          "type": "number"
        },
        "restriction_units": {
          "$ref": "#/definitions/lane_restriction_unit"
        }
      },
      "dependencies": {
        "restriction_value": ["restriction_units"]
      }
    },
    "direction": {
      "title": "Direction Enumerated Type",
      "description": "The direction for a road event based on standard naming for US roads; indicates the direction the traffic flow regardless of the real heading angle",
      "enum": ["northbound", "eastbound", "southbound", "westbound"]
    },
    "spatial_verification": {
      "title": "Spatial Verification Enumerated Type",
      "description": "An indication of how a geographical coordinate was defined",
      "enum": ["Estimated", "Verified"]
    },
    "time_verification": {
      "title": "Time Verification Enumerated Type",
      "description": "A measure of how accurate the a datetime is",
      "enum": ["Estimated", "Verified"]
    },
    "event_status": {
      "title": "Event Status Enumerated Type",
      "description": "The status of the road event",
      "enum": ["planned", "pending", "active", "completed", "cancelled"]
    },
    "vehicle_impact": {
      "title": "Vehicle Impact Enumerated Type",
      "description": "The impact to vehicular lanes along a single road in a single direction",
      "enum": ["all-lanes-closed", "some-lanes-closed", "all-lanes-open", "alternating-one-way", "unknown"]
    },
    "road_restriction": {
      "title": "Road Restriction Enumerated Type",
      "description": "The type of vehicle restriction on a roadway",
      "enum": [
        "no-trucks",
        "travel-peak-hours-only",
        "hov-3",
        "hov-2",
        "no-parking",
        "reduced-width",
        "reduced-height",
        "reduced-length",
        "reduced-weight",
        "axle-load-limit",
        "gross-weight-limit",
        "towing-prohibited",
        "permitted-oversize-loads-prohibited"
      ]
    },
    "work_type_name": {
      "title": "Work Type Name Enumerated Type",
      "description": "A high-level text description of the type of work being done in a road event",
      "enum": [
        "maintenance",
        "minor-road-defect-repair",
        "roadside-work",
        "overhead-work",
        "below-road-work",
        "barrier-work",
        "surface-work",
        "painting",
        "roadway-relocation",
        "roadway-creation"
      ]
    },
    "lane_edge_reference": {
      "title": "Lane Edge Reference Enumerated Type",
      "description": "The roadside edge from which lane numbers are assigned",
      "enum": ["left", "right"]
    },
    "lane_status": {
      "title": "Lane Status Enumerated Type",
      "description": "The status of the lane for the traveling public",
      "enum": ["open", "closed", "shift-left", "shift-right", "merge-left", "merge-right", "alternating-one-way"]
    },
    "lane_type": {
      "title": "Lane Type Enumerated Type",
      "description": "An indication of the type of lane or shoulder",
      "enum": [
        "all",
        "left-lane",
        "right-lane",
        "left-2-lanes",
        "right-2-lanes",
        "left-3-lanes",
        "right-3-lanes",
        "middle-lane",
        "middle-two-lanes",
        "right-turning-lane",
        "left-turning-lane",
        "right-exit-lane",
        "left-exit-lane",
        "right-merging-lane",
        "left-merging-lane",
        "right-exit-ramp",
        "right-second-exit-ramp",
        "left-exit-ramp",
        "left-second-exit-ramp",
        "right-entrance-ramp",
        "right-second-entrance-ramp",
        "left-entrance-ramp",
        "left-second-entrance-ramp",
        "sidewalk",
        "bike-lane",
        "none",
        "unknown",
        "alternating-flow-lane",
        "outside",
        "inside",
        "both"
      ]
    },
    "lane_restriction_unit": {
      "title": "Lane Restriction Unit Enumerated Type",
      "description": "Units of measure used for the lane restriction value",
      "enum": ["feet", "inches", "centimeters", "pounds", "tons", "kilograms"]
    }
  }
}