Batch Availability
This call will allow checking availability for a single activity, across many days.
Last updated
This call will allow checking availability for a single activity, across many days.
Last updated
GET
https://{yourdomainname}.zaui.net/zapi/
Name | Type | Description |
---|---|---|
<?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiBatchAvailability</methodName>
<activities>
<activity>
<activityName>
<![CDATA[Canyon Icewalk ]]>
</activityName>
<activityId>80</activityId>
<batchAvailability>
<dates>
<date>
<activityDate>2021-12-01</activityDate>
<availability>
<activityTime>
<activityTimeStart>13:00:00</activityTimeStart>
<activityTimeCancelled>false</activityTimeCancelled>
<activityTimeAvailable>true</activityTimeAvailable>
<activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
<inventoryCheckCode>0</inventoryCheckCode>
<inventoryCheckMessage/>
<activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
<numberOnStandby>0</numberOnStandby>
<isStandbyAvailable>false</isStandbyAvailable>
<status>SOLD_OUT</status>
<fixedDepartureOptions/>
</activityTime>
</availability>
</date>
<date>
<activityDate>2021-12-02</activityDate>
<availability>
<activityTime>
<activityTimeStart>13:00:00</activityTimeStart>
<activityTimeCancelled>false</activityTimeCancelled>
<activityTimeAvailable>true</activityTimeAvailable>
<activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
<inventoryCheckCode>0</inventoryCheckCode>
<inventoryCheckMessage/>
<activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
<numberOnStandby>0</numberOnStandby>
<isStandbyAvailable>false</isStandbyAvailable>
<status>SOLD_OUT</status>
<fixedDepartureOptions/>
</activityTime>
</availability>
</date>
<date>
<activityDate>2021-12-03</activityDate>
<availability>
<activityTime>
<activityTimeStart>13:00:00</activityTimeStart>
<activityTimeCancelled>false</activityTimeCancelled>
<activityTimeAvailable>true</activityTimeAvailable>
<activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
<inventoryCheckCode>0</inventoryCheckCode>
<inventoryCheckMessage/>
<activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
<numberOnStandby>0</numberOnStandby>
<isStandbyAvailable>false</isStandbyAvailable>
<status>SOLD_OUT</status>
<fixedDepartureOptions/>
</activityTime>
</availability>
</date>
<date>
<activityDate>2021-12-04</activityDate>
<availability>
<activityTime>
<activityTimeStart>13:00:00</activityTimeStart>
<activityTimeCancelled>false</activityTimeCancelled>
<activityTimeAvailable>true</activityTimeAvailable>
<activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
<inventoryCheckCode>0</inventoryCheckCode>
<inventoryCheckMessage/>
<activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
<numberOnStandby>0</numberOnStandby>
<isStandbyAvailable>false</isStandbyAvailable>
<status>SOLD_OUT</status>
<fixedDepartureOptions/>
</activityTime>
</availability>
</date>
<date>
<activityDate>2021-12-05</activityDate>
<availability>
<activityTime>
<activityTimeStart>13:00:00</activityTimeStart>
<activityTimeCancelled>false</activityTimeCancelled>
<activityTimeAvailable>true</activityTimeAvailable>
<activityTimeCancelledOnlineOnly>false</activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage>Available</activityTimeAvailableMessage>
<inventoryCheckCode>0</inventoryCheckCode>
<inventoryCheckMessage/>
<activityTimeSpotsRemaining>0</activityTimeSpotsRemaining>
<numberOnStandby>0</numberOnStandby>
<isStandbyAvailable>false</isStandbyAvailable>
<status>SOLD_OUT</status>
<fixedDepartureOptions/>
</activityTime>
</availability>
</date>
</dates>
</batchAvailability>
</activity>
</activities>
</methodResponse>
</response>
This callback does have the following restrictions:
Dates must be greater than or equal to the current system date.
The difference in start to end date can not exceed 31 days.
The end date can not exceed 31 days from the current date.
<request>
<zapiToken></zapiToken>
<zapiAccountId></zapiAccountId>
<zapiUserId></zapiUserId>
<zapiMethod>
<methodName>zapiBatchAvailability</methodName>
<activityId></activityId>
<activityStartDate></activityStartDate>
<activityEndDate></activityEndDate>
</zapiMethod>
</request>
<?xml version="1.0" encoding="utf-8"?>
<response>
<zapiVersion>2.1</zapiVersion>
<error>0</error>
<message>OK</message>
<methodResponse>
<methodName>zapiBatchAvailability</methodName>
<activities>
<activity>
<activityName></activityName>
<activityId></activityId>
<batchAvailability>
<dates>
<date>
<activityDate></activityDate>
<availability>
<activityTime>
<activityTimeStart></activityTimeStart>
<activityTimeCancelled></activityTimeCancelled>
<activityTimeAvailable></activityTimeAvailable>
<activityTimeCancelledOnlineOnly></activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage></activityTimeAvailableMessage>
<inventoryCheckCode></inventoryCheckCode>
<inventoryCheckMessage/>
<activityTimeSpotsRemaining></activityTimeSpotsRemaining>
<numberOnStandby></numberOnStandby>
<isStandbyAvailable></isStandbyAvailable>
<status></status>
<fixedDepartureOptions/>
</activityTime>
</availability>
</date>
<date>
<activityDate></activityDate>
<availability>
<activityTime>
<activityTimeStart></activityTimeStart>
<activityTimeCancelled></activityTimeCancelled>
<activityTimeAvailable></activityTimeAvailable>
<activityTimeCancelledOnlineOnly></activityTimeCancelledOnlineOnly>
<activityTimeAvailableMessage></activityTimeAvailableMessage>
<inventoryCheckCode></inventoryCheckCode>
<inventoryCheckMessage/>
<activityTimeSpotsRemaining></activityTimeSpotsRemaining>
<numberOnStandby></numberOnStandby>
<isStandbyAvailable></isStandbyAvailable>
<status></status>
<fixedDepartureOptions/>
</activityTime>
</availability>
</dates>
</batchAvailability>
</activity>
</activities>
</methodResponse>
</response>
zapiToken*
integer
Token that must be used for a reseller to communicate with the supplier system.
activityEndDate*
integer
The last date to check for availability. End date must be greater than or equal to the start date. Format: YYYY:MM:DD.
activityStartDate*
integer
The first date to check for availability. If the start date is less then the current system date, it will be reset to the current date. Format: YYYY:MM:DD.
zapiAccountId*
integer
Generated by the supplier system.
activityId*
integer
ID of the activity.
methodName*
string
The method being called.
zapiUserId*
integer
Generated by the supplier system when a new contact is created.