module HomeAway::API::Domain::Listing

Public Instance Methods

listing(id, q=nil, l=nil) click to toggle source

Given a listing id, return details about the listing.

analogous to calling a GET on API url /public/listing

Headers:

  • X-HomeAway-DisplayLocale: If a locale is not specified in a query param, it will be searched for in the X-HomeAway-DisplayLocale Header. If it is not supplied in either area the default locale of the user will be selected if it exists. Otherwise the Accept-Language Header will be used.

@param id [String] The id of the listing. @option opts [String] :q Use the q parameter to fetch specific listing details. Valid options are AVAILABILITY, DETAILS, LOCATIONS, PHOTOS, RATES, REVIEWS. If no value is given, the listing is returned with minimal content. Can be an array of multiple values. @option opts [String] :l Use the l parameter to specify the locale. For example: 'fr' @return [HomeAway::API::Response] the result of the call to the API

# File lib/homeaway/api/domain/listing.rb, line 32
def listing(id, q=nil, l=nil)
  params = {'id' => id.to_s}
  params['locale'] = l unless l == nil
  params['q'] = HomeAway::API::Util::Validators.array(q) unless q == nil
  get '/public/listing', HomeAway::API::Util::Validators.query_keys(params)
end