get_subjects {bdl}R Documentation

Get subject id codes.

Description

Retrieve all subjects id's or sub-subjects.

Usage

get_subjects(
  parentId = "",
  sort = c("id", "-id", "name", "-name"),
  lang = c("pl", "en"),
  ...
)

Arguments

parentId

A parent subject id code. If not specified returns all top level subjects. Use search_subjects to find subject codes.

sort

A type of sorting, "id" (default), "-id", "name", "-name"

lang

A language of returned data, "pl" (default), "en"

...

Other arguments passed on to GET. For example a proxy parameters, see details.

Details

To get all top level subjects skip the parentId parameter or list sub-subjects for given parent subject.

To use a proxy to connect, a use_proxy can be passed to GET. For example get_request(id, filters, config = httr::use_proxy(url, port, username, password)).

Value

A dataset as a tibble.

Examples

   # get_subjects()
   # get_subjects("K3")
   # get_subjects("G7")

[Package bdl version 1.0.3 Index]