Retrieve Pickups Response

The api call returns a list of pickups:  

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

pickups

List<ActivityPickup>

List of pickups

pickups/@rateKey 

String

Rate key to confirm the booking with the selected pickup. See above and the confirm api call for more details on rateKeys.
pickups/amountsFrom List<PaxPrice> Provides a list of the different amounts considering the details below in regards to the pickup point. The amount is the total for each pickup. For example if one pickup A shows 100 and pickup B shows 110 means that pickup B is 10 more expensive than pickup A. 
pickups/amountsFrom/@paxType PaxType The passenger type.
pickups/amountsFrom/@ageFrom Integer The age from of the passanger. This is returned to ensure that the person that is being considered (taking into account the paxtype) is within the range of ageFrom and ageTo
pickups/amountsFrom/@ageTo Integer The age To of the passanger. This is returned to ensure that the person that is being considered (taking into account the paxtype) is within the range of ageFrom and ageTo
pickups/amountsFrom/@amount BigDecimal Is the total price for the activity.
pickups/amountsFrom/@netAmount BigDecimal Price from for the pax type.
pickups/amountsFrom/@boxOfficeAmount BigDecimal Box office Price from for the pax type
pickups/amountsFrom/@mandatoryApplyAmount Boolean
pickups/operationDate PickupOperationDate
pickups/operationDate/@from Date Date from in which the pickup point operates
pickups/operationDate/@to Date Date To until the pickup point operates
pickups/operationDate/@minimum Integer
pickups/operationDate/@maximum Integer
pickups/operationDate/totalAmount PaxPrice
pickups/operationDate/totalAmount/@paxType PaxType

The passenger type could either an Adult or a Child. The following are the possible options:

"AD" - Adult

"CH" - Child
pickups/operationDate/totalAmount/@ageFrom Integer The age from of the passanger. This is returned to ensure that the person that is being considered (taking into account the paxtype) is within the range of ageFrom and ageTo
pickups/operationDate/totalAmount/@ageTo Integer The age To of the passanger. This is returned to ensure that the person that is being considered (taking into account the paxtype) is within the range of ageFrom and ageTo
pickups/operationDate/totalAmount/@amount BigDecimal Is the total price for the activity.
pickups/operationDate/totalAmount/@netAmount BigDecimal
pickups/operationDate/totalAmount/@boxOfficeAmount BigDecimal
pickups/operationDate/totalAmount/@mandatoryApplyAmount Boolean
pickups/operationDate/paxAmounts List<PaxPrice>
pickups/operationDate/paxAmounts/@paxType PaxType

The passenger type could either an Adult or a Child. The following are the possible options:

"AD" - Adult

"CH" - Child
pickups/operationDate/paxAmounts/@ageFrom Integer The age from of the passanger. This is returned to ensure that the person that is being considered (taking into account the paxtype) is within the range of ageFrom and ageTo
pickups/operationDate/paxAmounts/@ageTo Integer The age To of the passanger. This is returned to ensure that the person that is being considered (taking into account the paxtype) is within the range of ageFrom and ageTo
pickups/operationDate/paxAmounts/@amount BigDecimal Is the total price for the activity.
pickups/operationDate/paxAmounts/@netAmount BigDecimal
pickups/operationDate/paxAmounts/@boxOfficeAmount BigDecimal
pickups/operationDate/paxAmounts/@mandatoryApplyAmount Boolean
pickups/operationDate/paxQuestions List<PaxQuestion>
pickups/operationDate/paxQuestions/@code String Is the question code. This is used as an internal reference. 
pickups/operationDate/paxQuestions/@text String Text in the language of the reuqest for the specific question
pickups/operationDate/paxQuestions/@required Boolean The possible values are Yes or No. Values are linked as to whether the question is mandatory to be answered or not. 
pickups/operationDate/@cancellationPolicies List<CancellationPolicy> Details all the cancellation policies. May change considering the moment in which the activity is cancelled. 
pickups/operationDate/cancellationPolicies/@dateFrom  Date Date and time (local time in destination) from which the cancellation policies apply. For more information regarding how the cancellation policies apply please refer to the Search Response documentation section
pickups/operationDate/cancellationPolicies/@amount  BigDecimal Is the total price for the activity.

pickups/@pickupName

String

Pickup name.

Pickups/@shortDescription

String

Short description

Pickups/@description

String

Long description

Pickups/geolocation

Coordinates

Pickup GPS location

pickups/geolocation/@latitude

BigDecimal

Pickup latitude

pickups/geolocation/@longitude

BigDecimal

Pickup longitude

pickups/@time

String

Pickup time (HHMM)

pickups/@hotelCode

String

Hotel code if the pickup is a hotel.

pickups/@hotelName

String

Hotel name if the pickup is a hotel.

pickups/@modalityCode

String

Modality code

pickups/@validMonday

boolean

true if the pickup is available on Mondays.

pickups/@validTuesday

boolean

true if the pickup is available on Tuesdays.

pickups/@validWednesday

boolean

true if the pickup is available on Wednesdays.

pickups/@validThursday

boolean

true if the pickup is available on Thursdays.

pickups/@validFriday

boolean

true if the pickup is available on Fridays.

Pickups/@validSaturday

boolean

true if the pickup is available on Saturdays.

pickups/@validSunday

boolean

true if the pickup is available on Sundays.

pickups/@pickupPointCode

String

Pick up point code

pickups/@generic

boolean

Indicates if pickup point is a generic point (true) or a hotel (false)

version 9 as of 2 years ago by Silvia

Docs Navigation