Retrieve Bewerberboerse candidate details

Usage

bewerberboerse_details(referenznummer, flatten = FALSE, flatten_mode = "json")

Arguments

referenznummer

Bewerber referenznummer.

flatten

Logical; if TRUE, simplify nested list columns according to flatten_mode. Default FALSE keeps list columns as-is.

flatten_mode

How to handle list columns when flatten = TRUE:

"drop": Remove list columns entirely. Use when nested data is not needed.
"json": Convert each list element to a JSON string. Preserves all data in a text-queryable format. This is the default.
"unnest": Expand list columns into multiple rows via tidyr::unnest_longer(). Warning: this can significantly increase the number of rows.

Value

A tibble with the same columns as bewerberboerse_search(), filtered to the requested referenznummer.

refnr: Candidate reference number (character).
verfuegbarkeit_von: Availability date text (character).
aktualisierungsdatum: Last update date text (character).
veroeffentlichungsdatum: Publication date text (character).
stellenart: Position type (character).
arbeitszeit_modelle: Work-time models, collapsed string (character).
berufe: Occupations, collapsed string (character).
letzte_taetigkeit_jahr: Year of most recent activity (character).
letzte_taetigkeit_bezeichnung: Label of most recent activity (character).
letzte_taetigkeit_aktuell: Whether latest activity is current (logical).
hat_email: Email contact available (logical).
hat_telefon: Phone contact available (logical).
hat_adresse: Postal address available (logical).
ort: City/locality (character).
plz: Postal code (character).
umkreis: Radius text returned by API (character).
region: Region/state (character).
land: Country (character).
mehrere_arbeitsorte: Multiple work locations flag (logical).
ausbildungen: Education entries (list-column).
erfahrung: Experience entries (list-column).
operation_id: Operation identifier (character).
page: Returned page index (integer).
size: Returned page size (integer).
max_ergebnisse: Total matching result count (integer).

Details

Fetches details for a single candidate. The referenznummer typically comes from bewerberboerse_search(). See https://bundesapi.github.io/bewerberboerse-api/.

Examples

if (FALSE) { # \dontrun{
Sys.setenv(BEWERBERBOERSE_API_KEY = "jobboerse-bewerbersuche-ui")
bunddev_auth_set("bewerberboerse", type = "api_key", env_var = "BEWERBERBOERSE_API_KEY")
bewerberboerse_details("12345", flatten = TRUE)
} # }