Content Response

The contents factsheet contains information at service level. It can also contain information at modality level that is added to the service information or replaces the existing information.

Example:

A)

  • Service “Loro Park Wild Park”
  • Commercial description: “Exciting natural park in Tenerife”
  • Incudes: Tour, Lunch
  • Does not include: Audioguide

For the given service above, the following modalities are defined that change some specific attributes in the contents factsheet:

B)

  • Modality “General”
  • Does not include: Transport

C)

  • Commercial Description: “Visit Loro Park with transfer”
  • Modality “With transport”
  • Includes: Transport

In the evevnt that the contents factsheet is requested without specifying a modality code, the A set of data is returned.

On the contrary if the general “General” modality is specified in the request, then “Transport” is added to the “Does not include” list.

Additionally, if the “With transport” modality is requested, the commercial description changes and a “Includes” item “Transport” is added to the contents.

Before getting into details with the response specification a brief description of what the contents are and how those are linked to the content factsheet is relevant to obe done.

  • Fachtseet Type: It’s an activity classification from a contents perspective. The following are the different types of activity:
  • Attractions
  • Activities
  • Events
  • Hop-on-hop-off buses or cruises
  • Tours
  • Bundle
  • Description: Commercial description, use it to explain to your customer what the activity is. This is the catchy description use that also is multi-language.
  • Summary: Most important details for the activity returned as a text. It can be used in a product showroom or as a heading in a product detail page.
  • Name: Activity Name that details what it is (i.e. Unversal Orlando ticket)
  • Highlights: Set of short sentences that describe the most important details of the activity. The summary and highlights should be enough for a final customer to understand what’s going to buy.
  • Advanced Tips: Advises for the final customer to be taken into consideration. I.e.: For a Disney ticket: “Book restaurants at least ten days before visiting the park”
  • Detailed Information: Tooltip for the service or modality. Short sentence with extra info intended to be used near the service or modality name.
  • Features: Generic concepts that can be included or not when the final customer enjoys the activity. Features are defined dynamically in groups and classified also dynamically in types. Group codes and type codes shouldn’t be mapped.
  • Guiding Options: If the activity includes a guide, details regarding the guide, language and other relevant information of the guide.
  • Locations: in the event of happening on a particular address the exact details of it will be provided
  • Starting Points and End Points: In the event of an activity starts in a different point to its location (i.e. because a bus is picking up the final customer and bringing to the location) a starting point is provided. Same concept if the activity is finishing in a different location to the activity location.
  • Media, Audio, Video and others: Pictures, videos and documents that can be used to improve the sales experience.
  • Notes: Incidents or temporary events that may happen and are informed. I.e.: Between 24 and 27 March, due to the eastern holidays, the main entrance to the park is moved to the east side.
  • Redeem Info: Information on how to get access to the activity. I.e: “Pick your ticket in Times Square and then walk to broadway”.
  • Routes: If it’s a tour that is running along a list of well known points, they are returned here including media files, gps position and other details.
  • Scheduling: Activity schedule and opening times.
  • Segmentation: Groups of attributes that categorize the activity. I.e: “For families” or “Sightseeing and tours”.
  • Venues: List of venues from different geolocation engines. For example, Foursquare or Facebook. An activity can be linked to a single venue or more than one and they are provided in a list for the integrated client to link with the venue ids they are using.

The following are the detailed specifications for each concept above including all the attributes that will be returned by the API call.

IMPORTANT: All the information provided in the content and that is detailed here is the same content that is returned in the Detail Response and Booking Detail Response however, the structure of the content does not commence with "activitiesContent/" but with "activity/content/" However, all fields are the exact same. Please refer to the following so that you have a guidance when each content field appears in the response of which operation.

 

RESPONSE

NODE/ATTRIBUTE

TYPE

DESCRIPTION

operationId

String

Operation id, you may be asked to provide it in the event you are requesting support for an issue.

errors

List<Error>

Errors generated in the operation. See the error catalog for details.

errors/@code

String

Error code

errors/@text

String

Error description

auditData

Element

