README.md in oneaccess-0.1.0 vs README.md in oneaccess-0.1.1

- old
+ new

@@ -36,10 +36,11 @@ - User by Email: _/user/getByEmail_ - Research Document: _/research/document_ - Research Document by User ID: _/research/documentByUserId_ - Organization's Product Groups: _/entitlement/organization/productgroup/getList_ +- Organization: _/organizations/id_ - User's Product Groups: _/entitlement/user/productgroup/getList_ ### User by Email _(/user/getByEmail)_ Official Documentation: http://apidocs.oneaccess.io/docs/usergetorcreate @@ -101,5 +102,23 @@ puts "Not entitled or does not exist" end end ``` +### Get Organization by ID _(/organizations/id)_ +Official Documentation: http://apidocs.oneaccess.io/docs/organization-2 + +This method returns an Organization by providing the Organization ID. + +#### How to use: +```ruby +resp = ONEAccess::API::Organizations.get_organization(id: 123) + +resp.data #=> instance of ONEAcess::DataObject::Organization +resp.data.id #=> id of the Organization +resp.data.name #=> name of the Organization +resp.data.short_name #=> Short Name of the Organization +resp.data.active #=> Boolean meaning if the Organization is Active or not +resp.data.type #=> type of the Organization (Unspecified = 0, Buyside = 1, Sellside = 2, Advisory = 3, Other = 4, Vendor = 5, Internal = 6) +resp.data.main_address #=> instance of ONEAccess::DataObject::Address +resp.data.addresses #=> Array of instances of ONEAccess::DataObject::Address +```