Delete reader group
- 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
Delete reader group
- Updated on 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
DELETE /readers/groups/{groupId}
Deletes the reader group with the given ID
Body Parameters > access_scope
| Parameter | Required | Type | Description |
|---|---|---|---|
| access_level | Yes | number | The access level for the reader. 0-None, 1-Category, 2-Version, 3-Project, 4-Language |
| categories | Conditionally | object[] | List of category scope objects. The field is required when access_level is set to 1-Category |
| project_versions | Conditionally | string[] | List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version. |
| languages | Conditionally | object[] | List of language scope objects. The field is required when access_level is set to 4-Language. |
Body Parameters > access_scope > categories
| Parameter | Required | Type | Description |
|---|---|---|---|
| category_id | Yes | string | The category id to which the user should be given access. |
| project_version_id | Yes | string | The project version id to which the category belongs. |
| language_code | Yes | string | The language to which the user should be given access. |
Body Parameters > access_scope > languages
| Parameter | Required | Type | Description |
|---|---|---|---|
| project_version_id | Yes | string | The project version id to which the user should be given access. |
| language_code | Yes | string | The language to which the user should be given access. |
Route Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| groupId | Yes | string | The ID of the reader to delete |
Sample Response
If 'success' returns true status, then it indicates that the record has been deleted.
{
"extension_data": null,
"context": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}
Was this article helpful?