ices_get: Get a url

View source: R/ices_get.R

ices_getR Documentation

Get a url

Description

Get a url, optionally using an ICES authentication token

Usage

ices_get(
  url,
  retry = TRUE,
  quiet = FALSE,
  verbose = FALSE,
  content = TRUE,
  use_token = getOption("icesSAG.use_token")
)

ices_get_cached(
  url,
  retry = TRUE,
  quiet = FALSE,
  verbose = FALSE,
  content = TRUE,
  use_token = getOption("icesSAG.use_token")
)

Arguments

url

the url to get.

retry

should the get request be retried if first attempt fails? default TRUE.

quiet

should all messages be suppressed, default FALSE.

verbose

should verbose output form the http request be returned? default FALSE.

content

should content be returned, or the full http reponse? default TRUE, i.e. content is returned by default.

use_token

should an authentication token be sent with the request? default is the value of the option icesSAG.use_token.

Value

content or an http response.

Functions

  • ices_get_cached(): cached version of ices_get

See Also

sag_api builds a SAG web service url.

icesSAG-package gives an overview of the package.

Examples

## Not run: 
ices_get(sag_api("StockList", year = 2022))

## End(Not run)

ices-tools-prod/icesSAG documentation built on Nov. 24, 2023, 1:55 a.m.