Class RegionalstatistikClient

constructor

• new RegionalstatistikClient(
      options?: RegionalstatistikClientOptions,
  ): RegionalstatistikClient

  Parameters

  • options: RegionalstatistikClientOptions = {}

  Returns RegionalstatistikClient

Readonlycatalogue

Readonlydata

Readonlymetadata

find

• find(params: FindParams, options?: ParamOptions): Promise<FindResponse>

  find/find — full-text search across object types. term must be non-blank; needs an account (rejects with RegionalstatistikValidationError without one). Only the FindParams keys are accepted unless options.allowUnknownParams (P10).

  Parameters

  • params: FindParams
  • options: ParamOptions = {}

  Returns Promise<FindResponse>

logincheck

• logincheck(language?: "de" | "en"): Promise<LoginCheckResponse>

  helloworld/logincheck — validate the supplied credentials. Resolves only when GENESIS confirms the login. Wrong credentials — which GENESIS answers with HTTP 200 and an error text in Status (or the token echoed as Username) — reject with a RegionalstatistikApiError whose isAuthError (and loginRejected) is true; an answer that confirms nothing rejects with RegionalstatistikParseError. Without credentials GENESIS answers as the guest user ("Username": "GAST"), which resolves: this does not demand credentials.

  Parameters

  • Optionallanguage: "de" | "en"

  Returns Promise<LoginCheckResponse>

whoami

• whoami(): Promise<WhoamiResponse>

  helloworld/whoami — connectivity check; unauthenticated GET.

  Returns Promise<WhoamiResponse>