|
| 1 | +##Organization |
| 2 | +An organization is an Entity which contains a collection of projects called portfolio projects under it. |
| 3 | + |
| 4 | + |
| 5 | +### Properties |
| 6 | ++ __name__ Organization Name |
| 7 | ++ __url__ XML Api URL for the current organization. |
| 8 | ++ __html_url__ The URL for the current organization page on OpenHub. |
| 9 | ++ __created_at__ The time at which the organization was initially added to OpenHub. |
| 10 | ++ __updated_at__ The time of most recent modification to the organization record. |
| 11 | ++ __description__ The optional description of the current organization, currently limited to 800 characters. |
| 12 | ++ __homepage_url__ An optional URL for the home page of the organization, e.g Apache Software Foundation (www.apache.org) |
| 13 | ++ __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 |
| 14 | ++ __small_logo_url__ An url to the organization’s 32×32 pixels logo image. |
| 15 | ++ __medium_logo_url__ An url to the organization’s 64×64 pixels logo image. |
| 16 | ++ __projects_count__ The number of portfolio projects under the organization. |
| 17 | ++ __affiliated_committers__ The count of number of committers affiliated to the organization. |
| 18 | + |
| 19 | + |
| 20 | +### Collection URL |
| 21 | +```shell |
| 22 | +https://www.openhub.net/orgs.xml?api_key={api_key}&page={number}&sort={projects}&query={keyword} |
| 23 | +``` |
| 24 | + |
| 25 | +The organization collection request supports the standard [collection request parameters](/README.md#collection-requests), with the following details: |
| 26 | + |
| 27 | ++ __query__ If supplied, only organizations matching the query string will be returned. |
| 28 | + |
| 29 | + - An organization match occurs if its name, description, or any of its tags contain the query string. |
| 30 | + |
| 31 | ++ __sort__ Organization collection supports the following sort options : |
| 32 | + |
| 33 | + - __name__ Sort by organization name. |
| 34 | + - __projects_count__ Sort by number of portfolio projects in the organization. |
| 35 | + - __created_at__ Sort by the organization created date/time. |
| 36 | + - __updated_at__ Sort by organization record's last updated date/time. |
| 37 | + |
| 38 | ++ __page__ Results page for the organization collection xml api. |
| 39 | + |
| 40 | + - The first page of results are displayed when the API is queried without passing a 'page' parameter in the url. |
| 41 | + - Successive pages of results can be queried using ```page=1``` upto ```page=n``` |
| 42 | + |
| 43 | +#### Example |
| 44 | + |
| 45 | +```ruby |
| 46 | +https://www.openhub.net/orgs.xml?api_key=some_example_api_key&page=2&sort=projects_count&query=java |
| 47 | +``` |
0 commit comments