WSF Vessels 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:

GetAllVesselBasicDetails()
GetSpecificVesselBasicDetail(VesselMsg request)
GetAllVesselAccommodations()
GetSpecificVesselAccommodation(VesselMsg request)
GetAllVesselStats()
GetSpecificVesselStat(VesselMsg request)
GetAllVesselVerboseDetails()
GetSpecificVesselVerboseDetail(VesselMsg request)

GetAllVesselBasicDetails()

GetSpecificVesselBasicDetail(VesselMsg request)


Description

This operation retrieves the most basic / brief information pertaining to vessels. GetAllVesselBasicDetails retrieves data for all vessels. Meanwhile, GetSpecificVesselBasicDetail is passed a VesselID, or unique vessel identifier, as part of the VesselMsg for cases when only a specific vessel is required. 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.

GetAllVesselAccommodations()

GetSpecificVesselAccommodation(VesselMsg request)


Description

This operation provides details regarding vessel accommodations (bathrooms, galley, elevator, etc). GetAllVesselAccommodations retrieves data for all vessels. Meanwhile, GetSpecificVesselAccommodation is passed a VesselID, or unique vessel identifier, as part of the VesselMsg for cases when only a specific vessel is required. 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.

GetAllVesselStats()

GetSpecificVesselStat(VesselMsg request)


Description

This operation provides details regarding vessel specifications (engine count, length of vessel, year built, etc). GetAllVesselStats retrieves data for all vessels. Meanwhile, GetSpecificVesselStat is passed a VesselID, or unique vessel identifier, as part of the VesselMsg for cases when only a specific vessel is required. 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.

GetAllVesselLocations()

GetSpecificVesselLocation(VesselMsg request)


Description

This operation provides vessel locations and associated ETA data. GetAllVesselLocations retrieves data for all vessels. Meanwhile, GetSpecificVesselLocation is passed a VesselID, or unique vessel identifier, as part of the VesselMsg for cases when only a specific vessel is required. A valid API Access Code from the WSDOT Traveler API must be provided.

This data changes very frequently (potentially every 5 seconds). Please do not cache results in your application for an extended period of time.

GetAllVesselVerboseDetails()

GetSpecificVesselVerboseDetail(VesselMsg request)


Description

This operation retrieves highly detailed information pertaining to vessels. It should be used if you need to reduce the "chattiness" of your application and don't mind receiving a larger payload of data. The results include and expand on what's already available through the following operations:

GetAllVesselBasicDetails()
GetSpecificVesselBasicDetail(VesselMsg request)
GetAllVesselAccommodations()
GetSpecificVesselAccommodation(VesselMsg request)
GetAllVesselStats()
GetSpecificVesselStat(VesselMsg request)

GetAllVesselVerboseDetails retrieves data for all vessels. Meanwhile, GetSpecificVesselVerboseDetail is passed a VesselID, or unique vessel identifier, as part of the VesselMsg for cases when only a specific vessel is required. 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.