Function listReviewsForUserHandler

  • listReviewsForUserHandler(reviewService, logger, context): Promise<adapter.AdapterHandlerResponse>

  • List user reviews handler

    Parameters

    • reviewService: ReviewDataService

      injected service use to handle the review related operations

      • getReviews
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

      request context [headers, body, params, query].

    Returns Promise<adapter.AdapterHandlerResponse>

    200 Status OK

    Description

    This handler is used to get user reviews by applying the following steps in sequence:

    1. Get the orgId from params

    2. Parse paginated list query (util.parsePaginatedListQuery)

    3. Get reviews by paginated list options (reviewService.getReviews)

    Throws

    400 NBError Bad Request

    • orgId is missing in request params
    • pagination must be set
    • Page size exceeds 1000 mbs

    Throws

    500 NBError Internal Server Error

    • error when parse paginated list query

    Next Link

    next link

    Previous Link

    previous link

    • count
    • total
    • value

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc