Class: OpenFdaApi::Other

Inherits:

Endpoint

• Object
• Endpoint
• OpenFdaApi::Other

Defined in:

lib/open_fda_api/other.rb

Overview

Interact with the Other API Endpoint:

- NSDE
- Substance Data Reports

Instance Attribute Summary

Attributes inherited from Endpoint

#client

Instance Method Summary

• #nsde(search: [], sort: [], count: [], skip: 0, limit: 1) ⇒ Object

  Response from the API parsed as JSON.

• #substance_data_reports(search: [], sort: [], count: [], skip: 0, limit: 1) ⇒ Object

  Response from the API parsed as JSON.

Methods inherited from Endpoint

#build_inputs, #build_query, #initialize, #make_request

Constructor Details

This class inherits a constructor from OpenFdaApi::Endpoint

Instance Method Details

#nsde(search: [], sort: [], count: [], skip: 0, limit: 1) ⇒ Object

Returns Response from the API parsed as JSON.

Parameters:

• search (Array<Hash>) (defaults to: []) —

  Search fields defined in open.fda.gov/apis/other/nsde/searchable-fields/

• sort (Array<Hash>) (defaults to: []) —

  Sort fields defined in open.fda.gov/apis/other/nsde/searchable-fields/

• count (Array<Hash>) (defaults to: []) —

  Count fields defined open.fda.gov/apis/other/nsde/searchable-fields/

• skip (Integer) (defaults to: 0) —

  Number of results to skip

• limit (Integer) (defaults to: 1) —

  Number of results to return

Returns:

• Response from the API parsed as JSON

# File 'lib/open_fda_api/other.rb', line 14

def nsde(search: [], sort: [], count: [], skip: 0, limit: 1)
  endpoint = "nsde.json"
  inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
  query    = build_query(inputs, {}) # TODO: Upload valid fields
  make_request(endpoint, query)
end

#substance_data_reports(search: [], sort: [], count: [], skip: 0, limit: 1) ⇒ Object

Returns Response from the API parsed as JSON.

Parameters:

• search (Array<Hash>) (defaults to: []) —

  Search fields defined in open.fda.gov/apis/other/substance/searchable-fields/

• sort (Array<Hash>) (defaults to: []) —

  Sort fields defined in open.fda.gov/apis/other/substance/searchable-fields/

• count (Array<Hash>) (defaults to: []) —

  Count fields defined open.fda.gov/apis/other/substance/searchable-fields/

• skip (Integer) (defaults to: 0) —

  Number of results to skip

• limit (Integer) (defaults to: 1) —

  Number of results to return

Returns:

• Response from the API parsed as JSON

# File 'lib/open_fda_api/other.rb', line 27

def substance_data_reports(search: [], sort: [], count: [], skip: 0, limit: 1)
  endpoint = "substance.json"
  inputs   = build_inputs(search: search, sort: sort, count: count, skip: skip, limit: limit)
  query    = build_query(inputs, {}) # TODO: Upload valid fields
  make_request(endpoint, query)
end