This element and its attributes contains internal information. You can provide it in the event of needing specific support.

pagination

Element

This element indicates the values for pagination

pagination/@itemsPerPage

Integer

Number of items per page

pagination/@page

Integer

Number of page

pagination/@totalItems

Integer

Total items returned in the search including the ones in the current page.

activitiesContent

List<FactsheetActivity>

Activity Factsheet

activitiesContent/@activityFactsheetType

ActivityFactsheetType

Activity type described in the facsheet. Valid values are:

  • Attractions
  • Activities
  • Events
  • Hop-on-hop-off /buses or cruises
  • Tours
  • Bundle
  • Pass cards

 

activitiesContent/@activityCode

String

The contents factsheet is linked to the activity code returned. It is returned if the contents factsheet were requested by activity code.

activitiesContent/@modalityCode

String

If the contents factsheet was requested by modality code, the code requested is returned back here.

activitiesContent/@contentId

String

Contents facsheet id.

activitiesContent/@description

String

Basic description.

activitiesContent/@lastUpdate

Date

Date and time of the last update performed on any section of the contents factsheet.

activitiesContent/@summary

String

Text with a summary of the activity.

activitiesContent/@name

String

Name of activity

activitiesContent/@advancedTips

List<String>

List of advanced tips (see above for deatails)

activitiesContent/@highligths

List<String>

List of highligths (see above for details)

activitiesContent/@detailedInfo

List<String>

Detailed information returned as a list of text ítems.

activitiesContent/featureGroups

List<Feature>

List of activity features

activitiesContent/featureGroups/@groupCode

FeatureGroupType

Features are returned in groups. Here the group code is returned. Group and feature codes are dynamic information, so we strongly recommend not to map the information to your website sections or other elements.

activitiesContent/featureGroups/excluded

List<FeatureDetail>

Since features can be included or excluded for the activity, the excluded ones are returned in this element.

activitiesContent/featureGroups/excluded/@featureType

FeatureIncExcType

Feature type.

activitiesContent/featureGroups/excluded/@description

String

Feature description.

activitiesContent/featureGroups/included

List<FeatureDetail>

Since features can be included or excluded for the activity, the included ones are returned in this element.

activitiesContent/featureGroups/included/@featureType

FeatureIncExcType

Feature type.

activitiesContent/featureGroups/included/@description

String

Feature description.

activitiesContent/guidingOptions

GuidingOptions

If the activity is a guided activity, the following attributes provide details of the attributes of the guiding.

activitiesContent/guidingOptions/@groupType

GuideGroupType

Guide group type

activitiesContent/guidingOptions/@guideType

GuideType

Guide type, one of the following can be returned:

  • G: Guide
  • A: Audio Guide
  • GA: Guide and  Audio Guide
  • N: Not Included

 

activitiesContent/guidingOptions/@included

Boolean

Indicates if this option are included.

activitiesContent/guidingOptions/@maxGroupSize

Integer

Group maximum size.

activitiesContent/guidingOptions/@tips

GuideTipType

Information regarding tips. If the activity type is a tour, then the following values can be returned:

  • I: Already included
  • O: Optional

activitiesContent/@importantInfo

List<String>

List of texts with important information about this activity. See before the table for more details.

activitiesContent/location

Location

Activity location

activitiesContent/location/endPoints

List<LocationPoint>

End points of activity

activitiesContent/location/endPoints/@type

LocationPointType

Type of location point. It can be one of the following:

  • S: Same as Starting Point
  • O: Other

activitiesContent/location/endPoints/meetingPoint

PointOfInterest

Meeting point of this activity

activitiesContent/location/endPoints/meetingPoint/@address

String

Meeting point address

activitiesContent/location/endPoints/meetingPoint/@city

String

Meeting point city

activitiesContent/location/endPoints/meetingPoint/@code

String

Meeting point code

activitiesContent/location/endPoints/meetingPoint/Country

Country

Meeting point country

