Traveler Information API
Loading...
Searching...
No Matches
Highway Alerts

Classes

class  HighwayAlerts
 
class  Alert
 

Functions

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

Detailed Description

Information about current alerts on state highways

Function Documentation

◆ GetAlert()

Alert HighwayAlerts.GetAlert ( string  AccessCode,
int  AlertID 
)

Retrieves a specific incident.

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

◆ GetAlerts()

Alert[] HighwayAlerts.GetAlerts ( string  AccessCode)

Retrieves an array of currently active incidents.

Parameters
AccessCodeYour Traveler API Access Code.
Returns
Alert[]

◆ GetAlertsAsDataSet()

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

Retrieves a dataset containing currently active incidents.

Parameters
AccessCodeYour Traveler API Access Code.
Returns
Dataset

◆ GetAlertsForMapArea()

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

Return alerts for a specific area

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

◆ GetEventCategories()

string[] HighwayAlerts.GetEventCategories ( )

Selects an array of valid categories to use with SearchAlerts.

Returns
String array containing Event Categories currently in use

◆ GetMapAreas()

Area[] HighwayAlerts.GetMapAreas ( )

Return list of areas and associated IDs

Returns
List of map areas available for queries

◆ SearchAlerts()

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

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[]