Introduction

Tour Dossiers¶

A Tour Dossier contains all tour metadata including itinerary, categorization, description, and multimedia content such as images.

The dossier acts as a container for a collection of useful information. Let’s review some useful fields within this object:

structured_itineraries contains a list of itineraries available for a tour dossier. An itinerary contains a structured representation of all activities, meals, transports, starting and finishing locations for a tour. More information can be found in the itineraries documentation. Please note that the itineraries field is deprecated and structured_itineraries should be used in favour of it.
advertised_departures contains a list of sellable departures, segmented by currency. Each object will contain the associated departure, pricing, currency, room, and a relevant promotion if applicable. This field is useful for showing the lowest price of a trip. Additionally, if the list is empty, it can be inferred that there are no sellable departures.
departures contains a link to all departures associated to this tour dossier. These departures will contain their availability, pricing, and all information necessary to display to a consumer.
images contains a list of available images use within your application for website. Please be aware that sizing may vary and it is important you resize these images to fit your content.

There are many more useful fields, but these are specifically important in order to display a tour within your application. Now, let’s review ways to access a tour dossier.

Deprecation of tour_dossiers.itineraries¶

As of November 4th 2019, an itineraries attribute was removed from the Tour Dossier resource. This was communicated over a phased 6-month deprecation.

The alternative? The more robust itineraries object referenced as structured_itineraries within the tour_dossiers resource. This is a more structured implementation of our previous tour details, with some major benefits:

Every day is structured, providing you better control of how to display the data.
Each day has referenced components, detailing the included activities that occur each day.
Each activity and data entry that is applicable, has geo-coordinates supplied via the places object.
It is actively managed and is sourced from our active product management systems.

Effectively, this resource is a powerful and flexible way to display G Adventures tour data. It is also the most accurate, ensuring a better customer experience.

Once the timeline above has passed, we will not revert back, so please update.

Please also do see Using Itineraries For A Tour for a tutorial on fetching relevant Itinerary information from the TOur Dossier

Get a Tour Dossier¶

GET /tour_dossiers/(string: tour_dossier_id)¶

Resource Definition¶

Note

This resource can be searched, allowing to you to access a filtered set of data. See our Searching The G API documentation for details on how to query specific fields and the operators available.

Fields

Name	Type	Description
id read-only	String
href read-only	Field
name required	String	The name of this tour dossier.
slug	String	A version of the `name` field that is more suitable for use inside of a URL. Typically this means: all lowercase letters, hyphens instead of spaces, special characters and very common words removed. Sometimes the `name` field will change, but the slug should remain the same in order to preserve existing URL structures.
product_line required	String	A 1 to 10 character sequence for the tour associated wih this product.
departures_start_date	Date	The earliest `start_date` of a departure for which this dossier is valid.
departures_end_date	Date	The latest `start_date` of a departure for which this dossier is valid.
description	String	A short description of this tour dossier.
booking_companies	Field	The booking_company that provide this tour.
structured_itineraries	Field	A list of itineraries for this tour.
id read-only	String
variation_id read-only	String	The unique identifier of a specific variation of this itinerary
href read-only	Field
valid_during_ranges required	Field	The date ranges when this itinerary variation is valid
start_date required	Date	The first day of a range when this itinerary variation is valid
end_date	Date	The last day of a range when this itinerary variation is valid
details	Field	Additional descriptive details about a tour, classified by the type.
body required	String	The description of the tour detail.
detail_type required	Nested Object	The classification of the detail.
id read-only	String
label required	String	A short descriptive label.
categories	Field	Classification details of the tour.
id read-only	String
href read-only	Field
category_type required	Nested Object	The classification of the category.
id read-only	String
href read-only	Field
label required	String	A short descriptive label.
name required	String	The descriptive name of the caegory.
advertised_departures	Field	A list of price objects, rolled up from all departures on this dossier, for each currency. This is a convenient way to get the lowest price in a specific currency for a tour.
room required	Nested Object	A room may be associated with a price.
code required	String	Unique code identifying the room.
name required	String	Name to identify the room.
departure read-only	Reference Object	The departure containing this price.
previous_amount required	Decimal	The price prior to promotion (if applicable)
currency required	String	Unique code identifying the currency. See currencies.
amount required	Decimal	The promotional price.
promotion read-only	Reference Object	The promotion associated with this price.
geography	Nested Object	Geographical information about the tour.
region	Nested Object	The geographical region in which the tour takes place.
id	String	The Id for the region.
name required	String	The name of this region.
primary_country read-only	Reference Object	The country the tour should be classified under.
start_country read-only	Reference Object	The country the tour begins in.
finish_country read-only	Reference Object	The country the tour finishes in.
visited_countries required	List	Countries the tour visits.
start_city read-only	Reference Object	The begining city of the tour.
finish_city read-only	Reference Object	The end city of the tour.
images	Field	Tour-related images, including the tour map.
type required	String	The classification of the image. Possible values: * MAP * BANNER * BANNER_HIRES
image_href required	String	The fully qualified URL of the image resource. BANNER images will be in landscape format in varying sizes, JPG format. MAP images are mostly 600x600, JPG format, but there are some inconsistencies which we are working to resolve. NOTE: MAP images will be migrated to PNG format in the near future. BANNER_HIRES images will be in land scape format, in varying, hi-res sizes. The image content will match what is in BANNER.
site_links	Field	Tour-related links pointing to gadventures.com
type required	String	The classification of the link. Possible values: * DETAILS * OVERVIEW * PRICING * DETAILS_PDF
href required	String	The fully qualified URL of the site link.
tour read-only	Reference Object	The related tour resource.
departures read-only	Nested Object
relationships read-only	Field	A list for mini adventure relations with rolled up valid during ranges.
type required	Choice	Type of relation.
sub_type	Choice	Sub type of the relation type.
tour_dossier required	Nested Object
id read-only	String
href read-only	Field
product_line required	String	A 1 to 10 character sequence for the tour associated wih this product.
valid_during_ranges	Field	Dates that the relations is valid through.
start_date required	Date	The first day of a range when this itinerary variation is valid
end_date	Date	The last day of a range when this itinerary variation is valid

List Dossiers¶

GET /tour_dossiers¶

Additional Information¶

XML Schema: