Class FitConnectClient

constructor

• new FitConnectClient(options?: FitConnectClientOptions): FitConnectClient

  Parameters

  • options: FitConnectClientOptions = {}

  Returns FitConnectClient

ReadonlyapiVersion

areas

• areas(params: AreaQuery): Promise<AreaResult>

  Search for areas by name and/or postal code. The search is turned into words by areaSearchWords: words shorter than 2 characters are left out, a repeated word is sent once, and a search the API would reject (no usable word, more than MAX_AREA_SEARCH_WORDS words, a misplaced *) throws a FitConnectValidationError before any request.

  Parameters

  • params: AreaQuery

  Returns Promise<AreaResult>

info

• info(): Promise<Info>

  Fetch the version of the deployed Routing API instance.

  Returns Promise<Info>

routes

• routes(params: RouteQuery): Promise<RouteResult>

  Resolve the responsible destination(s) (Zustellpunkte) for a public service in an area. Requires a leikaKey and exactly one of ags / ars / areaId.

  Parameters

  • params: RouteQuery

  Returns Promise<RouteResult>