Bookeasy - Get events Rates Grid( getEventsRatesGrid )

Navigate to Bookeasy

Details

  • Name Get events Rates Grid
  • Description Responsible for returning rate information. Includes Operator and event details.
  • MethodGroup Events

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/getEventsRatesGrid?q=4&adults=2">/be/getEventsRatesGrid?q=4&adults=2</a>
  • children
    Type Int32
    Description How many children will be attending.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&adults=1&children=2 ">/be/getEventsRatesGrid?q=4&adults=1&children=2 </a>
  • concessions
    Type Int32
    Description How many children will be attending.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&adults=1&concession=1">/be/getEventsRatesGrid?q=4&adults=1&concession=1</a>
  • family
    Type Int32
    Description How many families will be attending.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&family=1">/be/getEventsRatesGrid?q=4&family=1</a>
  • date
    Type DateTime
    Description The date you will be searching for.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=85&date=2018-06-30">/be/getEventsRatesGrid?q=85&date=2018-06-30</a>
  • infants
    Type Int32
    Description How many infants will be attending.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&adults=1&infants=1 ">/be/getEventsRatesGrid?q=4&adults=1&infants=1 </a>
  • observers
    Type Int32
    Description How many infants will be attending.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&adults=1&observers=1">/be/getEventsRatesGrid?q=4&adults=1&observers=1</a>
  • period
    Type Int32
    Description The number of nights.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&period=2 ">/be/getEventsRatesGrid?q=4&period=2 </a>
  • students
    Type Int32
    Description The number of students that will be attending
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&adults=1&students=1">/be/getEventsRatesGrid?q=4&adults=1&students=1</a>
  • operators
    Type String
    Description A list of operator ids you wish to filter the search by
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&operators=28975,44666">/be/getEventsRatesGrid?q=4&operators=28975,44666</a>
  • eventType
    Type String
    Description A list of event types that you with to filter the search by
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&inDate=2018-06-21&eventType=Sightseeing">/be/getEventsRatesGrid?q=4&inDate=2018-06-21&eventType=Sightseeing</a>
  • InclAvailability
    Type Boolean
    Description Returns Availability Data if requested..
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&adults=1&children=2&InclAvailability=true">/be/getEventsRatesGrid?q=4&adults=1&children=2&InclAvailability=true</a>
  • AccomGrouping
    Type String
    Description The accommodation grouping to filter the results.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=85&date=2018-06-21&accomGrouping=Studio/Apartments">/be/getEventsRatesGrid?q=85&date=2018-06-21&accomGrouping=Studio/Apartments</a>
  • LocationId
    Type Int32
    Description Filters results to only return data for this location
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&LocationId=36">/be/getEventsRatesGrid?q=4&LocationId=36</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/getEventsRatesGrid?q=85&CampaignId=6">/be/getEventsRatesGrid?q=85&CampaignId=6</a>
  • LocationName
    Type String
    Description Filters the results to only return operators that exist in the location specified.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=85&LocationName=Bendigo">/be/getEventsRatesGrid?q=85&LocationName=Bendigo</a>
  • RegionName
    Type String
    Description Filters the results to only return operators that exist in the Region specified.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=85&RegionName=Grampions">/be/getEventsRatesGrid?q=85&RegionName=Grampions</a>
  • StateName
    Type String
    Description Filters the results to only return operators that exist in the State specified.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=85&StateName=VIC">/be/getEventsRatesGrid?q=85&StateName=VIC</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/getEventsRatesGrid?q=85&ExternalSearch=true">/be/getEventsRatesGrid?q=85&ExternalSearch=true</a>
  • enforceBookingConditions
    Type Boolean
    Description Property will only return if the event is available for the search conditions you specify.
    Example <a class="showCode" href="/be/getEventsRatesGrid?q=4&enforceBookingConditions=true ">/be/getEventsRatesGrid?q=4&enforceBookingConditions=true </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>