Edition endpoints: searchPeopleBy
This is similar to #46 (closed) and #47 (closed), but it should search people only in a particular course edition.
I thought this could go into edition endpoints, but I think it's also perfectly fine if it ends up going in PersonController.
Endpoint (Method): searchPeopleByEditionAndUsernameContaining
| Params | Type | Comment |
|---|---|---|
| Input | String | username |
| Long | editionId | |
| Output | List<PersonViewDTO> |
people |
What does this method do?
- Looking at what you guys did for the previous issues, I guess you'd do
findAllByUsernameContainingAndEditionsContaining.
Endpoint (Method): searchPeopleByEditionAndDisplayNameContaining
| Params | Type | Comment |
|---|---|---|
| Input | String | displayName |
| Long | editionId | |
| Output | List<PersonViewDTO> |
people |
What does this method do?
- Looking at what you guys did for the previous issues, I guess you'd do
findAllByDisplayNameContainingAndEditionsContaining.
Endpoint (Method): searchPeopleByEditionAndNumberContaining
| Params | Type | Comment |
|---|---|---|
| Input | Integer | number |
| Long | editionId | |
| Output | List<PersonViewDTO> |
people |
What does this method do?
- Looking at what you guys did for the previous issues, I guess you'd do
findAllByNumberStartingWithAndEditionsContaining.
Endpoint (Method): searchPeopleByEditionAndRole
| Params | Type | Comment |
|---|---|---|
| Input | RoleType | role |
| Long | editionId | |
| Output | List<PersonViewDTO> |
people |
What does this method do?
- This should filter out people that have one particular role in a course edition. Is it possible to somehow get all roles in course edition (this already exists in
EditionControllerasgetEditionParticipants), then filter out one RoleType?