POST groups
Creates a new group.
Resource URL
https://www.drillster.com/api/2.1/groups
Parameters
Field | Type | Description |
---|---|---|
name required |
String | The name of the new group. |
description required |
String | A description of the new group. |
catalogRestriction optional |
String | The ID of a catalog to restrict this group to. A restricted group only allows content from this catalog, and users having access to this catalog. |
catalogRestrictionMode optional |
String | If a catalogRestriction is specified, the mode determines the requirement for users to join the group. Two modes exist:
GRANT mode can only be used if the owner of the catalog has granted explicit permission to the organization of this group to use this mode. |
Response
A 2.1 Group object including the newly assigned group ID.
Error responses
The following error situations are possible:
ID | Response code | Description |
---|---|---|
name_missing |
400 (Bad request) | No group name specified |
description_missing |
400 (Bad request) | No group description specified |
invalid_catalog_restriction_mode |
400 (Bad request) | Catalog restriction mode is not valid |
no_permission |
403 (Forbidden) | Caller is not allowed to create groups, no access to the provided restriction catalog, or the catalog restriction mode can not be used for this catalog. |