Module: Whitepages

Defined in:
lib/whitepages.rb,
lib/whitepages/version.rb

Overview

:nodoc:

Defined Under Namespace

Modules: VERSION

Class Method Summary collapse

Class Method Details

.find_person(options) ⇒ Object

Retrieves contact information about a person, such as a telephone number and address Accepts a hash:

  • firstname - First Name

  • lastname - Last Name (REQUIRED)

  • house - May take a range, in the form [start-end]

  • apt - Apartment

  • street - Street

  • city - City

  • state - State

  • zip - ZipCode/PostalCode

  • areacode - AreaCode

  • metro - Whether or not to expand the search to the metro area

  • api_key - The API key obtained from the Whitpages Developer website

More details may be found here: developer.whitepages.com/docs/Methods/find_person



35
36
37
 
# File 'lib/whitepages.rb', line 35

def self.find_person(options)
  return XmlSimple.xml_in(RestClient.get(build_url(options, "find_person")))
end

.reverse_address(options) ⇒ Object

Retrieves contact information about the people at an address

  • house - May take a range, in the form [start-end]

  • apt - Apartment

  • street - Street (REQUIRED)

  • city - City

  • state - State

  • zip - ZipCode/PostalCode

  • areacode - AreaCode

  • api_key - The API key obtained from the Whitpages Developer website

More details may be found here: developer.whitepages.com/docs/Methods/reverse_address



59
60
61
 
# File 'lib/whitepages.rb', line 59

def self.reverse_address(options)
  return XmlSimple.xml_in(RestClient.get(build_url(options, "reverse_address")))
end

.reverse_phone(options) ⇒ Object

Retrieves contact information about a telephone number Accepts a hash:

  • phone - May be 7 digits if state provided otherwise 10 (REQUIRED)

  • state - Two digit code for the state

  • api_key - The API key obtained from the Whitpages Developer website

More details may be found here: developer.whitepages.com/docs/Methods/reverse_phone



45
46
47
 
# File 'lib/whitepages.rb', line 45

def self.reverse_phone(options)  
  return XmlSimple.xml_in(RestClient.get(build_url(options, "reverse_phone")))
end