Skip to contents

Build a RIS Bundesrecht API Request

Source: R/ris_req_federal.R
ris_req_federal.Rd

Construct an httr2_request object for the Austrian RIS OGD REST API v2.6 /Bundesrecht endpoint, application BrKons (consolidated federal law). The request is not executed; call ris_perform_federal() to send it and parse the results, or use httr2::req_dry_run() to inspect the URL.

Usage

ris_req_federal(
  query = NULL,
  title = NULL,
  index = NULL,
  type = NULL,
  law_number = NULL,
  promulgation_organ = NULL,
  promulgation_number = NULL,
  signature_date = NULL,
  version_date = NULL,
  effective_from = NULL,
  effective_to = NULL,
  expiry_from = NULL,
  expiry_to = NULL,
  section_from = NULL,
  section_to = NULL,
  section_type = NULL,
  in_ris_since = NULL,
  sort_by = NULL,
  sort_direction = NULL,
  base_url = ris_base_url()
)

Arguments

query

Optional full-text query (Suchworte). Supports the RIS full-text operators (space/und = AND, OR/ODER = OR, nicht = NOT, * = wildcard, 'phrase' for exact phrase).

title

Optional title or abbreviation of the legal norm (Titel).

index

Optional index reference from the systematic directory of federal law (Index, e.g. "20/01").

type

Optional norm type (Typ).

law_number

Optional law number (Gesetzesnummer), an exact-match identifier for the consolidated norm.

promulgation_organ

Optional promulgation organ (Kundmachungsorgan), e.g. "BGBl. I Nr.", "BGBl. II Nr.", "RGBl. Nr.".

promulgation_number

Optional promulgation number (Kundmachungsorgannummer, e.g. "25/2012").

signature_date

Optional signature date (Unterzeichnungsdatum, YYYY-MM-DD).

version_date

Optional point-in-time version date (Fassung.FassungVom, YYYY-MM-DD): retrieve the consolidated text as it stood on this date. Cannot be combined with the effective_* / expiry_* range arguments.

effective_from, effective_to

Optional entry-into-force date range (Fassung.VonInkrafttretensdatum / Fassung.BisInkrafttretensdatum, YYYY-MM-DD).

expiry_from, expiry_to

Optional expiry (out-of-force) date range (Fassung.VonAusserkrafttretensdatum / Fassung.BisAusserkrafttretensdatum, YYYY-MM-DD).

section_from, section_to

Optional section (article/paragraph/annex) range to narrow within a norm (Abschnitt.Von / Abschnitt.Bis).

section_type

Optional section type (Abschnitt.Typ). One of "Alle", "Artikel", "Paragraph", "Anlage" (English aliases "all", "article", "paragraph", "annex"). Required by the API when a section range is given; defaults to "Alle" in that case.

in_ris_since

Optional RIS recency filter (ImRisSeit). Accepts API values ("Undefined", "EinerWoche", "ZweiWochen", "EinemMonat", "DreiMonaten", "SechsMonaten", "EinemJahr") and English aliases ("one_week", "two_weeks", "one_month", "three_months", "six_months", "one_year").

sort_by

Optional sort column (Sortierung.SortedByColumn). One of "ArtikelParagraphAnlage", "Kurzinformation", "Inkrafttretensdatum", "Ausserkrafttretensdatum".

sort_direction

Optional sort direction (Sortierung.SortDirection): "Ascending" or "Descending".

base_url

API base URL. Defaults to ris_base_url(), which can be overridden for a session via options(risAT.base_url = ...).

Value

An httr2_request object with an additional "ris_meta" attribute containing the application code, page size, endpoint, and website URLs. Pass this to ris_perform_federal() to execute the search.

Examples

if (FALSE) { # interactive()
# Build request, then inspect the URL without hitting the network
req <- ris_req_federal(title = "ABGB")
httr2::req_dry_run(req)

# The consolidated text as it stood on a given date
req <- ris_req_federal(title = "MRG", version_date = "2020-01-01")

# Execute
results <- ris_perform_federal(req)
}