Versions Compared

Key

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

...

C

Verb

URL

Description

Mandatory parameters

Optional parameters

Response Data

Formats

Response codes

PUT

/communities/{id}

Change description of id community

id

name
metadata
logo

Response code

json 
xml

200, 400, 401, 403, 500

POST

/communities

Add community to the system

name

logo 
parent 
other metadata

Id of newly created community

json 
xml

200, 400, 401, 403, 500


DELETE

/communities/{id}

Delete community from the system

id

-

Response code

json
xml

200, 400, 401, 403, 500


DELETE

/communities/{id}/administrators

Remove the administrators group from the community

id

-

Response code

json
xml

 


DELETE

/communities/{id}/collections/{cid}

Remove collection cid from community id

id

cid

Response code

 

 


DELETE

/communities/{id}/children/{cid}

Remove subcommunity cid from community id

id

cid

Response code

 

 


POST

/communities/{id}/administrators

Create a default administrators group if one does not already exists

id

-

Id of newly created group

 

 


POST

/communities/{id}/collections

Create a new collection within community id

id

-

Id of newly created collection

 

 


PUT

/communities/{id}/collections/{cid}

Add an existing collection cid to community id

id
cid

--

Response code

 

 


POST

/communities/{id}/children

Create a new subcommunity within community id

id

-

Id of newly created subcommunity

 

 


PUT

/communities/{id}/children/{cid}

Add an existing community cid as a subcommunity of community id

id
cid

-

Response code

 

 


PUT

/collections/{id}

Change description of id collection

id

 

Response code

json
xml

200, 400, 401, 403, 500


POST

/collections

Add collection to the system

name
communityId

 

Id of newly created collection

json
xml

200, 400, 401, 403, 500


DELETE

/collections/{id}

Delete collection from the system

-

-

Response code

json
xml

200, 400, 401, 403, 500

 

DELETE

{{/collections/{id}/items/{cid} }}

Delete item cid from collection id

id

cid

Response code

json
xml

 

 

PUT

/collections/{id}/logo

Set the logo for collection id

id

 

Response code

 

 

 

POST

/collections/{id}/administrators

Create a default administrators group if one does not already exists

id

-

Response code

 

 

 

DELETE

/collections/{id}/administrators

Remove the administrators group from the collection

id

-

 

 

 

 

POST

/collections/{id}/items

Add an item to the collection

id

itemId

Response code

 

 

 

PUT

/collections/{id}/metadata

Set metadata value

id

metadataField
metadataValue

Response code

 

 

 

PUT

/collections/{\id}/licence

Set collection licence

id

licence

Response code

 

 

 

 

 

 

 

 

 

 

 

Content searching

...