activitiesContent/location/endPoints/meetingPoint/Country/@code String Country code
activitiesContent/location/endPoints/meetingPoint/Country/@name String Description of the country code
activitiesContent/location/endPoints/meetingPoint/Country/destinations List<Destinations> List of destinations included in the country for the particular content factsheet
activitiesContent/location/endPoints/meetingPoint/Country/destinations/@code String Country Code
activitiesContent/location/endPoints/meetingPoint/Country/destinations/@name String Description of the country code

activitiesContent/location/endPoints/meetingPoint/@description

String

Meeting point description

activitiesContent/location/startPoints/meetingPoint/Coordinate geolocation Provides all GeoLocation GPS coordinates

activitiesContent/location/endPoints/meetingPoint/Coordinate/@latitude

BigDecimal

Meeting point latitude

activitiesContent/location/endPoints/meetingPoint/Coordinate/@longitude

BigDecimal

Meeting point Longitude

activitiesContent/location/endPoints/meetingPoint/@type

PointOfInterestType

Type of Meeting point

activitiesContent/location/endPoints/meetingPoint/@zip

String

Meeting point Zip Code

activitiesContent/location/endPoints/meetingPoint/@area

List<Area>

Meeting point areas. An area is a part of the meeting point. i.e. in an airport it could be “second floor east”, “parking, ground floor” or “arrivals”

activitiesContent/location/endPoints/pickupInstructions

List<DuoTypeDescription>

Pickup instructions. They can be provided to the final customer to understand how to get into the activity.

activitiesContent/location/endPoints/pickupInstructions/@description

String

Pickup instruction description

activitiesContent/location/endPoints/pickupInstructions/@code

String

Name of instructions pickup

activitiesContent/location/startPoints

List<LocationPoint>

Start point of activity

activitiesContent/location/startPoints/@type

LocationPointType

Type of location point

activitiesContent/location/startPoints/meetingPoint

PointOfInterest

Meeting point of this activity

activitiesContent/location/startPoints/meetingPoint/@address

String

Starting point address

activitiesContent/location/startPoints/meetingPoint/@city

String

Starting point city

activitiesContent/location/startPoints/meetingPoint/@code

String

Starting point code

activitiesContent/location/startPoints/meetingPoint/Country

Country

Starting point country

activitiesContent/location/startPoints/meetingPoint/Country/@code String Country code
activitiesContent/location/startPoints/meetingPoint/Country/@name String Description of the country
activitiesContent/location/startPoints/meetingPoint/Country/destinations List<Destinations> List of destinations included in the country for the particular content factsheet
activitiesContent/location/startPoints/meetingPoint/Country/destinations/@code String Country Code
activitiesContent/location/startPoints/meetingPoint/Country/destinations/@name String Description of the country code

activitiesContent/location/startPoints/meetingPoint/@description

String

Starting point description

activitiesContent/location/startPoints/meetingPoint/Coordinate geolocation Provides all GeoLocation GPS coordinates 

activitiesContent/location/startPoints/meetingPoint/Coordinate/@latitude

BigDecimal

Starting point latitude

activitiesContent/location/startPoints/meetingPoint/Coordinate/@longitude

BigDecimal

Starting point Longitude

activitiesContent/location/startPoints/meetingPoint/@type

PointOfInterestType

Type of meeting point in the pickup

activitiesContent/location/startPoints/meetingPoint/@zip

String

Starting point Zip code.

activitiesContent/location/startPoints/meetingPoint/@area

List<Area>

Starting point areas. An area is a part of the meeting point. i.e. in an airport it could be “second floor east”, “parking, ground floor” or “arrivals”

activitiesContent/location/startPoints/pickupInstructions

List<DuoTypeDescription>

Instructions to be picked up.

activitiesContent/location/startPoints/pickupInstructions/@description

String

Pickup instructions description

activitiesContent/location/endPoints/pickupInstructions/@code

String

Pickup instructions description

activitiesContent/media

Media

Media files (audio, video, etc) for the activity.

activitiesContent/media/audios

List<MediaOther>

List of audio media files.

activitiesContent/media/audios/duration Duration Is the duration of the media in terms of time. 
activitiesContent/media/audios/duration/@metric MetricType

