WSF Vessels API

API Access Code

Most of the REST operations require that an API Access Code be passed as part of the URL string. In order to get a valid API Access Code, please register your email address with the WSDOT Traveler API.

Register »

GET /cacheflushdate


Valid Accept Headers

application/json text/xml


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 /cacheflushdate 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:

/vesselbasics
/vesselbasics/{VesselID}
/vesselaccommodations
/vesselaccommodations/{VesselID}
/vesselstats
/vesselstats/{VesselID}
/vesselverbose
/vesselverbose/{VesselID}

GET /vesselbasics?apiaccesscode={APIAccessCode}

GET /vesselbasics/{VesselID}?apiaccesscode={APIAccessCode}


Valid Accept Headers

application/json text/xml


Description

This operation retrieves the most basic / brief information pertaining to vessels. A VesselID, or unique vessel identifier, may be optionally passed to retrieve a specific vessel. A valid API Access Code from the WSDOT Traveler API must be passed as part of the URL string.

Please consider using /cacheflushdate to coordinate the caching of this data in your application.

GET /vesselaccommodations?apiaccesscode={APIAccessCode}

GET /vesselaccommodations/{VesselID}?apiaccesscode={APIAccessCode}


Valid Accept Headers

application/json text/xml


Description

This operation provides details regarding vessel accommodations (bathrooms, galley, elevator, etc). A VesselID, or unique vessel identifier, may be optionally passed to retrieve a specific vessel. A valid API Access Code from the WSDOT Traveler API must be passed as part of the URL string.

Please consider using /cacheflushdate to coordinate the caching of this data in your application.

GET /vesselstats?apiaccesscode={APIAccessCode}

GET /vesselstats/{VesselID}?apiaccesscode={APIAccessCode}


Valid Accept Headers

application/json text/xml


Description

This operation provides details regarding vessel specifications (engine count, length of vessel, year built, etc). A VesselID, or unique vessel identifier, may be optionally passed to retrieve a specific vessel. A valid API Access Code from the WSDOT Traveler API must be passed as part of the URL string.

Please consider using /cacheflushdate to coordinate the caching of this data in your application.

GET /vessellocations?apiaccesscode={APIAccessCode}

GET /vessellocations/{VesselID}?apiaccesscode={APIAccessCode}


Valid Accept Headers

application/json text/xml


Description

This operation provides vessel locations and associated ETA data. A VesselID, or unique vessel identifier, may be optionally passed to retrieve a specific vessel. A valid API Access Code from the WSDOT Traveler API must be passed as part of the URL string.

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

GET /vesselverbose?apiaccesscode={APIAccessCode}

GET /vesselverbose/{VesselID}?apiaccesscode={APIAccessCode}


Valid Accept Headers

application/json text/xml


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:

/vesselbasics
/vesselbasics/{VesselID}
/vesselaccommodations
/vesselaccommodations/{VesselID}
/vesselstats
/vesselstats/{VesselID}

A VesselID, or unique vessel identifier, may be optionally passed to retrieve a specific vessel. A valid API Access Code from the WSDOT Traveler API must be passed as part of the URL string.

Please consider using /cacheflushdate to coordinate the caching of this data in your application.