espa_ordering_post_api: espa_ordering_post_api

In espa.tools: Wrappers for the USGS ESPA APIs and Earth Explorer

Description

R wrapper for USGS/EROS Ordering System POST API.

Usage

espa_ordering_post_api(request_code, json_request_content = NULL,
  usgs_eros_username, usgs_eros_password, auto_unbox = T, verbose = F)

Arguments

request_code	Character. One of the requests listed at https://earthexplorer.usgs.gov/inventory/documentation/json-api
json_request_content	List. Parameters to pass to the request system.
usgs_eros_username	Character. Your USGS registration username. You can register for an account at https://espa.cr.usgs.gov
usgs_eros_password	Character. Your USGS registration password. WARNING: USING THIS WITH R IS NOT PARTICULARLY SECURE.
auto_unbox	Logical auto_unbox the json_request_content? Default = T.
verbose	Logical. Verbose execution? Default=F.

Details

A function to convert requests to the USGS/EROS Ordering System URL format (POST). In general, you shouldn't need to call this directly unless you want finer command-line control over requests.

Value

List generated from the request.

Author(s)

Jonathan A. Greenberg ([e-mail]) (wrapper) and USGS ESPA Developers (API and documentation)

See Also

espa_ordering_get_api

Examples

## Not run:  
# Run the Available Products command:
inputs <- c("LE70290302003123EDC00","MOD09A1.A2000073.h12v11.005.2008238080250.hdf","bad_scene_id")
json_request_content <- list(inputs=inputs)
espa_ordering_post_api(request_code="api/v0/available-products",json_request_content=inputs,
  usgs_eros_username="myusername",usgs_eros_password="mypassword")

## End(Not run)

espa.tools documentation built on May 2, 2019, 5:54 p.m.