wastd_bulk_post: Post a list of records to a WAStD or TSC API endpoint

View source: R/wastd_bulk_post.R

wastd_bulk_postR Documentation

Post a list of records to a WAStD or TSC API endpoint

Description

\lifecycle

maturing

Usage

wastd_bulk_post(
  data,
  serializer,
  encode = "json",
  api_url = wastdr::get_wastdr_api_url(),
  api_token = wastdr::get_wastdr_api_token(),
  api_un = wastdr::get_wastdr_api_un(),
  api_pw = wastdr::get_wastdr_api_pw(),
  verbose = FALSE
)

Arguments

data

A tibble of a data with columns equal to the serializer's fields.

serializer

(character) WAStD API serializer name (required) Possible values see https://tsc.dbca.wa.gov.au/api/1/

encode

The parameter encode for link{httr::POST}, default: "json". Other options: c("multipart", "form", "json", "raw").

api_url

(character) The WAStD API URL, default get_wastdr_api_url, see wastdr_setup

api_token

(character) The WAStD API token, default get_wastdr_api_token, see wastdr_setup

api_un

(character) A WAStD API username, default get_wastdr_api_un, see wastdr_setup

api_pw

(character) A WAStD API password, default get_wastdr_api_pw, see wastdr_setup

verbose

Whether to show debug messages. Default: wastdr::get_wastdr_verbose()

Value

The list of wastd_api_responses from wastd_POST

See Also

Other api: build_auth(), download_minimal_wastd_turtledata(), download_wastd_sites(), download_wastd_turtledata(), download_wastd_users(), export_wastd_turtledata(), filter_wastd_turtledata_area(), filter_wastd_turtledata_seasons(), filter_wastd_turtledata(), handle_http_status(), wastd_GET(), wastd_POST(), wastd_chunk_post(), wastd_create_update_skip(), wastd_parse(), wastd_post_one()

Examples

## Not run: 
odkc_data$tracks %>%
  odkc_tracks_as_wastd_tne() %>%
  wastd_bulk_post("turtle-nest-encounters")

## End(Not run)

parksandwildlife/wastdr documentation built on Nov. 17, 2022, 4:52 p.m.