ws-dottie
Version:
Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration
162 lines (101 loc) • 5.08 kB
Markdown
# Alert Class Reference
[Highway Alerts](group___highway_alerts.html)
| Column | Column | Column |
| --- | --- | --- |
| Properties | |
| int | [AlertID](class_alert.html#a14aff662d91d781959e6cbfd06aa1b40) `[get, set]` |
| | |
| [RoadwayLocation](class_roadway_location.html) | [StartRoadwayLocation](class_alert.html#a6b6a983eae68afdfac0f49719e88920d) `[get, set]` |
| | |
| [RoadwayLocation](class_roadway_location.html) | [EndRoadwayLocation](class_alert.html#a06cda81c2807737c00980fc69fa1ddb0) `[get, set]` |
| | |
| string | [Region](class_alert.html#aa6e325256ac9294187103c8f286a1d30) `[get, set]` |
| | |
| string | [County](class_alert.html#a659489b040a55d43aeb371f37d5f88b3) `[get, set]` |
| | |
| DateTime? | [StartTime](class_alert.html#a5c4596546bb1800b77701ca8ba2a53ac) `[get, set]` |
| | |
| DateTime? | [EndTime](class_alert.html#a075442e28a9b7bef00cd960c428d57c4) `[get, set]` |
| | |
| string | [EventCategory](class_alert.html#a79af3e4a2cfae757193f11f683593f1d) `[get, set]` |
| | |
| string | [HeadlineDescription](class_alert.html#a5148f378fda6365f3d4ac48095fc13ea) `[get, set]` |
| | |
| string | [ExtendedDescription](class_alert.html#a02f59d4fcfde1b0260d1a97a855f80e5) `[get, set]` |
| | |
| string | [EventStatus](class_alert.html#a0965f3e6416de76256ef894718c65d65) `[get, set]` |
| | |
| DateTime? | [LastUpdatedTime](class_alert.html#a9498b1b4a3e9a583aec114436ca40884) `[get, set]` |
| | |
| string | [Priority](class_alert.html#aec29ba00c8d872009c33803cec9eddb8) `[get, set]` |
| | |
## Detailed Description
A Highway [Alert](class_alert.html "A Highway Alert.").
## Property Documentation
## [◆](#a14aff662d91d781959e6cbfd06aa1b40)AlertID
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | int Alert.AlertID | | getset |
Unique Identifier for the alert.
## [◆](#a659489b040a55d43aeb371f37d5f88b3)County
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | string Alert.County | | getset |
Used for countywide alerts, name of the affected county.
## [◆](#a06cda81c2807737c00980fc69fa1ddb0)EndRoadwayLocation
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | [RoadwayLocation](class_roadway_location.html) Alert.EndRoadwayLocation | | getset |
End location for the alert on the roadway.
## [◆](#a075442e28a9b7bef00cd960c428d57c4)EndTime
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | DateTime? Alert.EndTime | | getset |
Estimated end time for alert.
## [◆](#a79af3e4a2cfae757193f11f683593f1d)EventCategory
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | string Alert.EventCategory | | getset |
Categorization of alert, i.e. Collision, Maintenance, etc.
## [◆](#a0965f3e6416de76256ef894718c65d65)EventStatus
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | string Alert.EventStatus | | getset |
Current status of alert, open, closed.
## [◆](#a02f59d4fcfde1b0260d1a97a855f80e5)ExtendedDescription
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | string Alert.ExtendedDescription | | getset |
Optional - Additional information about the alert, used for relaying useful extra information for an alert.
## [◆](#a5148f378fda6365f3d4ac48095fc13ea)HeadlineDescription
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | string Alert.HeadlineDescription | | getset |
Information about what the alert has been issued for.
## [◆](#a9498b1b4a3e9a583aec114436ca40884)LastUpdatedTime
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | DateTime? Alert.LastUpdatedTime | | getset |
When was alert was last changed.
## [◆](#aec29ba00c8d872009c33803cec9eddb8)Priority
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | string Alert.Priority | | getset |
Expected impact on traffic, highest, high, medium, low.
## [◆](#aa6e325256ac9294187103c8f286a1d30)Region
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | string Alert.Region | | getset |
WSDOT Region which entered the alert, valid values: EA - Eastern, NC - North Central, NW - Northwest, OL - Olympic, SC - South Central, SW - Southwest.
## [◆](#a6b6a983eae68afdfac0f49719e88920d)StartRoadwayLocation
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | [RoadwayLocation](class_roadway_location.html) Alert.StartRoadwayLocation | | getset |
Start location for the alert on the roadway.
## [◆](#a5c4596546bb1800b77701ca8ba2a53ac)StartTime
| Column | Column | Column | Column |
| --- | --- | --- | --- |
| | | | --- | | DateTime? Alert.StartTime | | getset |
When the impact on traffic began.
* [Alert](class_alert.html)
* Generated by [](https://www.doxygen.org/index.html) 1.9.5