Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.38 KB

organization-collection.md

File metadata and controls

48 lines (35 loc) · 2.38 KB
Raw

##Organization An organization is an entity which contains a collection of projects and accounts.

Properties

  • name Organization Name
  • url XML Api URL for the current organization.
  • html_url The URL for the current organization page on OpenHub.
  • created_at The time at which the organization was initially added to OpenHub.
  • updated_at The time of most recent modification to the organization record.
  • description The optional description of the current organization, currently limited to 800 characters.
  • homepage_url An optional URL for the home page of the organization, e.g Apache Software Foundation (www.apache.org)
  • url_name A short, unique, handle for the current organization. e.g for url_name as 'apache' the equivalent web link is www.openhub.net/orgs/apache
  • small_logo_url An url to the organization’s 32×32 pixels logo image.
  • medium_logo_url An url to the organization’s 64×64 pixels logo image.
  • type The type of the organizations(Non-profit/commercial/Government/Educational).
  • projects_count The number of portfolio projects under the organization.
  • affiliated_committers The count of number of committers affiliated to the organization.

Collection URL

https://www.openhub.net/orgs.xml?api_key={api_key}&page={number}&sort={projects}&query={keyword}

The organization collection request supports the standard collection request parameters, with the following details:

  • query If supplied, only organizations matching the query string will be returned.

    • An organization match occurs if its name, description, or any of its tags contain the query string.

  • sort Organization collection supports the following sort options :

    • name Sort by organization name.
    • projects_count Sort by number of portfolio projects in the organization.
    • created_at Sort by the organization created date/time.
    • updated_at Sort by organization record's last updated date/time.

  • page Results page for the organization collection xml api.

    • The first page of results are displayed when the API is queried without passing a 'page' parameter in the url.
    • Successive pages of results can be queried using page=1 upto page=n

Example

https://www.openhub.net/orgs.xml?api_key=some_example_api_key&page=2&sort=projects_count&query=java