Function isOrganizationExist

  • isOrganizationExist(targetField, organizationAPI, logger, context): Promise<number>

  • Is organization exist validator

    Parameters

    • targetField: TargetField

      which field to get the organization id from

    • organizationAPI: Pick<OrganizationDefaultAdapterAPI, "getOrganizationById">

      injected API use to handle the organization related operations

      • getOrganizationById
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

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

    Returns Promise<number>

    200 Status OK

    Description

    This validator checks if the organization exists by applying the following steps in sequence:

    1. Get organization by id (organizationAPI.getOrganizationById)

    2. Check if the organization exists

    Throws

    404 NBError Not Found

    • organization not found

Settings

Member Visibility

Theme

Generated using TypeDoc