list_db_entry: List DB entry

In fishsciences/telemetry: Telemetry helper functions

List DB entry

Description

A generic function for accessing all /api/list/* end-points.

Usage

list_db_entry(
  entry,
  additionalID = NA,
  session,
  token = session$unToken,
  curl_handle = session$curl,
  api_baseurl = session$base_url,
  end_point = "/api/list/",
  api_url = paste0(api_baseurl, end_point),
  ...
)

Arguments

entry	character, one of affiliations, batches, projects, networks, orgs, species, antenna
additionalID	optional, for end-points that require an additional identifier
session	list, an object created by start_session()
token	the token for the session
curl_handle	curl handle for making requests
api_baseurl	character, the base URL for the database
end_point	character, the suffix for the end-point being queried
api_url	character, the full url for the end-point
...	additional arguments passed to getURL()

Value

data.frame of the available categories for each request

Author(s)

Matt Espe

fishsciences/telemetry documentation built on May 31, 2024, 10:13 a.m.