Name and description | Value and notes |
---|
Base URI: | /communities?topLevelOnly=true&idOnly=false |
Description: | Returns a list of all communities on the system or return just top level communities. |
HTTP method: | GET |
Optional parameters: | topLevelOnly=true : returns only top level communities idOnly=false : if true return only the identifiers for the record, by default return the full record |
Sorting fields supported: | id, name, countitems : sorting by id, community name and item count |
Response formats: | json , xml |
Status codes | 200: OK 204: no content 400: bad request 500: internal server error |
Response details | By default contains item count, identifier, handle and name and other referencing data, or 204 if none. Additionaly, based on parameter idOnly=true the method returns only identifiers. |