Traveler Information API
HighwayAlerts Class Reference
+ Inheritance diagram for HighwayAlerts:

Public Member Functions

Alert[] GetAlerts (string AccessCode)
 
System.Data.DataSet GetAlertsAsDataSet (string AccessCode)
 
Alert[] SearchAlerts (string AccessCode, string StateRoute, string Region, DateTime?SearchTimeStart, DateTime?SearchTimeEnd, decimal?StartingMilepost, decimal?EndingMilepost)
 
Alert GetAlert (string AccessCode, int AlertID)
 
Alert[] GetAlertsForMapArea (string AccessCode, string MapArea)
 
string[] GetEventCategories ()
 
Area[] GetMapAreas ()
 

Detailed Description

Coverage Area: Statewide. Provides access to all of the active incidents currently logged in our ROADS system.

Member Function Documentation

Alert HighwayAlerts.GetAlert ( string  AccessCode,
int  AlertID 
)
inline

Retrieves a specific incident.

Parameters
AccessCodeYour Traveler API Access Code.
AlertIDAlertID for a specific incident.
Returns
Alert

Implements IHighwayAlerts.

Alert [] HighwayAlerts.GetAlerts ( string  AccessCode)
inline

Retrieves an array of currently active incidents.

Parameters
AccessCodeYour Traveler API Access Code.
Returns
Alert[]

Implements IHighwayAlerts.

System.Data.DataSet HighwayAlerts.GetAlertsAsDataSet ( string  AccessCode)
inline

Retrieves a dataset containing currently active incidents.

Parameters
AccessCodeYour Traveler API Access Code.
Returns
Dataset

Implements IHighwayAlerts.

Alert [] HighwayAlerts.GetAlertsForMapArea ( string  AccessCode,
string  MapArea 
)
inline

Return alerts for a specific area

Parameters
AccessCodeYour Traveler API Access Code.
MapAreaThe area to limit results to
Returns
List of alerts

Implements IHighwayAlerts.

string [] HighwayAlerts.GetEventCategories ( )
inline

Selects an array of valid categories to use with SearchAlerts.

Returns
String array containing Event Categories currently in use

Implements IHighwayAlerts.

Area [] HighwayAlerts.GetMapAreas ( )
inline

Return list of areas and associated IDs

Returns
List of map areas available for queries

Implements IHighwayAlerts.

Alert [] HighwayAlerts.SearchAlerts ( string  AccessCode,
string  StateRoute,
string  Region,
DateTime?  SearchTimeStart,
DateTime?  SearchTimeEnd,
decimal?  StartingMilepost,
decimal?  EndingMilepost 
)
inline

Retrieves an array of incidents that match certain criteria.

Parameters
AccessCodeYour Traveler API Access Code.
StateRouteOptional. A State Route formatted as a three digit number. I-5 would be 005.
RegionOptional. Use the integer code as follows: 8 - North Central, 11 - South Central, 12 - Southwest, 9 - Northwest, 10 - Olympic, 7 - Eastern
SearchTimeStartOptional. Will only find alerts occuring after this time.
SearchTimeEndOptional. Will only find alerts occuring before this time.
StartingMilepostOptional. Will only find alerts after this milepost.
EndingMilepostOptional. Will only find alerts before this milepost.
Returns
Alert[]

Implements IHighwayAlerts.