Skip to contents

Report available member roles

Source: R/membership.R
member_roles_list.Rd

Report available member roles

Usage

member_roles_list(
  group_type = "organization",
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

group_type

(character) Either "group" or "organization".

url

Base URL to use. Default: https://demo.ckan.org/. See also ckanr_setup and get_default_url.

key

A privileged CKAN API key. Default: your key set with ckanr_setup

as

(character) One of list (default), table, or json. Parsing with the table option uses jsonlite::fromJSON(..., simplifyDataFrame = TRUE), which attempts to parse data to data.frame's when possible. The result can vary from a vector, list or data.frame. (required)

...

Extra curl arguments. The function passes them to verb-POST (optional)

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

if (FALSE) { # \dontrun{
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
member_roles_list(group_type = "organization")
} # }