Delete a small group
Deletes a small group object if a valid identifier was provided.
Permission requirements
The user must have Permissions.SmallGroups.Delete
("Delete small groups") on the linked small group set. By default, roles that have this permission are:
- Module Manager
- Departmental Administrator
- User Access Manager
Information about API permissions
Definition
DELETE https://tabula.warwick.ac.uk/api/v1/module/:moduleCode/groups/:smallGroupSetId/groups/:smallGroupId
URL substitution variables
:moduleCode |
The lowercase form of the module code for the module containing the linked small group set, e.g. ch225 |
---|---|
:smallGroupSetId |
The unique identifier for the linked small group set |
:smallGroupId |
The unique identifier for the small group |
Example request
DELETE https://tabula.warwick.ac.uk/api/v1/module/cs118/groups/2552f556-6110-4de7-bb8e-01a3180f612e/groups/2552f534-6230-4de7-aa21-01a3180f512e
Response parameters
An unsuccessful response will be returned in the standard format. A successful response will return the HTTP code 200 OK
and the following parameters:
success |
Boolean true |
---|---|
status |
The string "ok" |
Example response
{
"success": true,
"status": "ok"
}
Tabula API Methods
- Overview
- The Member object
- The StudentCourseDetails object
- The StudentCourseYearDetails object
- The StudentRelationship object
- The Student RelationshipType object
- The ModuleRegistration object
- Retrieve a member
- Retrieve multiple members
- Retrieve a member's relationships
- List relationship agents in dept.
- Search for members