databraryr (version 0.6.6)

get_party_by_id: Download Information About a Party on Databrary as JSON

Description

Download Information About a Party on Databrary as JSON

Usage

get_party_by_id(
  party_id = 6,
  parents_children_access = TRUE,
  vb = options::opt("vb"),
  rq = NULL
)

Value

A nested list with information about the party. This can be readily parsed by other functions.

Arguments

party_id

An integer. The party number to retrieve information about.

parents_children_access

A logical value. If TRUE (the default), returns all of the data about the party. If FALSE, only a minimum amount of information about the party is returned.

vb

Show verbose messages. (Defaults to FALSE, overwritable using option 'databraryr.vb' or environment variable 'R_DATABRARYR_VB')

rq

An httr2-style request object. If NULL, then a new request will be generated using make_default_request().

Examples

# \donttest{
if (FALSE) {
get_party_by_id()
}
# }