WSF Schedule API

API Access Code

Most of the SOAP operations require that an API Access Code be passed either directly to the web method or, for some older service proxies, delivered as part of a SOAP header. The API Access Code is delivered using the APIAccessCode property on the APIAccessHeader object. In order to get a valid API Access Code, please register your email address with the WSDOT Traveler API.

Register »

GetValidDateRange()


Description

This operation retrieves a date range for which schedule data is currently published & available. A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetAllTerminals(TripDateMsg)


Description

This operation retrieves valid departing terminals for a given trip date. A valid trip date may be determined using GetValidDateRange(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetAllTerminalsAndMates(TripDateMsg)


Description

This operation retrieves all valid departing and arriving terminal combinations for a given trip date. A valid trip date may be determined using GetValidDateRange(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetTerminalsAndMatesByRoute(RouteMsg)


Description

This operation provides valid departing and arriving terminal combinations for a given trip date and route. Valid routes may be found by using GetAllRoutes(TripDateMsg). Similarly, a valid trip date may be determined using GetValidDateRange(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetTerminalMates(TerminalMsg)


Description

This operation provides arriving terminals for a given departing terminal and trip date. A valid departing terminal may be found by using GetAllTerminals(TripDateMsg). Similarly, a valid trip date may be determined using GetValidDateRange(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetAllRoutes(TripDateMsg)

GetRoutesByTerminalCombo(TerminalComboMsg)


Description

This operation retrieves the most basic / brief information pertaining to routes. If only a trip date is included, all routes available for that date of travel are returned. If a trip date, departing terminal and arriving terminal are included then routes in the resultset are filtered to match accordingly. Valid departing and arriving terminals may be found using GetAllTerminalsAndMates(TripDateMsg). Similarly, a valid trip date may be determined using GetValidDateRange(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetAllRoutesHavingServiceDisruptions(TripDateMsg)


Description

This operation retrieves the most basic / brief information for routes currently associated with service disruptions. A valid trip date may be determined using GetValidDateRange(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetAllRouteDetails(TripDateMsg)

GetRouteDetailsByTerminalCombo(TerminalComboMsg)

GetRouteDetail(RouteMsg)


Description

This operation retrieves highly detailed information pertaining to routes. If only a trip date is included, all routes available for that date of travel are returned. If a trip date, departing terminal and arriving terminal are included then routes in the resultset are filtered to match accordingly. Along the same lines, including only a trip date and route will filter the resultset to a single route. Valid departing and arriving terminals may be found using GetAllTerminalsAndMates(TripDateMsg) while valid routes may be found using GetAllRoutes(TripDateMsg). Similarly, a valid trip date may be determined using GetValidDateRange(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetActiveScheduledSeasons()


Description

This operation retrieves a summary of active seasons. A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetAllSchedRoutes()

GetSchedRoutesByScheduledSeason(SchedMsg)


Description

This operation provides a listing of routes that are active for a season. For example, "Anacortes / Sidney B.C." may be a valid route, but if it's not scheduled to run during Winter 2014, it won't be returned as part of the Winter 2014 scheduled routes resultset. Results will include all known scheduled routes spanning current and upcoming seasons or, alternatively, results can be filtered to only include scheduled routes for a specific season. Seasons may be determined using GetActiveScheduledSeasons(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetSchedSailingsBySchedRoute(SchedRouteMsg)


Description

This operation provides sailings for a particular scheduled route. Sailings are departure times organized by direction of travel (eastbound / westbound), days of operation groups (daily, weekday, weekend, etc) and, in some cases, date ranges (eg. Early Fall / Late Fall). Sailings largely mimic the groupings of departures found on the printed PDF version of the schedule. Scheduled routes may be determined using GetAllSchedRoutes(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetSchedAllSailingsBySchedRoute(SchedRouteMsg)


Description

This operation provides all sailings for a particular scheduled route. Sailings are departure times organized by direction of travel (eastbound / westbound), days of operation groups (daily, weekday, weekend, etc) and, in some cases, date ranges (eg. Early Fall / Late Fall). Sailings largely mimic the groupings of departures found on the printed PDF version of the schedule. Scheduled routes may be determined using GetAllSchedRoutes(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetAllTimeAdj()


Description

This operation provides a listing of all additions and cancellations that deviate on specific dates from the scheduled times found in the GetSchedSailingsBySchedRoute(SchedRouteMsg) resultset (eg. tidal cancellations affecting Port Townsend departures on 9/9/2014). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetTimeAdjByRoute(RouteBriefMsg)


Description

This operation provides a listing of all additions and cancellations for a route that deviate on specific dates from the scheduled times found in the GetSchedSailingsBySchedRoute(SchedRouteMsg) resultset (eg. tidal cancellations affecting Port Townsend departures on 9/9/2014). A valid route may be determined using GetAllRoutes(TripDateMsg). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetTimeAdjBySchedRoute(SchedRouteMsg)


Description

This operation provides a listing of all additions and cancellations for a scheduled route that deviate on specific dates from the scheduled times found in the GetSchedSailingsBySchedRoute(SchedRouteMsg) resultset (eg. tidal cancellations affecting Port Townsend departures on 9/9/2014). A valid scheduled route may be determined using GetAllSchedRoutes(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetScheduleByTerminalCombo(TerminalComboMsg)

GetScheduleByRoute(RouteMsg)


Description

This operation provides departure times for either a trip date and route or a trip date and terminal combination. The resultset accounts for all contingencies, sailing date ranges and time adjustments. Valid departing and arriving terminals may be found using GetAllTerminalsAndMates(TripDateMsg) while valid routes may be found using GetAllRoutes(TripDateMsg). Similarly, a valid trip date may be determined using GetValidDateRange(). A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetTodaysScheduleByTerminalCombo(TerminalComboTodayMsg)

GetTodaysScheduleByRoute(RouteTodayMsg)


Description

This operation provides today's departure times for either a terminal combination or a route. Valid departing and arriving terminals may be found using GetAllTerminalsAndMates(TripDateMsg) while valid routes may be found using GetAllRoutes(TripDateMsg). For the OnlyRemainingTimes value, please indicate 'true' if departure times prior to now should not be included in the resultset and 'false' if they should be included in the resultset. A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.

GetAllAlerts()


Description

This operation provides alert information tailored for routes, bulletins, service disruptions, etc. A valid API Access Code from the WSDOT Traveler API must be provided.

Please consider using GetCacheFlushDate() to coordinate the caching of this data in your application.