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

  • image required

Nested Object

    • id read-only

String

    • href read-only

Field

    • description required

String

Image caption

    • url required

String

url of image

    • variations required

Field

      • modification required

String

Type of resize done

      • variant required

Nested Object

        • id read-only

String

        • href read-only

Field

        • description required

String

Image caption

        • url required

String

url of image

  • type required

String

[IMAGE|VIDEO]

  • videos required

Field

    • id read-only

String

    • url required

String

Url for videos (vimeo only).

    • bitrate required

String

Bitrate for video

  • video_thumb

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