Skip to content

Latest commit

 

History

History
22 lines (19 loc) · 2.89 KB

FeedInfo.md

File metadata and controls

22 lines (19 loc) · 2.89 KB
Raw

FeedInfo Object

The FeedInfo object describes TDx feed header information such as metadata, contact information, and data sources. There is one FeedInfo per TDx GeoJSON document.

This object was initially developed for the WZDx Specification.

Properties

Name Type Description Conformance Notes
publisher String The organization responsible for publishing the feed. Required Example: State DOT
version String The TDx specification version used to create the data feed in major.minor format. Note this mandates that all data in a TDx feed complies to a single version of TDx. Required Examples: 1.1, 2.0
license String; uri; "https://creativecommons.org/publicdomain/zero/1.0/" The URL of the license that applies to the data in the TDx feed. This must be the string "https://creativecommons.org/publicdomain/zero/1.0/". Optional Data in all public TDx feeds must be licensed under the Creative Commons - Public Domain License (CC0) which permits consumers to freely publish the enclosed information. This property is currently optional but will be required in a future release.
data_sources Array; [FeedDataSource] A list of specific data sources for the road event data in the feed. Required Length of array must be at least one.
update_date String; date-time The UTC date and time when the GeoJSON file (representing the instance of the feed) was generated. Required The recency of the value of this property depends on if the feed producer is generating a new feed GeoJSON file for each request or generating the file in advance and making it available for download (TDx does not mandate a particular distribution method). Note all date-time formats shall follow RFC 3339 Section 5.6. Example: 2016-11-03T19:37:00Z
Please see Business Rule #5.
update_frequency Integer The frequency in seconds at which the data feed is updated. Optional Example: 60
contact_name String The name of the individual or group responsible for the data feed. Optional Example: Jo Help
contact_email String; email The email address of the individual or group responsible for the data feed. Optional Example: [email protected]

Used By

Property Object
feed_info RoadIncidentFeed
feed_info RoadRestrictionFeed