Detail Response

Response fields for the Details operation are detailed below. 

From a business perspective, the most relevant point of this call response is where the rateKey is returned. 

NODE/ATTRIBUTE

TYPE

DESCRIPTION

operationId

String

Factsheet Operational ID, informative only.

errors

List<Error>

Contains a list of errors (error code and error description)

errors/@code

String

Error code

errors/@text

String

Error description

errors/@internalDescription

String

Internal error description

pagination

PaginationResponse

Pagination information

pagination/@itemsPerPage

Integer

Items per page

pagination/@page

Integer

Total pages

pagination/@totalItems

Integer

Total items

auditData

Element

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

activity

List<Activity>

List of activities requested.

activity/@activityCode

String

Activity code

activity/country

Object

Information regarding the Country where the activity is performed.

activity/country/@code     

String

Country code where the activity takes place. See Country codes in the Contents API

activity/country/@name

String

Country name where the activity takes place.See Country codes in the Contents API

activity/country/destinations

List<destinations>

List of destinations codes and names

activity/country/destinations/@code

String

Destination code where the activity takes place. See Destination codes in the Contents API

activity/country/destinations/@name

String

Destination name where the activity takes place. See Destination codes in the Contents API

activity/@url

String

URL that points to a landing site to purchase the product. The landing page will be configured if for example you are using a white label from Hotelbeds.

activity/@originServices

Integer

Service origin

activity/@code

String

Activity code

activity/@type

String

Type of activity being returned:

  • TICKET: Standard ticket.
  • EXCURSION: A pickup needs to be selected. See retrieve pickups api call for details.

activity/@name

String

Activity name. It will be provided in the same language as the request indicated

activity/@currency

String

Activity currency code. See valid currency codes in the Contents API or use offline contents via

activity/@currencyName

String

Activity currency name. It will be provided in the same language as the request indicated

activity/amountsFrom

List<PaxPrices>

Lowest price for the activity in the given dates. A detail of the pax type, amount for that pax type and box office price is provided in a deeper level.

activity/amountsFrom/@paxType

String

Pax type. It can be one of the following:

  • ADULT: Adult paxes
  • CHILD: Children. Ages are specified below.

PLEASE NOTE: If your RQ includes a specific age range and there are no results returned, it is because the requested activity is not available for some of the passengeres due to their age.

activity/amountsFrom/@ageFrom

 

Integer

Age from for this pax type

activity/amountsFrom/@ageTo

 

Integer

Age to for this pax type

activity/amountsFrom/@amount

 

Double

Price from for the pax type.

activity/amountsFrom/@boxOfficeAmount

 

Double

Box office Price from for the pax type

The Box office price is the price value at the gate or counter. It is not the selling price of the activity but it can be taken into consideration for the comparison of the price if not booked in advanced.

activity/operationDays

List<OperationDay>

Days of the week when the activity is bookable.

activity/operationDays/@code

String

Day code. It can be: SUN, MON, TUE, WED, THU, FRI, SAT

activity/operationDays/@name

String

Name of the day of the week  (i.e. Monday). It will be provided in the same language as the request indicated.

activity/modalities

List<Modality>

Modalities available.

activity/modalities/duration

Duration

Activity duration

activity/modalities/duration/@metric

MetricType

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

  • DAYS
  • HOURS
  • MINUTES

activity/modalities/duration/@value

Double

Number of units. i.e. if metric has the value “DAYS” and the value is “1.5” then the route duration is 1 day and 12 hours.

'activity/modalities/@destinationCode

String

Destination code. Please see the available destination codes at Contents API or get it from the Active Content FTP.

activity/modalities/@code

String

Modality code

activity/modalities/@name

String

Modality name. It will be provided in the same language as the request indicated

activity/modalities/questions

List<QuestionDetail>

Are the relevant questions that are asked to end consumers and that are mandatory to ensure that he/she can enjoy the activity and to prevent issues. Example of questions are: passport number, weight, height, etc.

activity/modalities/questions/@code

String

Question code.

activity/modalities/questions/@text

String

Question text. It will be provided in the same language as the request indicated.

activity/modalities/question/@required

Boolean

Determines if the question is mandatory (true) or optional (false)

activity/modalities/comments

List<Comment> 

Specific comments that must be included in the voucher and shown to the final customer.

activity/modalities/comments/@type

CommentType

Comment type. Possible value is “CONTRACT_REMARKS”.

activity/modalities/comments/@text

String

Text to be shown to the final customer.

activity/modalities/supplierInformation

SupplierInformation

Supplier information

activity/modalities/supplierInformation/@name

String

Supplier name.

activity/modalities/supplierInformation/@vatNumber

String

Supplier vat number

activity/modalities/providerInformation

ProviderInformation 

Provider information

activity/modalities/providerInformation/@name

String

Provider Name

activity/modalities/providerInformation/@bookingreference

String

Provider booking reference number. 

activity/modalities/promotions

List<Promotion>

Modality promotions

activity/modalities/promotions/@code

String

Promotion code

activity/modalities/promotions/@order

Integer

Promotion order

activity/modalities/promotions/@name

String

Promotion name

activity/modalities/promotions/@description

