Search…
Single Activity Details
Get details on a single activity, attraction or event.
get
https://{yourdomainname}.zaui.net
/zapi/
zapiGetActivityDetailsByActivityId
Request
Response
Rental Activity Response
<request>
<zapiToken></zapiToken>
<zapiAccountId></zapiAccountId>
<zapiUserId></zapiUserId>
<zapiMethod>
<methodName>zapiGetActivityDetailsByActivityId</methodName>
<activityId></activityId>
<activityDate></activityDate>
<verboseMode></verboseMode>
</zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.0</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGetActivityDetailsByActivityId</methodName>
<methodErrorCode></methodErrorCode>
<methodErrorMessage></methodErrorMessage>
<verboseMode>true</verboseMode>
<activity>
<categoryName></categoryName>
<categoryId></categoryId>
<activityName></activityName>
<activityId></activityId>
<activityTypeId></activityTypeId>
<activityTypeAsString></activityTypeAsString>
<activityThreshold></activityThreshold>
<activityMaxThreshold></activityMaxThreshold>
<operatedByCompanyId></operatedByCompanyId>
<operatedByCompanyName ></operatedByCompanyName>
<supplierConfirmationNumberSystemManaged/>
<supplierConfirmationNumberDisplayed/>
<description></description>
<imageUrl></imageUrl>
<isFreeSell></isFreeSell>
<ticketExpiry></ticketExpiry>
<ticketPrinterText></ticketPrinterText>
<activityTimes>
<activityTime>
<activityStartTime></activityStartTime>
<activityTimeCancelled></activityTimeCancelled>
<activityTimeOnlineOnly></activityTimeOnlineOnly>
<activityTimeAvailable></activityTimeAvailable>
<activityTimeAvailableMessage></activityTimeAvailableMessage>
<inventoryCheckCode></inventoryCheckCode>
<inventoryCheckMessage></inventoryCheckMessage>
<activityTimeSpotsRemaining></activityTimeSpotsRemaining>
</activityTime>
</activityTimes>
<daysOfWeekAvailable>
<dateRange>
<startDate></startDate>
<daysOfWeek>
<monday></monday>
<tuesday></tuesday>
<wednesday></wednesday>
<thursday></thursday>
<friday></friday>
<saturday></saturday>
<sunday></sunday>
</daysOfWeek>
<endDate></endDate>
</dateRange>
</daysOfWeekAvailable>
<pickupLocations>
<locationName></locationName>
<locationId></locationId>
</pickupLocations>
<dropOffLocations>
<locationName></locationName>
<locationId></locationId>
</dropOffLocations>
<businessHours>
<hours>
<startDate></startDate>
<openingTime></openingTime>
<closingTime></closingTime>
<endDate></endDate>
</hours>
</businessHours>
<pricingOptions>
<option>
<name></name>
<optionId></optionId>
<price></price>
</option>
</pricingOptions>
<duration></duration>
<allowedPassengers>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName></systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
</allowedPassengers>
</activity>
<sharedInventoryDetails>
<isParent></isParent>
<childrenActivities>
<childActivity>
<activity></activity>
</childActivity>
</childrenActivities>
</sharedInventoryDetails>
</methodResponse>
</response>
<?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGetActivityDetailsByActivityId</methodName>
<methodErrorCode></methodErrorCode>
<methodErrorMessage></methodErrorMessage>
<verboseMode>true</verboseMode>
<activity>
<categoryName></categoryName>
<categoryId></categoryId>
<activityName></activityName>
<activityId></activityId>
<activityDate></activityDate>
<activityTypeId></activityTypeId>
<activityTypeAsString></activityTypeAsString>
<activityTypeSubType></activityTypeSubType>
<activityIsMultiday></activityIsMultiday>
<activityMultiDayStart></activityMultiDayStart>
<activityMultiDayDuration></activityMultiDayDuration>
<activityTimeDuration></activityTimeDuration>
<activityTimeDurationUnits></activityTimeDurationUnits>
<isFreeSell></isFreeSell>
<supplierConfirmationNumberSystemManaged></supplierConfirmationNumberSystemManaged>
<supplierConfirmationNumberDisplayed></supplierConfirmationNumberDisplayed>
<operatedByCompanyId></operatedByCompanyId>
<operatedByCompanyName></operatedByCompanyName>
<ticketExpiry></ticketExpiry>
<ticketPrinterText></ticketPrinterText>
<description></description>
<shortDescription></shortDescription>
<imageUrl></imageUrl>
<activityTimes>
<activityTime>
<activityTimeStart></activityTimeStart>
<activityTimeCancelled></activityTimeCancelled>
<status></status>
<fixedDepartureOptions>
<option>
<optionId></optionId>
<optionName></optionName>
<durationValue></durationValue>
<durationUnits></durationUnits>
</option>
<option>
<optionId></optionId>
<optionName></optionName>
<durationValue></durationValue>
<durationUnits></durationUnits>
</option>
</fixedDepartureOptions>
</activityTime>
<activityTime>
<activityTimeStart></activityTimeStart>
<activityTimeCancelled></activityTimeCancelled>
<status></status>
<fixedDepartureOptions>
<option>
<optionId></optionId>
<optionName></optionName>
<durationValue></durationValue>
<durationUnits></durationUnits>
</option>
</fixedDepartureOptions>
</activityTime>
</activityTimes>
<equipment>
<equipmentCategories>
<equipmentCategoryId></equipmentCategoryId>
<equipmentCategoryName></equipmentCategoryName>
<availableEquipment>
<equipmentItem>
<equipmentId></equipmentId>
<equipmentName></equipmentName>
</equipmentItem>
</equipmentCategories>
<equipmentCategories>
<equipmentCategoryId></equipmentCategoryId>
<equipmentCategoryName></equipmentCategoryName>
<availableEquipment>
<equipmentItem>
<equipmentId></equipmentId>
<equipmentName></equipmentName>
</equipmentItem>
</availableEquipment>
</equipmentCategories>
<equipmentCategories>
<equipmentCategoryId></equipmentCategoryId>
<equipmentCategoryName></equipmentCategoryName>
<availableEquipment>
<equipmentItem>
<equipmentId></equipmentId>
<equipmentName></equipmentName>
</equipmentItem>
</availableEquipment>
</equipmentCategories>
</equipment>
<daysOfWeekAvailable>
<dateRange>
<startDate></startDate>
<daysOfWeek>
<sunday></sunday>
<monday></monday>
<tuesday></tuesday>
<wednesday></wednesday>
<thursday></thursday>
<friday></friday>
<saturday></saturday>
</daysOfWeek>
<endDate></endDate>
</dateRange>
</daysOfWeekAvailable>
<pickupLocations/>
<dropOffLocations/>
<pricingOptions/>
<priceCodeId></priceCodeId>
<allowedPassengers>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName></systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName></systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName></systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName></systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
<passengerType>
<systemTypeId></systemTypeId>
<systemTypeName></systemTypeName>
<name></name>
<defaultValue></defaultValue>
<basePrice></basePrice>
</passengerType>
</allowedPassengers>
<sharedInventoryDetails>
<isParent></isParent>
<childrenActivities></childrenActivities>
</sharedInventoryDetails>
</activity>
<businessHours>
<hours>
<startDate></startDate>
<openingTime></openingTime>
<closingTime></closingTime>
<endDate></endDate>
</hours>
</businessHours>
</methodResponse>
</response>

Changes to this API

Request Parameters changed

None

Response Parameters changed

Field
Description
configuredTime.equipmentAvailable
Number of equipment available for time
configuredTime.status
The status of that time. Possible values are:
AVAILABLE This availability is available for sale
FREESALE This availability has no capacity and is available.
SOLD_OUT This availability is not available
configuredTime.inventoryCheckCode
Integer value representing the configuredTime.status value.
configuredTime.activityTimeAvailableMessage
A human readable message describing the inventory at that time.
activity.activityTypeSubType
FIXEDTIME This indicates that the activity will have a fixed departure time. (Eg 2 hr bike rental)
CUSTOMTIME Indicates the guest can pick a departure time (Typically used for activity.activityType 505 or Rentals) Eg. Bike rental with open return time.
activity.duration
activity.durationValue
activity.durationUnit
activity.activityTimeDuration
activity.activityTimeDurationUnits