Itinerary Highlights¶
Itinerary highlights are dossiers that have additional body text and media (image or vimeo video) that will be featured on trips. The returned structure will be a list containing objects looking like:
{
"id": "<Integer:Dossier id>",
"name": "<String:Dossier name>",
"description": "<String:Dossier Highlight description>",
"media": "<Mixed media object (see itinerary_media)>"
}
Fields
Name |
Type |
Description |
---|---|---|
id read-only |
String |
|
href read-only |
Field |
|
type required |
String |
The type of this resource. |
name required |
String |
Dossier name |
description required |
String |
Highlight body text |
media required |
Nested Object |
|
|
Nested Object |
|
|
String |
|
|
Field |
|
|
String |
Image caption |
|
String |
url of image |
|
Field |
|
|
String |
Type of resize done |
|
Nested Object |
|
|
String |
|
|
Field |
|
|
String |
Image caption |
|
String |
url of image |
|
String |
[IMAGE|VIDEO] |
|
Field |
|
|
String |
|
|
String |
Url for videos (vimeo only). |
|
String |
Bitrate for video |
|
String |
Thumb for videos to display in slider. |
used_on_days read-only |
List |
Which days of the Itinerary Version each highlight is used on |
Get an Itinerary Highlight
- GET /itineraries/(string: itinerary_id)/(string: variation_id)/itinerary_highlights¶
Request
curl -H "X-Application-Key: YOUR_APPLICATION_KEY"
https://rest.gadventures.com/itineraries/2222/2563/itinerary_highlights
Response
{ "count": 3, "max_per_page": 50, "current_page": 1, "links": [], "results": [ { "id": "13325", "href": "https://rest.gadventures.com/activity_dossiers/13325", "type": "activity_dossiers", "name": "Barefoot College Visit", "description": "Barefoot College is an NGO in Jaipur that provides basic solutions to a variety of issues concerning rural India. Meet with some of the college’s administrators to learn about the initiative’s advances in clean water, education, and the empowerment of women.", "media": { "image": { "id": "3982", "href": "https://rest.gadventures.com/images/3982", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/2iStock_000011981423_Large.jpg", "variations": [ { "modification": "itinerary_lg", "variant": { "id": "3780", "href": "https://rest.gadventures.com/images/3780", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/variants/itinerary_lg_2iStock_000011981423_Large.jpg" } }, { "modification": "itinerary_sq", "variant": { "id": "2007", "href": "https://rest.gadventures.com/images/2007", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/variants/itinerary_sq_2iStock_000011981423_Large.jpg" } }, { "modification": "itinerary_mobi", "variant": { "id": "2008", "href": "https://rest.gadventures.com/images/2008", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/variants/itinerary_mobi_2iStock_000011981423_Large.jpg" } } ] }, "type": "IMAGE", "videos": null, "video_thumb": null }, "used_on_days": [ 11 ] }, { "id": "620", "href": "https://rest.gadventures.com/activity_dossiers/620", "type": "activity_dossiers", "name": "City Walk", "description": "Explore the streets of Delhi with an adolescent tour guide from the G Adventures-supported New Delhi Streetkids Project. As a former street child, your local guide will have a unique perspective on the city and can provide more information on the life of a child in India. The guided tour helps support the guide's college or university tuition.", "media": { "image": { "id": "3648", "href": "https://rest.gadventures.com/images/3648", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/2India-New-Delhi-Street-Kids-Project-Planeterra-Travellers-CEO-Oana-Dragan-2013-IMG0195-Lg-RGB.jpg", "variations": [ { "modification": "itinerary_lg", "variant": { "id": "3641", "href": "https://rest.gadventures.com/images/3641", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/variants/itinerary_lg_2India-New-Delhi-Street-Kids-Project-Planeterra-Travellers-CEO-Oana-Dragan-2013-IMG0195-Lg-RGB.jpg" } }, { "modification": "itinerary_sq", "variant": { "id": "1855", "href": "https://rest.gadventures.com/images/1855", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/variants/itinerary_sq_2India-New-Delhi-Street-Kids-Project-Planeterra-Travellers-CEO-Oana-Dragan-2013-IMG0195-Lg-RGB.jpg" } }, { "modification": "itinerary_mobi", "variant": { "id": "1856", "href": "https://rest.gadventures.com/images/1856", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/variants/itinerary_mobi_2India-New-Delhi-Street-Kids-Project-Planeterra-Travellers-CEO-Oana-Dragan-2013-IMG0195-Lg-RGB.jpg" } } ] }, "type": "IMAGE", "videos": null, "video_thumb": null }, "used_on_days": [ 2 ] }, { "id": "610", "href": "https://rest.gadventures.com/activity_dossiers/610", "type": "activity_dossiers", "name": "Taj Mahal Visit", "description": "Cross one off your bucket list as you visit one of the Seven Wonders of the World. Explore the gorgeous white marble mausoleum, built by the Mughal Emperor Shah Jahan as a testament of his love for his favorite wife, Mumtaz Mahal. ", "media": { "image": { "id": "3651", "href": "https://rest.gadventures.com/images/3651", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/2India-Agra-Taj-Mahal-Sunrise-IS-9176503-Lg-RGB.jpg", "variations": [ { "modification": "itinerary_lg", "variant": { "id": "3653", "href": "https://rest.gadventures.com/images/3653", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/variants/itinerary_lg_2India-Agra-Taj-Mahal-Sunrise-IS-9176503-Lg-RGB.jpg" } }, { "modification": "itinerary_sq", "variant": { "id": "1861", "href": "https://rest.gadventures.com/images/1861", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/variants/itinerary_sq_2India-Agra-Taj-Mahal-Sunrise-IS-9176503-Lg-RGB.jpg" } }, { "modification": "itinerary_mobi", "variant": { "id": "1862", "href": "https://rest.gadventures.com/images/1862", "description": null, "url": "https://betamedia.gadventures.com/media-server/image_library/variants/itinerary_mobi_2India-Agra-Taj-Mahal-Sunrise-IS-9176503-Lg-RGB.jpg" } } ] }, "type": "IMAGE", "videos": null, "video_thumb": null }, "used_on_days": [ 14 ] } ] }