String

Promotion description

activity/modalities/promotions/@dateFrom

Date

Promotion date from

activity/modalities/promotions/@dateTo

Date

Promotion date to

activity/modalities/promotions/@imagePath

String

Promotion image path

activity/modalities/specificContent

CommonFactsheetActivity

Content of activity

activity/modalities/@amountUnitType

String

Informative: Explains how the total price (see below) is calculated. If it’s a “PAX” unit type, then the total price depends on the number of paxes. If the unit type is “SERVICE”, then the total price is fixed.

In any case, the total price is returned in the “totalPrice” attribute (see below) for the number of paxes provided.

activity/modalities/amountsFrom

List<PaxPrices>

List of prices from by pax for the given rates and modalities.

activity/modalities/amountsFrom/@paxType

PaxType

Pax type. The following values are available:

  • ADULT
  • CHILD

activity/modalities/amountsFrom/@ageFrom

 

Integer

Age from for this pax type.

activity/modalities/amountsFrom/@ageTo

 

Integer

Age to for this pax type.

activity/modalities/amountsFrom/@amount

BigDecimal

Total Pax Price from for the pax type

activity/modalities/amountsFrom/@boxOfficeAmount

 

BigDecimal

Price from in the box office.

activity/modalities/rates

List<Rate>

List of rates. A rate is a basic information container to get the activity price.

activity/modalities/rates/@rateCode

String

Rate code

activity/modalities/rates/@name

String

Rate name. It will be provided in the same language as the request indicated

activity/modalities/rates/@shortDescription

String

Description.

activity/modalities/rates/paxQuestions

List<PaxQuestion>

Some activities need questions to be answered in the confirmation. For those activities, a question list is provided.

activity/modalities/rates/paxQuestions/@code

String

Question code

activity/modalities/rates/paxQuestions/@text

String

Question text

activity/modalities/rates/paxQuestions/@required

Boolean

If the question is mandatory to be answered (true) or not (false)

activity/modalities/rates/rateDetails

List<RateDetail>

List of rate details

activity/modalities/rates/rateDetails/@rateKey

String

Rate key. IMPORTANT. This key along with a session, language and date is the key information to be passed to a confirm api call to confirm a booking. Rate keys are alive for 30 minutes, after that, you’ll need to call to the detail api call again to have fresh rateKeys.

activity/modalities/rates/rateDetails/@retrievePickupsKey

String

In the event that the activity needs a pickup (typically because it’s an excursion), instead of a rateKey, you’ll get a retrivePickupsKey.

A booking cannot be confirmed with a retrievePickupsKey, but a RetrievePickups call can be performed and, then, in the RetrievePickups response, the rateKeys to confirm a booking are provided.

See the booking funnel for excursions for more details.

activity/modalities/rates/rateDetails/minimumDuration

Duration

Minimum duration in days for the activity

activity/modalities/rates/rateDetails/minimumDuration/@metric

String

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

  • DAYS
  • HOURS
  • MINUTES

For the specific case of minimumDuration, it’s always returned as “DAYS”.

activity/modalities/rates/rateDetails/minimumDuration /@value

Double

Number of metric units of duration. In the specific case of minimumDuration is the number of days.

activity/modalities/rates/rateDetails/maximumDuration

Duration

Maximum duration in days for the activity.

activity/modalities/rates/rateDetails/maximumDuration /@metric

String

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

  • DAYS
  • HOURS
  • MINUTES

For the specific case of minimumDuration, it’s always returned as “DAYS”.

activity/modalities/rates/rateDetails/@maximumDuration/@value

Double

Number of metric units of duration. In the specific case maximumDuration is the number of days.

activity/modalities/rates/rateDetails/operationDates

List<OperationDate>

List of dates that can be booked with the rate and Price specified.

activity/modalities/rates/rateDetails/operationDates/@from

Date

Operation dates from. If the duration is 1 day, then from and to have the same value.

activity/modalities/rates/rateDetails/operationDates/@to

Date

Operation date to. If the duration is 1 day, then from and to have the same value.

activity/modalities/rates/rateDetails/operationDates/@cancellationPolicies List<CancellationPolicies> There could be one or more cancellation policies that apply. For more information on cancellation policies and details on how these apply please refer to Search Response
activity/modalities/rates/rateDetails/operationDates/cancellationPolicies/@dateFrom date Date from which there are cancellation policies that apply
activity/modalities/rates/rateDetails/operationDates/cancellationPolicies/@amount BigDecimal

The amount linked to the cancellation policy. 

See an example below!

activity/modalities/rates/rateDetails/operationDates example

 

