api_get: Execute and return a DATIM API query.

In pepfar-datim/datimutils: Utilities for interacting with the DATIM api from R

Execute and return a DATIM API query.

Description

Gets and flattens DATIM API query as dataframe.

Usage

api_get(
  path,
  d2_session,
  retry = 1,
  timeout = 60,
  api_version = NULL,
  verbose = FALSE,
  quiet = TRUE
)

Arguments

path	Should begin with api/ and contain the query
d2_session	the d2Session object, default is "d2_default_session", it will be made upon logining in to datim with loginToDATIM
retry	number of times to try in case of failure, default will not try again
timeout	how long should a reponse be waited for
api_version	defaults to current but can pass in version number
verbose	return raw content with data
quiet	Echo the URL which is called to the console.

Value

Result of DATIM API query returned as named list.

pepfar-datim/datimutils documentation built on Nov. 20, 2023, 7:58 a.m.