Module: YellowApi::Client::FindDealer

Included in:
YellowApi::Client
Defined in:
lib/yellow_api/client/find_dealer.rb

Instance Method Summary collapse

Instance Method Details

#find_dealer(parent_id, options = {}) ⇒ Hash

Note:

A business with several locations may have a "parent" listing (primary) and one or more "children" listings.

Returns a list of all dealers/franchises/branches for that business.

Examples:

YellowApi.find_dealer(6418182)
YellowApi.find_dealer(6418182, { :pgLen => 1 })

Parameters:

  • parent_id (Integer)

    The listingId of a parent business. A parent business can be identified by the ???isParent??? flag in the Listing object returned by FindBusinesses.

  • options (Hash) (defaults to: {})

    A customizable set of options

Options Hash (options):

  • :pg (Integer)

    The requested page. Default 1. Max 50.

  • :lang (String)

    en - English (default), fr - French

  • :pgLen (Integer)

    Number of results per page. Default 40. Max 100.

Returns:

  • (Hash)

See Also:



21
22
23
24
25
# File 'lib/yellow_api/client/find_dealer.rb', line 21

def find_dealer(parent_id, options={})
  options[:pid] = parent_id
  
  get('/FindDealer/', options)
end