Function getLocationTreeHandler

  • getLocationTreeHandler(locationService, paginationConfiguration, logger, context): Promise<adapter.AdapterHandlerResponse>

  • Get location tree handler

    Parameters

    • locationService: Pick<LocationDataService, "getLocationTree" | "normalizeLocationTreeResponses">

      injected service use to handle the location related operations

      • getLocationTree
      • normalizeLocationTreeResponses
    • paginationConfiguration: PaginationConfigurations
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

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

    Returns Promise<adapter.AdapterHandlerResponse>

    200 Status Ok

    • data: location tree

    Description

    This handler is used to get a tree of locations by applying the following steps in sequence:

    1. Parse the query to get the pagination options (util.parsePaginatedListQuery)

    2. Check if the pagination options are valid

    3. Get the location tree (locationService.getLocationTree)

    4. Normalize the location tree response (locationService.normalizeLocationTreeResponse)

    5. Return the normalize location tree response

    Throws

    Error

    • query is not exist

    Throws

    400 NBError Bad Request

    • error when parse paginated list query, ${error.message}
    • pagination must be set
    • Page size exceeds ${MAXIMUM_PAGE_SIZE} mbs

    Throws

    500 NBError Internal Server Error

    • Error happen when get location tree from database

Settings

Member Visibility

Theme

Generated using TypeDoc