Single Activity Details
Get details on a single activity, attraction or event.
zapiGetActivityDetailsByActivityId
GET https://{yourdomainname}.zaui.net/zapi/
This method retrieves details for a single activity.
Request Body
Name
Type
Description
methodName*
string
The method being called.
activityId*
integer
ID of the activity.
activityDate*
integer
The travel date. Format: YYYY:MM:DD.
zapiUserId*
integer
Generated by the supplier system when a new contact is created.
zapiAccountId*
integer
Generated by the supplier system.
zapiToken*
integer
Token that must be used for a reseller to communicate with the supplier system.
verboseMode
string
True or False - Using this flag will curtail the amount of detail provided in the response.
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiGetActivityDetailsByActivityId</methodName>
<methodErrorCode>0</methodErrorCode>
<methodErrorMessage/>
<verboseMode>true</verboseMode>
<activity>
<categoryName>
<![CDATA[ Nadine's Test CATegory ]]>
</categoryName>
<categoryId>465</categoryId>
<activityName>
<![CDATA[ Rentals - TANDEM Mountain Bike (Specific Time) ]]>
</activityName>
<activityId>2525</activityId>
<activityDate>2021-07-23</activityDate>
<activityTypeId>505</activityTypeId>
<activityTypeAsString>Rental</activityTypeAsString>
<activityTypeSubType>FIXEDTIME</activityTypeSubType>
<activityIsMultiday>true</activityIsMultiday>
<activityMultiDayStart/>
<activityMultiDayDuration/>
<activityTimeDuration/>
<activityTimeDurationUnits/>
<isFreeSell>false</isFreeSell>
<supplierConfirmationNumberSystemManaged>false</supplierConfirmationNumberSystemManaged>
<supplierConfirmationNumberDisplayed>false</supplierConfirmationNumberDisplayed>
<operatedByCompanyId>1</operatedByCompanyId>
<operatedByCompanyName>
<![CDATA[ Zaui Test Company ]]>
</operatedByCompanyName>
<ticketExpiry/>
<ticketPrinterText>
<![CDATA[ Please keep this ticket for your records. ]]>
</ticketPrinterText>
<description>
<![CDATA[ ]]>
</description>
<shortDescription>
<![CDATA[ ]]>
</shortDescription>
<imageUrl>
<![CDATA[ http://pachena.zaui.com/kfawcett/secure.zauitour.stable.com/themes/default/img/image_not_available.png ]]>
</imageUrl>
<activityTimes>
<activityTime>
<activityTimeStart>9:00:00</activityTimeStart>
<activityTimeCancelled>false</activityTimeCancelled>
<activityTimeAvailable>false</activityTimeAvailable>
<activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage>AVAILABLE</activityTimeAvailableMessage>
<inventoryCheckCode>0</inventoryCheckCode>
<inventoryCheckMessage/>
<activityTimeSpotsRemaining>5</activityTimeSpotsRemaining>
<numberOnStandby>0</numberOnStandby>
<isStandbyAvailable>false</isStandbyAvailable>
<status>AVAILABLE</status>
<fixedDepartureOptions>
<option>
<optionId>111</optionId>
<optionName>Half Day Rental</optionName>
<durationValue>240</durationValue>
<durationUnits>minutes</durationUnits>
</option>
<option>
<optionId>110</optionId>
<optionName>Full Day Rental</optionName>
<durationValue>1440</durationValue>
<durationUnits>minutes</durationUnits>
</option>
</fixedDepartureOptions>
</activityTime>
<activityTime>
<activityTimeStart>13:00:00</activityTimeStart>
<activityTimeCancelled>false</activityTimeCancelled>
<activityTimeAvailable>false</activityTimeAvailable>
<activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage>AVAILABLE</activityTimeAvailableMessage>
<inventoryCheckCode>0</inventoryCheckCode>
<inventoryCheckMessage/>
<activityTimeSpotsRemaining>5</activityTimeSpotsRemaining>
<numberOnStandby>0</numberOnStandby>
<isStandbyAvailable>false</isStandbyAvailable>
<status>AVAILABLE</status>
<fixedDepartureOptions>
<option>
<optionId>111</optionId>
<optionName>Half Day Rental</optionName>
<durationValue>240</durationValue>
<durationUnits>minutes</durationUnits>
</option>
</fixedDepartureOptions>
</activityTime>
</activityTimes>
<daysOfWeekAvailable>
<dateRange>
<startDate>2020-09-03</startDate>
<daysOfWeek>
<sunday>true</sunday>
<monday>true</monday>
<tuesday>true</tuesday>
<wednesday>true</wednesday>
<thursday>true</thursday>
<friday>true</friday>
<saturday>true</saturday>
</daysOfWeek>
<endDate>2021-09-03</endDate>
</dateRange>
</daysOfWeekAvailable>
<pickupLocations/>
<dropOffLocations/>
<pricingOptions/>
<priceCodeId>1411</priceCodeId>
<allowedPassengers>
<passengerType>
<systemTypeId>11</systemTypeId>
<systemTypeName>adults</systemTypeName>
<name>
<![CDATA[ Adults (18+) ]]>
</name>
<defaultValue>1</defaultValue>
<basePrice>$50.00</basePrice>
</passengerType>
</allowedPassengers>
<sharedInventoryDetails>
<isParent>true</isParent>
<childrenActivities/>
</sharedInventoryDetails>
</activity>
<businessHours>
<hours>
<startDate>2019-07-04</startDate>
<openingTime>07:00:00</openingTime>
<closingTime>23:00:00</closingTime>
<endDate>2024-07-04</endDate>
</hours>
</businessHours>
</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>0</methodErrorCode>
<methodErrorMessage/>
<verboseMode>true</verboseMode>
<activity>
<categoryName>
<![CDATA[Bicycle Rentals]]>
</categoryName>
<categoryId>3</categoryId>
<activityName>
<![CDATA[Electric Bike Rentals]]>
</activityName>
<activityId>128</activityId>
<activityDate>2021-11-30</activityDate>
<activityTypeId>505</activityTypeId>
<activityTypeAsString>Rental</activityTypeAsString>
<activityTypeSubType>FIXEDTIME</activityTypeSubType>
<activityIsMultiday>false</activityIsMultiday>
<activityMultiDayStart/>
<activityMultiDayDuration/>
<activityTimeDuration/>
<activityTimeDurationUnits/>
<isFreeSell>false</isFreeSell>
<supplierConfirmationNumberSystemManaged>false</supplierConfirmationNumberSystemManaged>
<supplierConfirmationNumberDisplayed>false</supplierConfirmationNumberDisplayed>
<operatedByCompanyId>1</operatedByCompanyId>
<operatedByCompanyName>
<![CDATA[Supplier Test System]]>
</operatedByCompanyName>
<ticketExpiry/>
<ticketPrinterText>
<![CDATA[Please keep this ticket for your records.]]>
</ticketPrinterText>
<description>
<![CDATA[]]>
</description>
<shortDescription>
<![CDATA[]]>
</shortDescription>
<imageUrl>
<![CDATA[]]>
</imageUrl>
<activityTimes>
<activityTime>
<activityTimeStart>09:00:00</activityTimeStart>
<activityTimeCancelled>false</activityTimeCancelled>
<status>AVAILABLE</status>
<fixedDepartureOptions>
<option>
<optionId>5</optionId>
<optionName>Full Day Rental</optionName>
<durationValue>480</durationValue>
<durationUnits>minutes</durationUnits>
</option>
<option>
<optionId>6</optionId>
<optionName>Half Day Rental</optionName>
<durationValue>240</durationValue>
<durationUnits>minutes</durationUnits>
</option>
</fixedDepartureOptions>
</activityTime>
<activityTime>
<activityTimeStart>13:00:00</activityTimeStart>
<activityTimeCancelled>false</activityTimeCancelled>
<status>AVAILABLE</status>
<fixedDepartureOptions>
<option>
<optionId>6</optionId>
<optionName>Half Day Rental</optionName>
<durationValue>240</durationValue>
<durationUnits>minutes</durationUnits>
</option>
</fixedDepartureOptions>
</activityTime>
</activityTimes>
<equipment>
<equipmentCategories>
<equipmentCategoryId>1</equipmentCategoryId>
<equipmentCategoryName>Adult Bikes</equipmentCategoryName>
<availableEquipment>
<equipmentItem>
<equipmentId>580</equipmentId>
<equipmentName>Adult Bikes 1</equipmentName>
</equipmentItem>
<equipmentItem>
<equipmentId>581</equipmentId>
<equipmentName>Adult Bikes 2</equipmentName>
</equipmentItem>
<equipmentItem>
<equipmentId>582</equipmentId>
<equipmentName>Adult Bikes 3</equipmentName>
</equipmentItem>
<equipmentItem>
<equipmentId>583</equipmentId>
<equipmentName>Adult Bikes 4</equipmentName>
</equipmentItem>
<equipmentItem>
<equipmentId>584</equipmentId>
<equipmentName>Adult Bikes 5</equipmentName>
</equipmentItem>
<equipmentItem>
<equipmentId>585</equipmentId>
<equipmentName>Adult Bikes 6</equipmentName>
</equipmentItem>
<equipmentItem>
<equipmentId>586</equipmentId>
<equipmentName>Adult Bikes 7</equipmentName>
</equipmentItem>
<equipmentItem>
<equipmentId>587</equipmentId>
<equipmentName>Adult Bikes 8</equipmentName>
</equipmentItem>
<equipmentItem>
<equipmentId>588</equipmentId>
<equipmentName>Adult Bikes 9</equipmentName>
</equipmentItem>
<equipmentItem>
<equipmentId>589</equipmentId>
<equipmentName>Adult Bikes 10</equipmentName>
</equipmentItem>
</availableEquipment>
</equipmentCategories>
<equipmentCategories>
<equipmentCategoryId>2</equipmentCategoryId>
<equipmentCategoryName>Youth Bikes</equipmentCategoryName>
<availableEquipment>
<equipmentItem>
<equipmentId>590</equipmentId>
<equipmentName>Youth Bikes 1</equipmentName>
</equipmentItem>
</availableEquipment>
</equipmentCategories>
<equipmentCategories>
<equipmentCategoryId>3</equipmentCategoryId>
<equipmentCategoryName>Child Bikes</equipmentCategoryName>
<availableEquipment>
<equipmentItem>
<equipmentId>591</equipmentId>
<equipmentName>Child Bikes 1</equipmentName>
</equipmentItem>
</availableEquipment>
</equipmentCategories>
</equipment>
<daysOfWeekAvailable>
<dateRange>
<startDate>2021-11-16</startDate>
<daysOfWeek>
<sunday>true</sunday>
<monday>true</monday>
<tuesday>true</tuesday>
<wednesday>true</wednesday>
<thursday>true</thursday>
<friday>true</friday>
<saturday>true</saturday>
</daysOfWeek>
<endDate>2030-11-30</endDate>
</dateRange>
</daysOfWeekAvailable>
<pickupLocations/>
<dropOffLocations/>
<pricingOptions/>
<priceCodeId>451</priceCodeId>
<allowedPassengers>
<passengerType>
<systemTypeId>10</systemTypeId>
<systemTypeName>seniors</systemTypeName>
<name>
<![CDATA[Seniors]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$0.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>11</systemTypeId>
<systemTypeName>adults</systemTypeName>
<name>
<![CDATA[Adults]]>
</name>
<defaultValue>2</defaultValue>
<basePrice>$0.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>12</systemTypeId>
<systemTypeName>students</systemTypeName>
<name>
<![CDATA[Students]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$0.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>13</systemTypeId>
<systemTypeName>children</systemTypeName>
<name>
<![CDATA[Children]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$0.00</basePrice>
</passengerType>
<passengerType>
<systemTypeId>14</systemTypeId>
<systemTypeName>infants</systemTypeName>
<name>
<![CDATA[Infants]]>
</name>
<defaultValue>0</defaultValue>
<basePrice>$0.00</basePrice>
</passengerType>
</allowedPassengers>
<sharedInventoryDetails>
<isParent>true</isParent>
<childrenActivities/>
</sharedInventoryDetails>
</activity>
<businessHours>
<hours>
<startDate>2010-01-01</startDate>
<openingTime>06:00:00</openingTime>
<closingTime>20:00:00</closingTime>
<endDate>2030-12-31</endDate>
</hours>
</businessHours>
</methodResponse>
</respons<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
Last updated
Was this helpful?