com.bookeo.api.service

Class AvailabilityApi

java.lang.Object

com.bookeo.api.service.AvailabilityApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-03T18:48:57.986-05:00")
public class AvailabilityApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AvailabilityApi()
AvailabilityApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
MatchingSlotList	availabilityMatchingslotsPageNavigationTokenGet(String pageNavigationToken, Integer pageNumber) Navigate results of a matching slots search
void	availabilityMatchingslotsPost(MatchingSlotsSearchParameters search, Integer itemsPerPage) Find available slots matching given search parameters Create a search for available slots that match the given search parameters.\n Note that there are two different searches possible, /availability/slots and /availability/matchingslots (this endpoint).\n The former simply shows the number of available seats for each available slot.
SlotList	availabilitySlotsGet(String productId, Date startTime, Date endTime, Integer itemsPerPage, String pageNavigationToken, Integer pageNumber) Get information about the availability of a product Performs a basic search to find available slots and number of seats in each.\n Note that there are two different searches possible, /availability/slots (this endpoint) and /availability/matchingslots .\n The former simply shows the number of available seats for each available slot.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AvailabilityApi

public AvailabilityApi()

AvailabilityApi

public AvailabilityApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

availabilityMatchingslotsPost

public void availabilityMatchingslotsPost(MatchingSlotsSearchParameters search,
                                          Integer itemsPerPage)
                                   throws ApiException

Find available slots matching given search parameters Create a search for available slots that match the given search parameters.\n Note that there are two different searches possible, /availability/slots and /availability/matchingslots (this endpoint).\n The former simply shows the number of available seats for each available slot. The latter (this one) takes as input the participant numbers, and shows the slots that are available for those numbers, and an estimate of the price.\n Parameters include product code, number of people and options.\n The response contains a \"Location\" header, which can be invoked to navigate the results of the search.

Parameters:

search -

itemsPerPage - .\nmaximum: 300

Throws:

ApiException

availabilityMatchingslotsPageNavigationTokenGet

public MatchingSlotList availabilityMatchingslotsPageNavigationTokenGet(String pageNavigationToken,
                                                                        Integer pageNumber)
                                                                 throws ApiException

Navigate results of a matching slots search

Parameters:

pageNavigationToken -

pageNumber -

Returns:

MatchingSlotList

Throws:

ApiException

availabilitySlotsGet

public SlotList availabilitySlotsGet(String productId,
                                     Date startTime,
                                     Date endTime,
                                     Integer itemsPerPage,
                                     String pageNavigationToken,
                                     Integer pageNumber)
                              throws ApiException

Get information about the availability of a product Performs a basic search to find available slots and number of seats in each.\n Note that there are two different searches possible, /availability/slots (this endpoint) and /availability/matchingslots .\n The former simply shows the number of available seats for each available slot. The latter takes as input the participant numbers, and shows the slots that are available for those numbers, and an estimate of the price.\n /availability/slots cannot be used for products of type flexibleTime . For those products, use /availability/matchingslots .

Parameters:

productId - the product code (see /availability/products). Required unless pageNavigationToken is used. Note that the product must be of type \"fixed\" or \"fixedCourse\". For products of type \"flexibleTime\", use /availability/matchingslots instead.

startTime - the start time to search from. Required unless pageNavigationToken is used.

endTime - the end time to search to. Required unless pageNavigationToken is used. The maximum date range in a single call is 31 days.

itemsPerPage - .\nmaximum: 300

pageNavigationToken -

pageNumber -

Returns:

SlotList

Throws:

ApiException