Response
Activity List response
The ActivityListResponse will contain the details for all the activities that the supplier has made available for you to pull across through the Zaui IO API.
XML Node | Parent Node | Description |
RequestStatus | ActivityListResponse | Request status root XML node, which holds details about the status |
Status | RequestStatus | Status of the request. • SUCCESS for a successful transaction, or • ERROR for unsuccessful transaction. Error XML node will be provided |
Error | RequestStatus | Error root XML node |
Error Code | Error | The error code |
Error Message | Error | String for the error message |
Error Details | Error | String which will have additional details about the error |
Tour | ActivityListResponse | Root activity XML node |
SupplierProductCode | Tour | Suppliers unique product code. This will be used across multiple API calls and should be stored as part of your implementation |
SupplierProductTypeCode | Tour | Integer value representing the type of activity within our system (See Appendix B for possible activities) |
SupplierProductName | Tour | String that contains the supplier activity name |
TourDescription | Tour | Description of the activity as provided by the supplier |
TourImage | Tour | CDN URL for the tour image |
TourBookingPolicy | Tour | The booking policy for this tour as provided by the supplier. |
TourCancellationPolicy | Tour | The cancellation policy for this tour provided by the supplier. |
PickupLocations | Tour | Root XML node for pickup locations offered by the supplier |
DateRanges | PickupLocations | Array of pickup locations valid for a specific date range |
StartDate | PickupLocations | Valid start date of the date range |
EndDate | PickupLocations | Valid end date of the date range |
Pickups | PickupLocations | Array of pickup locations and their details |
SupplierPickupCode | Pickups | Unique ID of the pickup location to be used on subsequent availability checks |
SupplierPickupName | Pickups | Supplier defined name of the pickup location |
PickupTime | Pickups | Time the pickup is offered on the specific activity/shuttle |
PickupEndTime | Pickups | End time of the pickup if supplier defines a window of time for pickup |
PickupDayOffset | Pickups | Whether the pickup occurs on the same day or the following day depending on the start time of the activity/shuttle (ex. shuttle departs at 11 pm, with pickups along the route past midnight) |
SupplierDestinationCode | Pickups | Unique ID of the destination in which the pickup location exists |
SupplierDestinationName | Pickups | Supplier defined name of the destination |
DropoffLocations | Tour | Root XML node for dropoff locations offered by the supplier |
DateRanges | DropoffLocations | Array of dropoff locations valid for a specific date range |
StartDate | DropoffLocations | Valid start date of the date range |
EndDate | DropoffLocations | Valid end date of the date range |
Dropoffs | DropoffLocations | Array of dropoff locations and their details |
SupplierDropoffCode | Dropoffs | Unique ID of the dropoff location to be used on subsequent availability checks |
SupplierDropoffName | Dropoffs | Supplier defined name of the dropoff location |
DropoffTime | Dropoffs | Time the dropoff is offered on the specific activity/shuttle |
DropoffEndTime | Dropoffs | End time of the dropoff if supplier defines a window of time for dropoffs |
DropoffDayOffset | Dropoffs | Whether the dropoff occurs on the same day or the following day depending on the start time of the activity/shuttle (ex. shuttle departs at 11 pm, and drops off passengers past midnight) |
SupplierDestinationCode | Dropoffs | Unique ID of the destination in which the dropoff location exists |
SupplierDestinationName | Dropoffs | Name of the destination |
TourOption | Tour | Root XML node that holds details for options on the activity |
SupplierOptionCode | TourOption | String that contains the supplier activity name |
TourDuration | TourOption | Duration of the activity. Format will be PnYnMnDTnHnMnS Example: PT300S (5 mins) |
TourDepartureTime | TourOption | Time of the activity. Values will be in the format of HH:MM:SS |
Language | TourOption | Root XML node that holds details for languages available for options on the activity |
LanguageCode | Language | ISO language code |
LanguageOption | Language | Option provided with the product (tour). Valid values include:
• GUIDE - when a guide is present throughout the tour.
• AUDIO - when audio is available throughout the tour.
• WRITTEN - when written material is provided for the tour. |
Last modified 2yr ago