Class DestatisClient

constructor

• new DestatisClient(options?: DestatisClientOptions): DestatisClient

  Parameters

  • options: DestatisClientOptions = {}

  Returns DestatisClient

Readonlycatalogue

Readonlydata

Readonlymetadata

find

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

  find/find — full-text search across object types. term must be non-blank; 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 — reject with a DestatisApiError whose isAuthError (and loginRejected) is true; an answer that is neither an explicit success nor an explicit failure rejects with DestatisParseError. Rejects with DestatisValidationError for a guest client (there is nothing to check).

  Parameters

  • Optionallanguage: "de" | "en"

  Returns Promise<LoginCheckResponse>

whoami

• whoami(): Promise<WhoamiResponse>

  helloworld/whoami — connectivity check; unauthenticated GET.

  Returns Promise<WhoamiResponse>