check_status_code: Check HTTP status code

In biodiversitydata-se/SBDI4R: Swedish Biodiversity Data Infrastructure Data and Resources in R

Check HTTP status code

Description

Generic check function that checks HTTP status codes coming back from nbn requests.

Usage

check_status_code(
  x,
  on_redirect = NULL,
  on_client_error = NULL,
  on_server_error = NULL,
  extra_info = ""
)

Arguments

x	string: a status code, or an object of class "response" (from e.g. httr's GET)
on_redirect	function: optional function to evaluate in the case of a redirect (3xx) code. By default a warning is issued.
on_client_error	function: optional function to evaluate in the case of a client error (4xx) code. By default an error is thrown.
on_server_error	function: optional function to evaluate in the case of a server error (5xx) code. By default an error is thrown.
extra_info	string: additional diagnostic info that will be shown to the user for 4xx or 5xx codes, where x is not a full response object

Value

integer: simplified status code (0=success (2xx codes), 1=warning (3xx codes))

References

http://www.w3.org/Protocols/HTTP/HTRESP.html

Examples

## Not run: 
require(httr)
out <- GET(url="https://biodiversitydata.se/")
check_status_code(out) ## pass the whole response object
check_status_code(out$headers$status) ## or pass the status code explicitly

## End(Not run)

biodiversitydata-se/SBDI4R documentation built on Feb. 23, 2024, 4:15 p.m.