Are the number of

  • Days, 
  • Hours or 
  • Minutes
that durate
activitiesContent/media/audios/duration/@value Double is the number that provides the relevant information to the metric. 

activitiesContent/media/audios/@language

String

Language in which the audio is encoded.

activitiesContent/media/audios/@description

String

Description of the audio file

activitiesContent/media/audios/@mimeType

MediaMimeType

Media mime type

activitiesContent/media/audios/@name

String

Media name

activitiesContent/media/audios/pointOfInterest

pointOfInterest

Media points of interest in the event that it’s linked to a specific location.

activitiesContent/media/audios/pointOfInterest/@address

String

If the media is linked to a point of interest, address of that point of interest.

activitiesContent/media/audios/pointOfInterest/@city

String

If the media is linked to a point of interest, city of that point of interest.

activitiesContent/media/audios/pointOfInterest/Country

Country

If the media is linked to a point of interest, country of that point of interest.

activitiesContent/media/audios/pointOfInterest/@description

String

If the media is linked to a point of interest, description of that point of interest.

activitiesContent/media/audios/pointOfInterest/Coordinate geolocation

activitiesContent/media/audios/pointOfInterest/Coordinate/@latitude

BigDecimal

If the media is linked to a point of interest, latitude of that point of interest.

activitiesContent/media/audios/pointOfInterest/Coordinate/@longitude

BigDecimal

If the media is linked to a point of interest, longitude of that point of interest.

activitiesContent/media/audios/pointOfInterest/@type

PointOfInterestType

If the media is linked to a point of interest, type of that point of interest.

activitiesContent/media/audios/pointOfInterest/@zip

String

If the media is linked to a point of interest, zip code of that point of interest.

activitiesContent/media/audios/pointOfInterest/@area

List<Area>

If the media is linked to a point of interest, it may contain a list of areas (such as building floors).

activitiesContent/media/audios/@tag

MediaTagType

Subtype of media. It can be one of the following:

  • MAP
  • LEAFLET
  • RECOMMENDATIONS
  • ADVANCED_TIPS
  • OTHER

activitiesContent/media/audios/@visualizationOrder

Integer

Playing order.

activitiesContent/media/audios/urls

List<MediaUrl>

List of media URLs

activitiesContent/media/audios/urls/@resource

String

URL for each media.

activitiesContent/media/documents

List<MediaOther>

Documents included in the contents facsheet.

activitiesContent/media/documents/@language

String

Document language

activitiesContent/media/documents/@description

String

Document description

activitiesContent/media/documents/@mimeType

MediaMimeType

Document mime type

activitiesContent/media/documents/@name

String

Document edia name

activitiesContent/media/documents/pointOfInterest

pointOfInterest

If the document is linked to a point of interest, address of that point of interest.

activitiesContent/media/documents/pointOfInterest/@address

String

If the document is linked to a point of interest, address of that point of interest.

activitiesContent/media/documents/pointOfInterest/@city

String

If the document is linked to a point of interest, city of that point of interest.

activitiesContent/media/documents/pointOfInterest/Country

Country

If the document is linked to a point of interest, country of that point of interest.

activitiesContent/media/documents/pointOfInterest/@description

String

If the document is linked to a point of interest, description of that point of interest.

activitiesContent/media/documents/pointOfInterest/Coordinate geolocation

activitiesContent/media/documents/pointOfInterest/Coordinate/@latitude

BigDecimal

If the document is linked to a point of interest, latitude of that point of interest.

activitiesContent/media/documents/pointOfInterest/Coordinate/@longitude

BigDecimal

If the document is linked to a point of interest, longitude code of that point of interest.

activitiesContent/media/documents/pointOfInterest/@type

PointOfInterestType

If the document is linked to a point of interest, longitude type of that point of interest

activitiesContent/media/documents/pointOfInterest/@zip

String

If the document is linked to a point of interest, zip code of that point of interest

activitiesContent/media/documents/pointOfInterest/@area

List<Area>

If the document is linked to a point of interest, it may contain a list of areas (such as building floors).

activitiesContent/media/documents/@tag

