Module: Taxa::OpenTreeOfLife::TNRS::AutocompleteName

Included in:
Taxa::OpenTreeOfLife::TNRS
Defined in:
lib/taxa/open_tree_of_life/tnrs/autocomplete_name.rb

Overview

tnrs autocomplete_name api endpoint

Instance Method Summary collapse

Instance Method Details

#autocomplete_name(**parameters) ⇒ Object

Raises:

  • (ArgumentError) 


10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/taxa/open_tree_of_life/tnrs/autocomplete_name.rb', line 10

def autocomplete_name(**parameters)
  name = parameters[:name]
  raise ArgumentError if name.nil?

  context_name = parameters[:context_name]
  include_suppressed = parameters[:include_suppressed]

  payload = { name: name, context_name: context_name, include_suppressed: include_suppressed }.compact
  url = 'https://api.opentreeoflife.org/v3/tnrs/autocomplete_name'
  response = @http_client.post(url, JSON.generate(payload), 'Content-Type' => 'application/json')
  JSON.parse(response.body)
end