Groups
The Groups
controller provides the following endpoints:
/api/v2/Groups/GetAll
/api/v2/Groups/Get/{id}
/api/v2/Groups/GetByName?name={name}
/api/v2/Groups/Faculties/GetAll
/api/v2/Groups/Faculties/Get/{id}
/api/v2/Groups/Faculties/GetByName?name={name}
GetAll
Gets all groups. Returns a list of Group
objects.
Group object:
{
"id": integer,
"name": "string",
"direction": {
"id": integer,
"shortName": "string",
"fullName": "string"
},
"faculty": {
"id": integer,
"shortName": "string",
"fullName": "string"
}
}
Call example:
Get/{id}
Gets a group by its ID. Returns a Group
object.
Parameters:
Name | Type | Description |
---|---|---|
id | integer | Group ID |
Call example:
GetByName
Gets the group by its name. Returns a list of Group
objects whose names contain the specified name.
Parameters:
Name | Type | Description |
---|---|---|
name | string | Group name. |
Call example:
Faculties/GetAll
Gets all faculties. Returns a list of GroupsFaculty
objects.
GroupsFaculty object:
{
"id": integer,
"shortName": "string",
"fullName": "string",
"directions": [
{
"id": integer,
"shortName": "string",
"fullName": "string",
"groups": [
{
"id": integer,
"name": "string"
}
]
}
]
}
Call example:
Faculties/Get/{id}
Gets the faculty by its ID. Returns a GroupsFaculty
object.
Parameters:
Name | Type | Description |
---|---|---|
id | integer | Group faculty ID |
Call example:
Faculties/GetByName
Gets the faculty by its name. Returns a list of GroupsFaculty
objects whose names contain the specified name.
Parameters:
Name | Type | Description |
---|---|---|
name | string | Group faculty name. |
Call example: