Function getOrganizationHandler

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

  • Get one organization handler

    Parameters

    • service: Pick<OrganizationDataService, "getOrganization" | "expandOrganizations" | "normalizeOrganizationResponse">

      injected service use to handle the organization related operations

      • getOrganization
    • 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 response

    Description

    This handler will get one organization by applying the following steps in sequence:

    1. Read organization

    2. Normalize organization response

    Throws

    Error

    • params is missing from context

    Throws

    404 NBError Not Found

    • organization with id ${params?.orgId} not found in the system

    Throws

    500 NBError Internal Server Error

    • error when reading organization

Settings

Member Visibility

Theme

Generated using TypeDoc