Refactor/relationship

[sknick-iastate]

This pull request addresses the relationship refactoring in Issue #197.

Below is a summary of the major changes for the refactoring:

• Deprecate existing relationship object
• Add new related_road_events object which has attributes specific for the use cases within WZDx
• Added RelatedRoadEventTypes that address various use cases within WZDx including: road event sequence, related detours/work zones, recurring work zones, and moving operations.
• Updated examples to show use of new related_road_events object

A summary of the new object and enumerations include:

related_road_events property on the RoadEvent object (replaces relationship)

Property Name	Value	Description	Conformance	Notes
related_road_events	Array; RelatedRoadEvents	A list describing one or more road events which are related to this road event, such as a work zone project it is part of or another road event that occurs before or after it in sequence.	Optional

RelatedRoadEvents Object

The RelatedRoadEvents object is used to identify another road event that is related to a road event.

Property Name	Value	Description	Conformance	Notes
type	RelatedRoadEventType	The type of road event being identifed, such as another sequence of related work zones, a detour, or next road event in sequence.	Required
id	String	An identifier for the related road event by the type property.	Required

Used By

Property	Object
related_road_events	RoadEventCoreDetails

RelatedRoadEventType Enumerated Type

Describes a type of related road event, such as a work zone project, recurrent work zone, or detour-type road event.

Value	Description
first-in-sequence	The first road event in a sequence of road events that together describe a full work zone or detour
next-in-sequence	The next (subsequent) road event in a sequence of road events that together describe a full work zone or detour
first-occurrence	The first road event of the first occurrence of a recurrent work zone. End users will need to iterate using the first road event to find all relevant road events to a related work zone
next-occurrence	The first road event of the next occurrence of a recurrent work zone. End users will need to iterate using the first road event to find all relevant road events to a related work zone
related-work-zone	First road event of related work zones (i.e. not part of a sequence of road events or recurrent work zone) that are relevant to the given road event. End users will need to iterate using the first road event to find all relevant road events to a related work zone
related-detour	First road event of related detours (i.e. not part of a sequence of road events) that are relevant to the given road event. End users will need to iterate using the first road event to find all relevant road events to a related detour
planned-moving-operation	First road event of a related planned moving operation work zones (i.e. not part of a sequence of road events) that are relevant to the given road event. End users will need to iterate using the first road event to find all relevant road events to a related work zone
active-moving-operation	First road event of a related active moving operation work zones (i.e. not part of a sequence of road events) that are relevant to the given road event. End users will need to iterate using the first road event to find all relevant road events to a related work zone

Used By

Property	Object
type	RelatedRoadEvents

[j-d-b]

/spec-content/README.md needs to be updated with the new object and enumerated type.