wastd_POST: Send a POST request to WAStD's API

In parksandwildlife/wastdr: WA Sea Turtle Database 'WAStD' API Wrapper

Send a POST request to WAStD's API

Description

\lifecycle

stable

Usage

wastd_POST(
  data,
  serializer,
  query = list(format = "json"),
  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 = wastdr::get_wastdr_verbose()
)

Arguments

data	(JSON) A list of lists (JSON) to post to WAStD.
serializer	(character) WAStD API serializer name (required) Possible values see https://tsc.dbca.wa.gov.au/api/1/
query	(list) A list of POST parameters, default: list(format="json").
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

An S3 object of class 'wastd_api_response' containing:

data: The parsed response content

serializer: The called serializer, e.g. 'supra'

url: The called URL

date: The timestamp of the request

status_code: The HTTP status code of the request

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_bulk_post(), wastd_chunk_post(), wastd_create_update_skip(), wastd_parse(), wastd_post_one()

Examples

## Not run: 
# TBA

## End(Not run)

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