get_subjects: Get subject id codes.

In KaniaKrzysztof/bdl: Interface and Tools for BDL API

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

 ## Not run: 
   subjects <- get_subjects()
   subjects <- get_subjects("K3")
   subjects <- get_subjects("G7")

## End(Not run)

KaniaKrzysztof/bdl documentation built on June 28, 2019, 8:09 p.m.