Skip to contents

Make a request to the api/v2/administrativecalls endpoints to locate active or historical administrative calls by division, location WDID, or call number within a specified date range.

Usage

get_admin_calls(
  division = NULL,
  location_wdid = NULL,
  call_number = NULL,
  start_date = "1900-01-01",
  end_date = Sys.Date(),
  active = TRUE,
  api_key = NULL
)

Arguments

division

character or numeric, indicating the water division to query

location_wdid

character or numeric, call location structure WDID

call_number

numeric, unique call identifier

start_date

character date to request data start point YYYY-MM-DD

end_date

character date to request data end point YYYY-MM-DD

active

logical, whether to get active or historical administrative calls. Default is TRUE, which will retrieve active administrative calls.

api_key

character, API authorization token, optional. If more than maximum number of requests per day is desired, an API key can be obtained from CDSS.

Value

dataframe of administrative calls data

Examples

if (FALSE) {
# Retrieve ACTIVE administrative calls
active_calls <- get_admin_calls(
               division     = 1,
               active       = TRUE
           )

# Retrieve HISTORICAL administrative calls
historic_calls <- get_admin_calls(
               division     = 1,
               start_date   = "2000-01-01",
               end_date     = "2005-01-01",
               active       = FALSE
               )
}