MediaTagType

Subtype of media. It can be one of the following:

  • MAP
  • LEAFLET
  • RECOMMENDATIONS
  • ADVANCED_TIPS
  • OTHER

activitiesContent/media/documents/@visualizationOrder

Integer

Document order among others.

activitiesContent/media/documents/urls

List<MediaUrl>

List of URLs containing the documents.

activitiesContent/media/documents/urls/@resource

String

URL for each document.

activitiesContent/media/images

List<MediaOther>

Images included in the contents facsheet.

activitiesContent/media/images/@language

String

Images language

activitiesContent/media/images/@description

String

Image description

activitiesContent/media/images/@mimeType

MediaMimeType

Image mime type

activitiesContent/media/images/@name

String

Image name

activitiesContent/media/images/pointOfInterest

pointOfInterest

Point of interest linked to the image.

activitiesContent/media/images/pointOfInterest/@address

String

If the Image is linked to a point of interest, address of that point of interest.

activitiesContent/media/images/pointOfInterest/@city

String

If the Image is linked to a point of interest, city of that point of interest

activitiesContent/media/images/pointOfInterest/Country

Country

If the Image is linked to a point of interest, country of that point of interest.

activitiesContent/media/images/pointOfInterest/@description

String

If the Image is linked to a point of interest, description of that point of interest.

activitiesContent/media/images/pointOfInterest/Coordinate GeoLocation

activitiesContent/media/images/pointOfInterest/Coordinate/@latitude

BigDecimal

If the Image is linked to a point of interest, latitude of that point of interest.

activitiesContent/media/images/pointOfInterest/Coordinate/@longitude

BigDecimal

If the Image is linked to a point of interest, longitude of that point of interest.

activitiesContent/media/images/pointOfInterest/@type

PointOfInterestType

If the Image is linked to a point of interest, type of that point of interest.

activitiesContent/media/images/pointOfInterest/@zip

String

If the Image is linked to a point of interest, zip code of that point of interest.

activitiesContent/media/images/pointOfInterest/@area

List<Area>

If the Image is linked to a point of interest, it may contain a list of areas (such as building floors).

activitiesContent/media/images/@tag

MediaTagType

Subtype of media. It can be one of the following:

  • MAP
  • LEAFLET
  • RECOMMENDATIONS
  • ADVANCED_TIPS
  • OTHER

activitiesContent/media/images/@visualizationOrder

Integer

Image order among others.

activitiesContent/media/images/urls

List<MediaUrl>

List of URLs containing the documents.

activitiesContent/media/images/urls/@dpi

Integer

Linked image dpis

activitiesContent/media/images/urls/@height

Integer

Linked image height

activitiesContent/media/images/urls/@width

Integer

Linked image width

activitiesContent/media/images/urls/@resource

String

Linked image real URL

activitiesContent/media/images/urls/@sizeType ImageSize

Is the size of an image which could be:

  • SMALL
  • MEDIUM
  • LARGE
  • XLARGE
  • RAW

activitiesContent/media/others

List<MediaOther>

Other media included in the contents facsheet.

activitiesContent/media/others/@language

String

Other media language

activitiesContent/media/others/@description

String

Other media description

activitiesContent/media/others/@mimeType

MediaMimeType

Other media mime type

activitiesContent/media/others/@name

String

Other media name

activitiesContent/media/others/pointOfInterest

pointOfInterest

Point of interest linked to the Other media.

activitiesContent/media/others/pointOfInterest/@address

String

If the Other media is linked to a point of interest, address of that point of interest.

activitiesContent/media/others/pointOfInterest/@city

String

If the Other media is linked to a point of interest, city of that point of interest

activitiesContent/media/others/pointOfInterest/Country

Country

If the Other media is linked to a point of interest, country of that point of interest.

activitiesContent/media/others/pointOfInterest/@description

String

If the Other media is linked to a point of interest, description of that point of interest.

activitiesContent/media/others/pointOfInterest/Coordinate geolocation

activitiesContent/media/others/pointOfInterest/Coordinate/@latitude

