Versions Compared

Old Version 24

changes.mady.by.user Bojan Suzic

Saved on

compared with

New Version 25

changes.mady.by.user Bojan Suzic

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • introduction of new method
  • extending of existing method, by implementing new functionality (e.g. GET/PUT/DELETE)
  • extending of existing method, by changing its parameters, output etc
    Note
    titleNaming convention for endpoints

    DSpace 1.x and 2.x are treating the resources on different way. 2.x is more generalized, suggesting the use of RDF-like interrelation notations. The necessity to follow this approach for 1.x is to be discussed in the list or on the following page.


Repository browsing


Verb

URL

Description

Mandatory parameters

Optional parameters

Sorting fields

Response Data

Response codes

GET

/communities

this is a description of what is happening in this current field eg it describes method etc

-

#toplevelonlytopLevelOnly=true
idOnly=false

id
name
countitems

Contains...

200, 400, 500

Anchor
toplevelonly
toplevelonly

This is explaining top level


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.

...