Page History

...

Verb	URL	Description	Mandatory parameters	Optional parameters	Sorting fields	Response Data	Response codes
`GET`	`/communities`this	is Returns a description of what is happening in this current field eg it describes method etclist of all communities on the system or return just top level communities.	-	`topLevelOnly=true` `idOnly=false`	`id` `name` `countitems`	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 identifiersContains...	200, 400, 500

Parameter

Description

Anchor

	toplevelonly
	toplevelonly

...

topLevelOnly

returns only top level communities

Anchor

	idonly
	idonly

idOnly

if true return only the identifiers for the record

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.

...

Page tree