BigDecimal

If the Other media is linked to a point of interest, latitude of that point of interest.

activitiesContent/media/others/pointOfInterest/Coordinate/@longitude

BigDecimal

If the Other media is linked to a point of interest, longitude of that point of interest.

activitiesContent/media/others/pointOfInterest/@type

PointOfInterestType

If the Other media is linked to a point of interest, type of that point of interest.

activitiesContent/media/others/pointOfInterest/@zip

String

If the Other media is linked to a point of interest, zip code of that point of interest.

activitiesContent/media/others/pointOfInterest/@area

List<Area>

If the Other media is linked to a point of interest, it may contain a list of areas (such as building floors).

activitiesContent/media/others/@tag

MediaTagType

Subtype of media. It can be one of the following:

  • MAP
  • LEAFLET
  • RECOMMENDATIONS
  • ADVANCED_TIPS
  • OTHER

activitiesContent/media/others/@visualizationOrder

Integer

Other media order among others.

activitiesContent/media/others/urls

List<MediaUrl>

List of URLs containing the Other media.

activitiesContent/media/others/urls/@dpi

Integer

Linked Other media dpis if applicable

activitiesContent/media/others/urls/@height

Integer

Linked Other media height if applicable

activitiesContent/media/others/urls/@width

Integer

Linked Other media width if applicable

activitiesContent/media/others/urls/@resource

String

Linked Other media real URL

activitiesContent/media/videos

List<MediaVideo>

Video included in the contents facsheet.

activitiesContent/media/videos/duration Duration Indicates the duration of a video
activitiesContent/media/videos/duration/@metric MetricType

Are the number of

  • Days, 
  • Hours or 
  • Minutes
that durate
activitiesContent/media/videos/duration/@value Double Is the value that is indicated by the metric.

activitiesContent/media/videos/@language

String

Video language

activitiesContent/media/videos/@description

String

Video description

activitiesContent/media/videos/@mimeType

MediaMimeType

Video mime type

activitiesContent/media/videos/@name

String

Video name

activitiesContent/media/videos/pointOfInterest

pointOfInterest

Point of interest linked to the Other media.

activitiesContent/media/videos/pointOfInterest/@address

String

If the Video is linked to a point of interest, address of that point of interest.

activitiesContent/media/videos/pointOfInterest/@city

String

If the Video is linked to a point of interest, city of that point of interest

activitiesContent/media/videos/pointOfInterest/country

Country

If the Video is linked to a point of interest, country of that point of interest.

activitiesContent/media/videos/pointOfInterest/country/@code String
activitiesContent/media/videos/pointOfInterest/country/@name String
activitiesContent/media/videos/pointOfInterest/country/destinations List<Destinations>
activitiesContent/media/videos/pointOfInterest/country/destinations/@code String
activitiesContent/media/videos/pointOfInterest/country/destinations/@name String

activitiesContent/media/videos/pointOfInterest/@description

String

If the Video is linked to a point of interest, description of that point of interest.

activitiesContent/media/videos/pointOfInterest/Coordinate geolocation

activitiesContent/media/videos/pointOfInterest/Coordinate/@latitude

BigDecimal

If the Video is linked to a point of interest, latitude of that point of interest.

activitiesContent/media/videos/pointOfInterest/Coordinate/@longitude

BigDecimal

If the Video is linked to a point of interest, longitude of that point of interest.

activitiesContent/media/videos/pointOfInterest/@type

PointOfInterestType

If the Video is linked to a point of interest, type of that point of interest.

activitiesContent/media/videos/pointOfInterest/@zip

String

If the Video is linked to a point of interest, zip code of that point of interest.

activitiesContent/media/videos/pointOfInterest/@area

List<Area>

If the Video is linked to a point of interest, it may contain a list of areas (such as building floors).

activitiesContent/media/videos/@tag

MediaTagType

Subtype of media. It can be one of the following:

  • MAP
  • LEAFLET
  • RECOMMENDATIONS
  • ADVANCED_TIPS
  • OTHER

activitiesContent/media/videos/@visualizationOrder

