Voyages information
This collection returns sail data about our voyages. Only future voyage data is available. The day a voyage starts it can no longer be found using our API.
What information you can retrieve
All voyages
A request to /v1/voyages will return all future voyages:
Example Request
curl -u username:password http://api.seadream.com/v1/voyages
Example Response
Output explained
- yacht - Will have a value of either 1 or 2 which corresponds to the respecitve yacht, SeaDream I or SeaDream II
- region - The name of the geographic region. Possible values: Caribbean, Mediterranean, Trans
- voyage_number - Each voyage has a distinct voyage number. This is usually an integer but it can also be appended by a letter A, B or C, for example "15234B"
- start_date - this is the date when the voyage begins (embarkation). The format is year-month-date
- end_date - this is the date when the voyage ends (disembarkation). The format is year-month-date
- embark - the name of the embarkation port
- disembark - the name of the disembarkation port
- wine_voyage - some voyages have a special wine program. those voyages will have a value of "1". All other voyages will have the value "null"
Back to top ↑
One voyages
A request to /v1/voyages/[voyage number] will return the overview for one specific voyage:
Example Request
curl -u username:password http://api.seadream.com/v1/voyages/21628
Example Response
Output explained
Please see all voyages
Back to top ↑
Itinerary
A request to /v1/voyages/[voyage number]/itinerary will return the itinerary for the specified voyage:
Example Request
curl -u username:password http://api.seadream.com/v1/voyages/21608/itinerary
Example Response
Output explained
- date - format for the date is year-month-day
- arrive - we use a word instead of specifying a time for arrivals and departure with the exception of embarkation and disembarkation days which will have a time interval. If the field is blank it is because we are not moving, for example if we have an overnight in the port from the night before we will technically not arrive the next day
- depart - see "arrive"
- port_name - the name of the port
Back to top ↑
A request to /v1/voyages/[voyage number]/map will return the URIs for maps to the specified voyage. The maps are hosted on a CDN. Maps are available in jpeg format only.
Example Request
curl -u username:password http://api.seadream.com/v1/voyages/21628/map
Example Response
Output explained
- small - URI to a small map (300x150px) in jpg format
- large - URI to a small map (700x350px) in jpg format
Back to top ↑
