Function listRailAreasHandler

  • listRailAreasHandler(railAreaService, paginationConfiguration, logger, context): Promise<adapter.AdapterHandlerResponse>

  • Get rail area list handler

    Parameters

    • railAreaService: Pick<RailAreaDataService, "listPaginatedRailAreas" | "expandRailAreas" | "normalizeRailAreaResponses">

      injected service use to handle the rail related operations

    • paginationConfiguration: PaginationConfigurations

      injected configurations

      • defaultPageSize
      • defaultOffset
      • maxPageSize
    • 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: rail area list

    Description

    This handler is used to get a list of rail area 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 rail area list (railService.listPaginatedRailAreas)

    4. Return the rail area list

    Throws

    400 NBError Bad Request

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

    Throws

    500 NBError Internal Server Error

    • error getting rail area list

Settings

Member Visibility

Theme

Generated using TypeDoc