Package com.finconsgroup.itserr.marketplace.usercommunication.dm.api

Interface UserApi

All Known Implementing Classes:
UserController
public interface UserApi
REST API contract for user endpoints related to listing, searching, and maintaining users. Implemented by UserController. These mappings are used to generate OpenAPI and JavaDoc docs.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.springframework.http.ResponseEntity<List<User>>
    getOnlineUsers()
    Retrieve all users currently marked online.
    org.springframework.http.ResponseEntity<List<User>>
    getRecentlyActiveUsers()
    Retrieve users that are online or have been active within the last hour.
    org.springframework.http.ResponseEntity<User>
    getUserById(UUID userId)
    Retrieve a user by their business userId.
    org.springframework.http.ResponseEntity<String>
    updateUserStatus(boolean online)
    Update the online status flag for a user.

  • Method Details

    • getOnlineUsers

      @GetMapping(value="/user-communication/users/online", produces="application/json") org.springframework.http.ResponseEntity<List<User>> getOnlineUsers()
      Retrieve all users currently marked online.
      Returns:
      HTTP 200 with the list of online users; 500 on server errors

    • getRecentlyActiveUsers

      @GetMapping(value="/user-communication/users/recent", produces="application/json") org.springframework.http.ResponseEntity<List<User>> getRecentlyActiveUsers()
      Retrieve users that are online or have been active within the last hour.
      Returns:
      HTTP 200 with the list of recently active users; 500 on server errors

    • getUserById

      @GetMapping(value="/user-communication/users/{userId}", produces="application/json") org.springframework.http.ResponseEntity<User> getUserById(@PathVariable UUID userId)
      Retrieve a user by their business userId.
      Parameters:
      userId - the business user identifier
      Returns:
      HTTP 200 with user if found; 404 if not; 500 on server errors

    • updateUserStatus

      @PutMapping(value="/user-communication/users/status", produces="text/plain") org.springframework.http.ResponseEntity<String> updateUserStatus(@RequestParam boolean online)
      Update the online status flag for a user.
      Parameters:
      online - new online flag value
      Returns:
      HTTP 200 on success; 500 on server errors