Function listOrganizationsForUserHandler

  • listOrganizationsForUserHandler(paginationConfiguration, service, logger, context): Promise<adapter.AdapterHandlerResponse>

  • Get user organizations handler

    Parameters

    • paginationConfiguration: PaginationConfigurations

      pagination configurations

    • service: Pick<OrganizationDataService, "listPaginatedOrganizationsForUser" | "expandOrganizations" | "normalizeOrganizationResponses">

      injected service use to handle the organization related operations

      • getPagedUserOrganizations
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

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

      • params is required

    Returns Promise<adapter.AdapterHandlerResponse>

    200 OK

    • data: normalized organization responses with pagination

    Description

    This handler will get user organizations by applying the following steps in sequence:

    1. Get user id from params

    2. Get roles from query

    3. Parse paginated list query (util.parsePaginatedListQuery)

    4. Get user organizations (service.getPagedUserOrganizations)

    5. Normalize organization responses (normalizeOrganizationResponses)

    6. Return normalized organization responses

    Throws

    Error

    • params is missing from context

    Throws

    400 NBError Bad Request

    • roles must be string
    • error when parse paginated list query
    • pagination must be set
    • Page size exceeds ${pageConfigs.maxPageSize} limit

    Throws

    500 NBError Internal Server Error

    • error when reading user organizations

Settings

Member Visibility

Theme

Generated using TypeDoc