"rateDetails": [
              {
                "rateKey": "1rq78r98f3qelpmoqal3t0lo4u",
                "operationDates": [
                  {
                    "from": "2016-05-28",
                    "to": "2016-05-28",
                    "cancellationPolicies": [
                      {
                        "dateFrom": "2016-05-27T00:00:00.000Z",
                        "amount": 116.58
                      }
                    ]
                  },
                  {
                    "from": "2016-05-29",
                    "to": "2016-05-29",
                    "cancellationPolicies": [
                      {
                        "dateFrom": "2016-05-28T00:00:00.000Z",
                        "amount": 116.58
                      }
                    ]
                  },

activity/modalities/rates/rateDetails/sessions

List<Session>

List of session available for this service. A session contains the scheduling of the activity. If more than one session is included in the rateDetails that means the sessions have the same price.

activity/modalities/rates/rateDetails/sessions/@code

String

Session code

activity/modalities/rates/rateDetails/sessions/@name

String

Session name. i.e. “Afternoon” or “5:00PM”

activity/modalities/rates/rateDetails/languages

List<Language>

List of languages in which the activity is available. If more than one language is returned in the rateDetails, it means all the languages have the same price.

activity/modalities/rates/rateDetails/languages/@code

String

Language code. See Valid language codes in the contents API spec.

activity/modalities/rates/rateDetails/languages/description

String

Language name. It will be provided in the same language as the request indicated

activity/modalities/rates/rateDetails/agencyCommision

AgencyCommision

Agency commission. If you are following a commissionable model, the data for the commission you are going to get for the sale is specified here.

activity/modalities/rates/rateDetails/agencyCommision/@percentage

Double

Commission percentage.

activity/modalities/rates/rateDetails/agencyCommision/@amount

Double

Commission amount.

activity/modalities/rates/rateDetails/agencyCommision/@vatPercentage

Double

Commission VAT percentage

activity/modalities/rates/rateDetails/agencyCommision/@vatAmount 

Double

Commission VAT amount

activity/modalities/rates/rateDetails/paxAmounts

List<PaxPrice>

List of exact pax prices for any combination of session, language or date returned in the rateDetails.

activity/modalities/rates/rateDetails/paxAmounts/@paxType

PaxType

Pax type. ADULT or CHILD.

activity/modalities/rates/rateDetails/paxAmounts/@ageFrom

 

Integer

Age from for this pax. Age from and to makes sense when the pax type is a CHILD to understand the ages for the children.

activity/modalities/rates/rateDetails/paxAmounts/@ageTo

 

Integer

Age to for this pax. Age from and to makes sense when the pax type is a CHILD to understand the ages for the children.

activity/modalities/rates/rateDetails/paxAmounts/@amount

 

BigDecimal

Total Pax amount for the pax type in the rate.

activity/modalities/rates/rateDetails/paxAmounts/@boxOfficeAmount

 

BigDecimal

Box office amount for the pax type in the rate.

activity/modalities/rates/rateDetails/totalAmount

Object

Total amount for all the paxes requested under any combination of session, language or date returned in the rate. The structure contains the price and the box office price.

activity/modalities/rates/rateDetails/totalAmount/@amount

BigDecimal

Total activity amount for all the paxes requested.

activity/modalities/rates/rateDetails/totalAmount/boxOfficeAmount

BigDecimal

Total activity box office amount for all the paxes requested.

activity/modalities/rates/rateDetails/pickup

ActivityPickup

 

Activity pick up details. In the event that a pickup was provided in the request, rateKeys are retuned along with pickups to book excursions.

activity/modalities/rates/rateDetails/pickup/@pickupName

String

Pickup name

activity/modalities/rates/rateDetails/pickup/@validFrom

Date

Pickup validity date from.

activity/modalities/rates/rateDetails/pickup/@validTo

Date

Pickup validity date to

activity/modalities/rates/rateDetails/pickup/@shortDescription

String

Pickup short description. It will be provided in the same language as the request indicated

activity/modalities/rates/rateDetails/pickup/@description

String

Pickup long description. It will be provided in the same language as the request indicated

activity/modalities/rates/rateDetails/pickup/geolocation

Coordinates

Pickup GPS coordinates

activity/modalities/rates/rateDetails/pickup/geolocation/@longitude

Double

Pickup longitude

activity/modalities/rates/rateDetails/pickup/geolocation/@latitude

Double

Pickup latitude

activity/modalities/rates/rateDetails/pickup/@time

String

Pickup time (HHMM)

activity/modalities/rates/rateDetails/pickup/@pickupPointCode

String

Pick up point code

activity/modalities/rates/rateDetails/pickup/@generic

boolean

Indicates if pickup point is a generic point (true) or if it’s an hotel (false)

activity/modalities/rates/rateDetails/pickup/@hotelCode

Long

Pick up hotel code if the pickup is a hotel.

activity/modalities/rates/rateDetails/pickup/@hotelName

String

Hotel name if the pickup is a hotel.

activity/content

 

Please refer to Contents API and Contents by Operation

FactsheetActivity

Activity Factsheet. See details in the get Contents API call.

If the API call was a full detail, then the full contents factsheet is returned. See the get Contents API call for more details.

Also please refer to the contents by operation to have details of what is included in the Simple and what is included in the Full from a content factsheet point of view. 

If the api call was a simple detail, then a subset of data is provided as contents to allow the client to present at least some basic information to the final customer. The simplified contents are:

  • Name
  • GPS
  • Description
  • Images
  • Segmentation
  • Features
  • Itineraries

See below for specific details of the reduced contents returned only for the detail simple API call.

All the attributes but the content id are optional from an api perspective, but name and description are always provided.

Docs Navigation