Package org.bremersee.groupman.api
Interface GroupAdminControllerApi
- All Known Implementing Classes:
GroupAdminControllerMock
@Valid
public interface GroupAdminControllerApi
The group admin controller api.
- Author:
- Christian Bremer
-
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<Group>Add group.org.springframework.http.ResponseEntity<Group>findGroupById(String id) Find group by id.Gets groups.findGroupsByIds(List<String> id) Find groups by ids.org.springframework.http.ResponseEntity<Group>modifyGroup(String id, @Valid Group group) Modify group.org.springframework.http.ResponseEntity<Group>removeGroup(String id) Remove group.
-
Method Details
-
findGroups
@RequestMapping(value="/api/admin/groups", produces="application/json", method=GET) org.springframework.http.ResponseEntity<List<Group>> findGroups()Gets groups.- Returns:
- the groups
-
addGroup
@RequestMapping(value="/api/admin/groups", produces="application/json", consumes="application/json", method=POST) org.springframework.http.ResponseEntity<Group> addGroup(@Valid @RequestBody @Valid Group group) Add group.- Parameters:
group- the group- Returns:
- the response entity
-
findGroupById
@RequestMapping(value="/api/admin/groups/{id}", produces="application/json", method=GET) org.springframework.http.ResponseEntity<Group> findGroupById(@PathVariable("id") String id) Find group by id.- Parameters:
id- the id- Returns:
- the response entity
-
modifyGroup
@RequestMapping(value="/api/admin/groups/{id}", produces="application/json", consumes="application/json", method=PUT) org.springframework.http.ResponseEntity<Group> modifyGroup(@PathVariable("id") String id, @Valid @RequestBody @Valid Group group) Modify group.- Parameters:
id- the idgroup- the group- Returns:
- the response entity
-
removeGroup
@RequestMapping(value="/api/admin/groups/{id}", method=DELETE) org.springframework.http.ResponseEntity<Group> removeGroup(@PathVariable("id") String id) Remove group.- Parameters:
id- the id- Returns:
- the response entity
-
findGroupsByIds
@RequestMapping(value="/api/admin/groups/f", produces="application/json", method=GET) org.springframework.http.ResponseEntity<List<Group>> findGroupsByIds(@RequestParam(value="id",required=false) List<String> id) Find groups by ids.- Parameters:
id- the list of ids- Returns:
- the response entity
-