WSF Fares 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 »

GetCacheFlushDate()


Description

Some of the retrieval operations in this service return data that changes infrequently. As a result, you may wish to cache it in your application. Use the GetCacheFlushDate() operation to poll for changes. When the date returned from this operation is modified, drop your application cache and retrieve fresh data from the service.

The following operations return data that changes infrequently and can be cached in the manner described above:

GetValidDateRange()
GetAllTerminals(TripDateMsg)
GetTerminalMates(TerminalMsg)
GetTerminalComboDetail(TerminalComboMsg)
GetTerminalComboVerboseDetail(TripDateMsg)
GetFareLineItemsBasic(LineItemMsg)
GetFareLineItems(LineItemMsg)
GetFareLineItemsVerboseDetail(TripDateMsg)
GetFareTotals(FareTotalMsg)

GetValidDateRange()


Description

This operation retrieves a date range for which fares 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.

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.

GetTerminalComboDetail(TerminalComboMsg)


Description

This operation describes what fares are collected for a given departing terminal, arriving terminal and trip date. A valid departing terminal may be found by using GetAllTerminals(TripDateMsg) while a valid arriving terminal may be found by using GetTerminalMates(TerminalMsg). 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.

GetTerminalComboVerboseDetail(TripDateMsg)


Description

This operation retrieves fare collection descriptions for all terminal combinations available on 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.

GetFareLineItemsBasic(LineItemMsg)


Description

This operation retrieves the most popular fares for either round trip or one-way departures available for a given departing terminal, arriving terminal and trip date. A valid departing terminal may be found by using GetAllTerminals(TripDateMsg) while a valid arriving terminal may be found by using GetTerminalMates(TerminalMsg). 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.

GetFareLineItems(LineItemMsg)


Description

This operation retrieves fares for either round trip or one-way departures available for a given departing terminal, arriving terminal and trip date. A valid departing terminal may be found by using GetAllTerminals(TripDateMsg) while a valid arriving terminal may be found by using GetTerminalMates(TerminalMsg). 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.

GetFareLineItemsVerboseDetail(TripDateMsg)


Description

This operation retrieves round trip and one-way fares for all valid departing and arriving terminal combinations on 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.

GetFareTotals(FareTotalMsg)


Description

This operation totals a set of fares & associated quantities for either a round trip or one-way journey, given a departing terminal, arriving terminal and trip date. Use GetFareLineItems(LineItemMsg) to find valid fare line item ID values. Quantity values must be greater than or equal to zero. A valid departing terminal may be found by using GetAllTerminals(TripDateMsg) while a valid arriving terminal may be found by using GetTerminalMates(TerminalMsg). 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.