Clone wiki

BibSonomy / documentation / api / methods / CreateGroup

Create group

Method	POST
URL	https://www.bibsonomy.org/api/groups

Hint: you can't change the group's name once its created.

Status codes

201 created
400 bad request
401 Unauthorized
403 Forbidden
500 Internal Server Error

Example

Request:

curl -XPOST --user username:apikey "https://www.bibsonomy.org/api/groups"  --header "Content-Type:application/xml" -d \
'<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibsonomy>
  <group name="newGroup" description="This is a very special new group"/>
</bibsonomy>'

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<bibsonomy stat="ok">
    <groupid>newGroup</groupid>
</bibsonomy>

XML Schema

<!--
  a group
-->
<xsd:complexType name="GroupType">
  <xsd:attribute name="name" type="xsd:string" use="required"/>
  <xsd:attribute name="description" type="xsd:string"/>
</xsd:complexType>

Updated 2020-08-09