Traveler Information API
 All Classes Functions Variables Properties
Public Member Functions
HighwayAlerts Class Reference

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

Inheritance diagram for HighwayAlerts:
IHighwayAlerts

List of all members.

Public Member Functions

Alert[] GetAlerts (string AccessCode)
 Retrieves an array of currently active incidents.
System.Data.DataSet GetAlertsAsDataSet (string AccessCode)
 Retrieves a dataset containing currently active incidents.
Alert[] SearchAlerts (string AccessCode, string StateRoute, string Region, DateTime?SearchTimeStart, DateTime?SearchTimeEnd, decimal?StartingMilepost, decimal?EndingMilepost)
 Retrieves an array of incidents that match certain criteria.
Alert GetAlert (string AccessCode, int AlertID)
 Retrieves a specific incident.
string[] GetEventCategories ()
 Selects an array of valid categories to use with SearchAlerts.

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 
)

Retrieves a specific incident.

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

Implements IHighwayAlerts.

Alert [] HighwayAlerts.GetAlerts ( string  AccessCode)

Retrieves an array of currently active incidents.

Parameters:
AccessCodeYour Traveler API Access Code.
Returns:
Alert[]

Implements IHighwayAlerts.

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

Retrieves a dataset containing currently active incidents.

Parameters:
AccessCodeYour Traveler API Access Code.
Returns:
Dataset

Implements IHighwayAlerts.

Selects an array of valid categories to use with SearchAlerts.

Returns:
string array

Implements IHighwayAlerts.

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. Either NC, SC, SW, NW, OL, ER or HQ
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.