Function listOrganizationsHandler

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

  • Get organizations handler

    Parameters

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

      injected service use to handle the organization related operations

      • listPaginatedOrganizations
    • paginationConfiguration: PaginationConfigurations
    • 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 organizations by applying the following steps in sequence:

    1. Parse paginated list query

    2. Get organization list

    3. Normalize organization responses

    4. Return normalized organization responses

    Throws

    400 NBError Bad Request

    • error when parse paginated list query
    • pagination must be set
    • page size is too large, must less than ${MAXIMUM_PAGE_SIZE}

    Throws

    500 NBError Internal Server Error

    • error when getting organization list

Settings

Member Visibility

Theme

Generated using TypeDoc