Bookeasy - Get tours Rates Grid( getToursRatesGrid )

Navigate to Bookeasy

Details

  • Name Get tours Rates Grid
  • Description Responsible for returning rate information. Includes Operator and tour details.
  • MethodGroup Tours

Parameters

  • q
    Type Int32
    Description The control id for the visitor center you are searching from.
    Required true
  • adults
    Type Int32
    Description How many adults will be attending.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&adults=2&date=2018-07-29">/be/getToursRatesGrid?q=4&adults=2&date=2018-07-29</a>
  • children
    Type Int32
    Description How many children will be attending.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&adults=1&children=2&date=2018-07-29">/be/getToursRatesGrid?q=4&adults=1&children=2&date=2018-07-29</a>
  • concessions
    Type Int32
    Description How many children will be attending.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&adults=1&concession=1&date=2018-07-29">/be/getToursRatesGrid?q=4&adults=1&concession=1&date=2018-07-29</a>
  • family
    Type Int32
    Description How many families will be attending.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&family=1&date=2018-07-29">/be/getToursRatesGrid?q=4&family=1&date=2018-07-29</a>
  • date
    Type DateTime
    Description The date you will be searching for.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&date=2018-07-29">/be/getToursRatesGrid?q=4&date=2018-07-29</a>
  • infants
    Type Int32
    Description How many infants will be attending.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&adults=1&infants=1&date=2018-07-29">/be/getToursRatesGrid?q=4&adults=1&infants=1&date=2018-07-29</a>
  • observers
    Type Int32
    Description How many infants will be attending.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&adults=1&observers=1&date=2018-07-29">/be/getToursRatesGrid?q=4&adults=1&observers=1&date=2018-07-29</a>
  • period
    Type Int32
    Description The number of nights.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&period=2&date=2018-07-29">/be/getToursRatesGrid?q=4&period=2&date=2018-07-29</a>
  • students
    Type Int32
    Description The number of students that will be attending
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&adults=1&students=1&date=2018-07-29">/be/getToursRatesGrid?q=4&adults=1&students=1&date=2018-07-29</a>
  • operators
    Type String
    Description A list of operator ids you wish to filter the search by
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&operators=28975,44666&date=2018-07-29">/be/getToursRatesGrid?q=4&operators=28975,44666&date=2018-07-29</a>
  • tourType
    Type String
    Description A list of tour types that you with to filter the search by
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&inDate=2011-01-21&tourType=Sightseeing&date=2018-07-29">/be/getToursRatesGrid?q=4&inDate=2011-01-21&tourType=Sightseeing&date=2018-07-29</a>
  • InclAvailability
    Type Boolean
    Description Returns Availability Data if requested..
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&adults=1&children=2&InclAvailability=true&date=2018-07-29">/be/getToursRatesGrid?q=4&adults=1&children=2&InclAvailability=true&date=2018-07-29</a>
  • AccomGrouping
    Type String
    Description The accommodation grouping to filter the results.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&date=2018-07-29&accomGrouping=Studio/Apartments">/be/getToursRatesGrid?q=4&date=2018-07-29&accomGrouping=Studio/Apartments</a>
  • LocationId
    Type Int32
    Description Filters results to only return data for this location
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&LocationId=36&date=2018-07-29">/be/getToursRatesGrid?q=4&LocationId=36&date=2018-07-29</a>
  • CampaignId
    Type Int32
    Description Filters the results to only return specific campaign information. This overrides the operators parameter
    Example <a class="showCode" href="/be/getToursRatesGrid?q=85&CampaignId=6&date=2018-07-29">/be/getToursRatesGrid?q=85&CampaignId=6&date=2018-07-29</a>
  • LocationName
    Type String
    Description Filters the results to only return operators that exist in the location specified.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=85&LocationName=Bendigo&date=2018-07-29">/be/getToursRatesGrid?q=85&LocationName=Bendigo&date=2018-07-29</a>
  • RegionName
    Type String
    Description Filters the results to only return operators that exist in the Region specified.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=85&RegionName=Grampions&date=2018-07-29">/be/getToursRatesGrid?q=85&RegionName=Grampions&date=2018-07-29</a>
  • StateName
    Type String
    Description Filters the results to only return operators that exist in the State specified.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=85&StateName=VIC&date=2018-07-29">/be/getToursRatesGrid?q=85&StateName=VIC&date=2018-07-29</a>
  • ExternalSearch
    Type Boolean
    Description Will allow you to search operators that are not linked to your visitor center.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=85&ExternalSearch=true&date=2018-07-29">/be/getToursRatesGrid?q=85&ExternalSearch=true&date=2018-07-29</a>
  • enforceBookingConditions
    Type Boolean
    Description Property will only return if the tour is available for the search conditions you specify.
    Example <a class="showCode" href="/be/getToursRatesGrid?q=4&enforceBookingConditions=true&date=2018-07-29s">/be/getToursRatesGrid?q=4&enforceBookingConditions=true&date=2018-07-29s</a>
  • uiView
    Type Boolean
  • IgnoreCache
    Type Boolean
  • ShowError
    Type Boolean
  • callback
    Type String

Response

  • Type List<<a href="/ui/Show?name=Get Rates Grid Detail Model">getRatesGridRatesDetailsModel</a>>
    Name Get Rates Grid Detail Model
    Description Contains the definition of a Rate block for a particular operator

Faults

  • Name Json Result Error
    Description This error is thrown where something happens and it was unexpected.
    Type <a href="/ui/Show?name=Json Result Error">JsonResultError</a>