CIFS: Waze Closure and Incident Feed Specifications v1.0

Please see the updated CIFS v2.0. Waze will continue to support CIFS v1.0.

General


The Waze feed enables governments, broadcasters and other 3rd parties to share their traffic info with millions of drivers all over the world. The format is simple and closures and construction data are added to the Waze map automatically, reducing congestion and pollution with minimal effort.

The feed needs to contain basic data, detailed below, for each event. That data includes the time frame, the severity of the event’s impact on traffic, the nature of the event and so forth. Here’s what we need to know:

(M) = Mandatory field
(O) = Optional field

Field definition

1. Event Id (M): Each event must have its unique ID. Once an event is created only the relevant content description field may be updated. If an event’s location is changed, a new event must be created instead.

2. Type (M): 4 types: “ROAD_CLOSED”, “CONSTRUCTION”, “ACCIDENT” or “HAZARD”

3. Sub Type (O): “NO_SUBTYPE” or alternatively one of “ACCIDENT_MINOR”, “ACCIDENT_MAJOR", “HAZARD_ON_ROAD", “HAZARD_ON_SHOULDER", “HAZARD_WEATHER", “HAZARD_ON_ROAD_OBJECT", HAZARD_ON_ROAD_POT_HOLE", “HAZARD_ON_ROAD_ROAD_KILL", HAZARD_ON_SHOULDER_CAR_STOPPED", “HAZARD_ON_SHOULDER_ANIMALS", HAZARD_ON_ROAD_CONSTRUCTION", “HAZARD_ON_ROAD_CAR_STOPPED", ROAD_CLOSED_HAZARD", “ROAD_CLOSED_CONSTRUCTION”

4. Start_date (M): Relevant event start time in yyyy-MM-dd HH:mm GMT format. In case all events will be only in one timezone, the gmt offset can be omitted.

6. End_date (O): Additional event related time stamps (if they exist)

7. Description (M): Textual description of event details (40 character max for best driver experience. Limit is 200 characters).

8. Severity (O): Severity level of event, one of the following: “MINOR”, “MAJOR”, HEAVY”

9. Location (M): Send coordinates for affected area. If submission is for road closure, provide BOTH Start and End coordinates.

9.1. Street (M): Name of street on which event is occurring

9.2 Latitude/Longitude (M): Event location coordinates in WGS84 format for either a single location or a range (from, to) are mandatory. They will be correlated with the street related attribute fields for matching to map location.

9.3. Direction (M): Direction of travel affected by event. One of “NORTH", "SOUTH", "EAST", "WEST", "NORTH_WEST", "SOUTH_WEST", "SOUTH_EAST", "SOUTH_WEST", "BOTH_DIRECTIONS”

9.4. Specify End (O): In case of a lengthy event, the end location may be specified

9.4.1. From Cross Street (O): Name of street intersecting with starting point location
9.4.2. End Cross Street (O): Name of street intersecting with end point location

9.4.3 End Latitude/End Longitude (O): End location of event with coordinates in WGS84 format. Required in cases where event has 2 points.

9.5 Recurring (O): If event takes place only on specific days of week and specific hours, format should be as follows:
  • <DOW>=<start time>-<end time>
  • DOW is one of the following: SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY.
  • Start and end times should be in local time.
  • If feed contains data from different timezones, the timezone of the event should be specified with <timezone>.
  • Timezone format can be GMT, LOCAL or GMT offset (ex: GMT+05:00).

9.6 Major Event (O): In case of Major Traffic Event (an event which affects large portion of the local community) with related closures format should include the following: Name of event, type of event, start/end time, date of event, description and additional information.
We may notify users about this event.

Notes

1. Users may indicate “Not there” on certain events, leading to their removal from the map.

2. Fetching of the XML should be made possible at a range between 5 and 10 minutes intervals or less if possible. In case the incident server is down, all the construction alerts will be removed after 1 hour. The alerts will be replaced as soon as the server is back online.

3. Supported protocols and authentication:
3.1 username & password authentication.
3.2 ftp://, sftp://
3.3 http://, https://,
3.4 Limited access by IP address
3.5 gzip file transfer

4. Any parameter can be omitted in cases where it is empty. For example <subtype></subtype> is not required in cases where the subtype is unknown.

5. JSON format is accepted as well.

XML Example (Road Closed)
<?xml version="1.0" encoding="UTF-8"?>
<events>
<event id=”unique_id_ETVEWFWEVT344543”>
<type>ROAD_CLOSED</type>
<subtype></subtype>
<start_date>2014-07-14T12:00:00-07:00 GMT</start_date>
<update_date>2014-07-15T12:30:00-07:00 GMT</update_date>
<end_date>2014-07-21T23:00:00-07:00 GMT</end_date>
<description>The event description to be displayed on the map</description>
<recurring>
<data>SUNDAY=10:00-18:00;MONDAY=12:00-18:00;
     TUESDAY=22:00-05:00;
<data>
<timezone>local</timezone>
</recurring>
<major_event>
<major_event_id>Marathon 2015</major_event_id>
<name>City Marathon</name>
<begins></begins>
<ends></ends>
<type>Marathon</type>
<description>Will take place over many parts of the city</description>
<information>http://event.website.com/event_id</information>
</major_event>
<severity>MAJOR</severity>
<location>
<street>NW 12th St</street>
<city>Miami</city>
<latitude>25.78266</latitude>
<longitude>-80.32359<longitude>
<direction>BOTH_DIRECTIONS</direction>
<specify_end> <!--optional. In this case, latitude and longitude are the start. -->
<from_cross_street>NW 78th Ave</from_cross_street>
<end_cross_street>NW 72nd Ave</end_cross_street>
<end_latitude>25.78264</end_latitude>
<end_longitude>-80.31733</end_longitude>
</specify_end>
</location>
</event>
</events>

The example above would generate something like this:

XML Example (Construction)
For single point event (the start of the construction in one direction) the Example would look like this:
<event id=”unique_id_XFEREF34343”>
<type>CONSTRUCTION</type>
<subtype></subtype>
<start_date>2014-07-15T12:00:00-07:00 GMT</start_date>
<update_date>2014-07-15T12:30:00-07:00 GMT</update_date>
<end_date>2014-07-25T20:00:00-07:00 GMT</end_date>
<description>Planned construction in Leon I-10 west at MM</description>
<severity>MINOR</severity>
<location>
<street>I-10 W</street>
<city>Miami</city>
<latitude>30.47872</latitude>
<longitude>-84.10985<longitude>
<direction>WEST</direction>
<specify_end> <!--optional. empty in this case -->
</specify_end>
</location>
</event>

The example above would generate something like this:

No comments:

Post a Comment