Class HelpRequestController
java.lang.Object
edu.ucsb.cs156.example.controllers.ApiController
edu.ucsb.cs156.example.controllers.HelpRequestController
@RequestMapping("/api/helprequests")
@RestController
public class HelpRequestController
extends ApiController
This is a REST controller for HelpRequests.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionList all help requests.Delete a single help request.Get a single help request by ID.postHelpRequest(String requesterEmail, String teamId, String tableOrBreakoutRoom, LocalDateTime requestTime, String explanation, boolean solved) Create a new help request.updateHelpRequest(Long id, @Valid HelpRequest incoming) Update a single help request.Methods inherited from class ApiController
genericMessage, getCurrentUser, handleGenericException
-
Constructor Details
-
HelpRequestController
public HelpRequestController()
-
-
Method Details
-
allHelpRequests
@PreAuthorize("hasRole('ROLE_USER')") @GetMapping("/all") public Iterable<HelpRequest> allHelpRequests()List all help requests.- Returns:
- an iterable of HelpRequest objects
-
getHelpRequestById
@PreAuthorize("hasRole('ROLE_USER')") @GetMapping("") public HelpRequest getHelpRequestById(@RequestParam Long id) Get a single help request by ID.- Parameters:
id- the ID of the help request- Returns:
- the matching HelpRequest
-
deleteHelpRequest
-
updateHelpRequest
@PreAuthorize("hasRole('ROLE_ADMIN')") @PutMapping("") public HelpRequest updateHelpRequest(@RequestParam Long id, @RequestBody @Valid @Valid HelpRequest incoming) Update a single help request.- Parameters:
id- the ID of the help request to updateincoming- the updated help request values- Returns:
- the updated HelpRequest
-
postHelpRequest
@PreAuthorize("hasRole('ROLE_ADMIN')") @PostMapping("/post") public HelpRequest postHelpRequest(@RequestParam String requesterEmail, @RequestParam String teamId, @RequestParam String tableOrBreakoutRoom, @RequestParam("requestTime") @DateTimeFormat(iso=DATE_TIME) LocalDateTime requestTime, @RequestParam String explanation, @RequestParam boolean solved) Create a new help request.- Parameters:
requesterEmail- email address of the person requesting helpteamId- team identifiertableOrBreakoutRoom- table or breakout room numberrequestTime- time when help was requestedexplanation- explanation of the help neededsolved- whether the request has been solved- Returns:
- the saved HelpRequest
-