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>
<request>
   <zapiToken></zapiToken>
   <zapiAccountId></zapiAccountId>
   <zapiUserId></zapiUserId>
   <zapiMethod>
      <methodName>zapiGetActivityDetailsByActivityId</methodName>
      <activityId></activityId>
      <activityDate></activityDate>
      <verboseMode></verboseMode>
   </zapiMethod>
</request>

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

PreviousCheck InventoryNextUpcoming Activities

Last updated

Was this helpful?