Package com.dzidzi.api

Interface ServiceResponseApi

public interface ServiceResponseApi
ServiceResponseApi contains all the api operations handling ServiceResponse in the DzidziApp.

  • Method Details

    • getResponseById

      ServiceResponse getResponseById(UUID responseId)
      Finds a service response by id.
      Parameters:
      responseId - the response id
      Returns:
      the service response found
      Throws:
      com.dzidzi.exception.EntityNotFoundException - when the service response is not found

    • createResponse

      ServiceResponse createResponse(AddServiceResponseRequest addServiceResponseRequest)
      Adds/create a new response by the logged in customer service user.
      Parameters:
      addServiceResponseRequest - the AddServiceResponseRequest containing the properties to create/add a new response
      Returns:
      the response created/added

    • findServiceResponses

      DzidziPaginationDTO<ServiceResponse> findServiceResponses(FindResponseRequest findResponseRequest)
      Finds the paginated responses based on the request.
      Parameters:
      findResponseRequest - the request containing the params to filter responses on
      Returns:
      the DzidziPaginationDTO

    • removeResponse

      void removeResponse(UUID responseId)
      Deletes a response by the given id.
      Parameters:
      responseId - the response id