Affiliate API - Get Locality Rooms Grids( getLocalityRoomsGrids )
Navigate to Affiliate API
Details
- CustomActionName get-locality-rooms-grids
- Name Get Locality Rooms Grids
- Description Find room grid information for a specified request.
- MethodGroup Inventory Service
Parameters
-
q
Type StringDescription The hotel[s] you wish to obtain a price grid for. If you wish to obtain multiple hotels data, supply 'q' as a comma separated list. <br />NOTE: If not supplied with optional parameters, the grid will default to the following data: <br />* checkin = today <br />* nights = 3 <br />* adults = 2 <br />* children = 0 <br />Example <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&webid=45">/api/get-locality-rooms-grids?q=34604&webid=45</a>Example <a class="showCode" href="/api/get-locality-rooms-grids?q=34604,98609&webid=45">/api/get-locality-rooms-grids?q=34604,98609&webid=45</a>Required true
-
includedetails
Type BooleanDescription Include property information with the grid data.Example <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&includedetails=true&webid=45">/api/get-locality-rooms-grids?q=34604&includedetails=true&webid=45</a>
-
checkin
Type StringDescription Check In: The date for the start of the grid.Example <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&checkin=2011-05-12&webid=45">/api/get-locality-rooms-grids?q=34604&checkin=2011-05-12&webid=45</a>
-
nights
Type Int32Description Nights: The number of nights stay until check-out.Example <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&nights=7&webid=45">/api/get-locality-rooms-grids?q=34604&nights=7&webid=45</a>
-
adults
Type Int32Description Adults: The number of adult guests.Example <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&adults=4&webid=45">/api/get-locality-rooms-grids?q=34604&adults=4&webid=45</a>
-
children
Type Int32Description Children: The number of children guests.Example <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&children=2&webid=45">/api/get-locality-rooms-grids?q=34604&children=2&webid=45</a>
-
private
Type StringDescription If you wish to include private apartments with normal results, set to <em>include</em>. <br /> If you wish to ONLY search for private apartments, you need to set this to <em>true</em>. <br />Example <a class="showCode" href="/api/get-locality-rooms-grids?q=146793&private=include&webid=45">/api/get-locality-rooms-grids?q=146793&private=include&webid=45</a>Example <a class="showCode" href="/api/get-locality-rooms-grids?q=146793&private=true&webid=45">/api/get-locality-rooms-grids?q=146793&private=true&webid=45</a>
-
cb
Type StringDescription Define a callback function for cross-site ajax.Example <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&webid=45&cb=jsonpFEBC23945A">/api/get-locality-rooms-grids?q=34604&webid=45&cb=jsonpFEBC23945A</a>
-
currency
Type StringDescription Set the currency you want the rates to be returned in. You use the 3 character country iso code. eg AUD = Australia.Example <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&children=2¤cy=AUD&webid=45">/api/get-locality-rooms-grids?q=34604&children=2¤cy=AUD&webid=45</a>
-
ShowInclusions
Type BooleanDescription Toggles if inclusions are included in the responseExample <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&children=2&ShowInclusions=true&webid=45">/api/get-locality-rooms-grids?q=34604&children=2&ShowInclusions=true&webid=45</a>
-
ShowMinNights
Type BooleanDescription Toggles if min nights are included in the responseExample <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&children=2&ShowMinNights=true&webid=45">/api/get-locality-rooms-grids?q=34604&children=2&ShowMinNights=true&webid=45</a>
-
voucherCode
Type StringDescription Voucher code to apply to the returned ratesExample <a class="showCode" href="/api/get-locality-rooms-grids?q=34604&children=2&voucherCode=DISCOUNT&webid=45">/api/get-locality-rooms-grids?q=34604&children=2&voucherCode=DISCOUNT&webid=45</a>
-
webid
Type Int32Description The affiliate id for the message you are requesting.Required true
-
callback
Type StringDescription Define a callback function for cross-site ajax
-
IgnoreCache
Type Boolean
-
ShowError
Type Boolean