Module: Ohanakapa::Client::Organizations

Included in:

Ohanakapa::Client

Defined in:

lib/ohanakapa/client/organizations.rb

Overview

Methods for the Organizations API

See Also:

• http://ohanapi.herokuapp.com/api/docs

Instance Method Summary

• #organization(id) ⇒ Sawyer::Resource (also: #org)

  Get a single organization based on its ID.

• #organizations ⇒ Array<Sawyer::Resource> (also: #orgs)

  List all organizations.

Instance Method Details

#organization(id) ⇒ Sawyer::Resource Also known as: org

Get a single organization based on its ID

Examples:

Ohanakapa.organization('519c44065634241897000023')

Ohanakapa.org('519c44065634241897000023')

See Also:

• http://ohanapi.herokuapp.com/api/docs#!/api/GET-api-organizations--id---format-_get_1

# File 'lib/ohanakapa/client/organizations.rb', line 36

def organization(id)
  get("organizations/#{id}")
end

#organizations ⇒ Array<Sawyer::Resource> Also known as: orgs

List all organizations

This provides a dump of every organization, in the order that they were uploaded to the Ohana DB.

Examples:

Ohanakapa.organizations

Ohanakapa.orgs

See Also:

• http://ohanapi.herokuapp.com/api/docs#!/api/GET-api-organizations---format-_get_0

# File 'lib/ohanakapa/client/organizations.rb', line 22

def organizations
  get "organizations"
end