Function listReviewsForOrganizationHandler

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

  • List organization 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].

      • params.orgId is required

    Returns Promise<adapter.AdapterHandlerResponse>

    200 Status OK

    Description

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

    1. Get the orgId from params

    2. Get the reviews where targetId is orgId (reviewService.getReviews)

    Throws

    400 NBError Bad Request

    • orgId is missing in request params
    • error when parse paginated list query
    • pagination must be set
    • Page size exceeds ${MAXIMUM_PAGE_SIZE} mbs

Settings

Member Visibility

Theme

Generated using TypeDoc