Integer

Video order among others.

activitiesContent/media/videos/urls

List<MediaUrl>

List of URLs containing the Other media.

activitiesContent/media/videos/urls/@dpi

Integer

Linked Video dpis

activitiesContent/media/videos/urls/@height

Integer

Linked Video height

activitiesContent/media/videos/urls/@width

Integer

Linked Video width

activitiesContent/media/videos/urls/@resource

String

Linked Video real URL

activitiesContent/notes

List<Note>

List of activities notes

activitiesContent/notes/@dateFrom

Date

Application date from for the note

activitiesContent/notes/@dateTo

Date

Application date to for this note

activitiesContent/notes/@visibleFrom

Date

Visibility from date

activitiesContent/notes/@visibleTo

Date

Visibility to date

activitiesContent/notes/@descriptions

List<DuoTypeDescription>

List of texts contained in the note

activitiesContent/reedemInfo

Reedem

Activity reedem information

activitiesContent/reedemInfo/@directEntrance

Boolean

If true, the final customer can get into the activity directly.

activitiesContent/reedemInfo/@type

ReedemType

Reedem type

activitiesContent/reedemInfo/comments

List<DuoTypeDescription>

List of comments regarding the redeem information.

activitiesContent/reedemInfo/comments/@description

String

Each comment regarding the redeem information.

activitiesContent/routes

List<Route>

Activity routes

activitiesContent/routes/@description

String

Route description

activitiesContent/routes/duration

Duration

Duration of activity route

activitiesContent/routes/duration/@value

Double

Number of units. i.e. if metric has the value “HOURS” and the value is “1.5” then the route duration is 1 hour and 30 minutes.

activitiesContent/routes/duration/@metric 

MetricType

Type of duration. It can be one of the following:

  • DAYS
  • HOURS
  • MINUTES

activitiesContent/routes/@timeFrom

String

Route starting time (hhmm)

activitiesContent/routes/@timeTo

String

Route end time (hhmm)

activitiesContent/routes/points

List<RoutePoint>

List of points for this route

activitiesContent/routes/points/@description

String

Point descriptions

activitiesContent/routes/points/descriptions

List<DuoTypeDescription>

Point description

activitiesContent/routes/points/descriptions/@description

String

Text containint the point description

activitiesContent/routes/points/@order

Integer

Point order among others

activitiesContent/routes/points/PointOfInterest

PointOfInterest

Point of interest for this route

activitiesContent/routes/points/pointOfInterest/@address

String

Point of interest address

activitiesContent/routes/points/pointOfInterest/@city

String

Point of interest city

activitiesContent/routes/points/pointOfInterest/Country

Country

Point of interest country

activitiesContent/routes/points/pointOfInterest/@description

String

Point of interest description

activitiesContent/routes/points/pointOfInterest/geolocation

Coordinate

Point of interest GPS point

activitiesContent/routes/points/pointOfInterest/geolocation/@latitude

BigDecimal

Point of interest Latitude

activitiesContent/routes/points/pointOfInterest/geolocation/@longitude

BigDecimal

Point of interest Longitude

activitiesContent/routes/points/pointOfInterest/@type

PointOfInterestType

Type of Point of interest. Available values:

  • LANDMARK
  • ADDRESS
  • OTHER

activitiesContent/routes/points/pointOfInterest/@zip

String

Point of interest zip code

activitiesContent/routes/points/pointOfInterest/area

List<Area>

List of areas

activitiesContent/routes/points/pointOfInterest/area/@code

 

 

activitiesContent/routes/points/pointOfInterest/area/geolocation

Coordinates

Area GPS location

activitiesContent/routes/points/pointOfInterest/area/geolocation/@latitude

BigDecimal

Area latitude

activitiesContent/routes/points/pointOfInterest/area/geolocation/@longitude

BigDecimal

Area longitude

activitiesContent/routes/points/stopTime

Duration

Duration of the stoppage in the route.

activitiesContent/routes/points/stopTime/@metric 

MetricType

Type of duration. It can be:

  • HOURS
  • DAYS
  • MINUTES

activitiesContent/routes/points/stopTime/@value

Number of units of the metric above.

Number of units. i.e. if metric has the value “HOURS” and the value is “1.5” then the route duration is 1 hour and 30 minutes.

activitiesContent/routes/points/@timeFrom

String

Expected arrival time to the point in hhmm format

activitiesContent/routes/points/@timeTo

String

Expected departure time from the point in hhmm format.

activitiesContent/routes/points/Frequency

Frequency

Route frequency in minutes

activitiesContent/routes/points/Frequency/maximum

Duration

Maximum frequency duration for this route

activitiesContent/routes/points/Frequency/maximum/@metric

MetricType

Type of duration. It can be:

  • HOURS
  • DAYS
  • MINUTES

activitiesContent/routes/points/Frequency/maximum/@value

Double

Number of duration units.

activitiesContent/routes/points/Frequency/minimum

Duration

Minimum frequency duration for this route

activitiesContent/routes/points/Frequency/minimum/@metric

MetricType

Type of duration. It can be:

  • HOURS
  • DAYS
  • MINUTES

activitiesContent/routes/points/Frequency/minimum/@value

Double

Number of duration units.

activitiesContent/scheduling

activitiesContent/scheduling/closed

List<ScheduleInfo>

Period In which the activity is closed.

activitiesContent/scheduling/closed/@from

Date

Closed from date.

activitiesContent/scheduling/closed/@to

Date

Closed to date

activitiesContent/scheduling/closed/@weekDays

List<WeekDayType>

Days of week in which the activity is closed.

activitiesContent/scheduling/closed/ScheduledInfo Object
activitiesContent/scheduling/closed/ScheduledInfo/@openingTime String Time of opening in format HHMM
activitiesContent/scheduling/closed/ScheduledInfo/@closeTime String Time of opening in format HHMM

activitiesContent/scheduling/opened

List<ScheduleInfo>

Opening dates

activitiesContent/scheduling/openend/@from

Date

Open from date.

activitiesContent/scheduling/openend/@to

Date

Open to date

activitiesContent/scheduling/openend/@weekDays

List<WeekDayType>

Days of week in which the activity is open.

activitiesContent/scheduling/openend/ScheduledInfo Object
activitiesContent/scheduling/openend/ScheduledInfo/@openingTime String Time of opening in format HHMM
activitiesContent/scheduling/openend/ScheduledInfo/@closeTime String Time of opening in format HHMM

activitiesContent/scheduling/duration

Duration

Schedule duration

activitiesContent/scheduling/duration/@hours

Double

Schedule duration in hours

activitiesContent/segmentationGroups

List<SegmentGroup>

Activity segmentation (See above for details)

activitiesContent/segmentationGroups/@code

Long

Segmentation Group code

activitiesContent/segmentationGroups/@name

String

Segmentation Group name

activitiesContent/segmentationGroups/segments

List<Segment>

List of segments for the Group

activitiesContent/segmentationGroups/segments/@code

Integer

Segment code

activitiesContent/segmentationGroups/segments/@name

String

Segment name

activitiesContent/segmentationGroups/segments/@icon

String

Segment icon

activitiesContent/segmentationGroups/segments/subSegments

List<SubSegment>

List of subsegments for the segment

activitiesContent/segmentationGroups/segments/subSegments/@code

Integer

Subsegment code

activitiesContent/segmentationGroups/segments/subSegments/@order

Integer

Subsegment order

activitiesContent/segmentationGroups/segments/subSegments/@name

String

Subsegment name

activitiesContent/segmentationGroups/segments/subSegments/@icon

String

Subsegment icon

activitiesContent/geolocation

Coordinate

Activity geolocation in GPS coordinates.

activitiesContent/geolocation/@latitude

BigDecimal

Activity latitude

activitiesContent/geolocation/@longitude

BigDecimal

Activity longitude

activitiesContent/venueIds

List<Venue>

Venues list.

activitiesContent/venueIds/@type

VenueType

Venue type

activitiesContent/venueIds/@value

String

Venue value

 

Docs Navigation