getWellContents: getWellContents - Gets content information of a single...

In ajwtech/pfsrsdk: Functions for interacting with Platform for Science APIs

Description

getWellContents - Gets content information of a single container well.

Usage

getWellContents(coreApi, containerBarcode, containerWellNum,
  containerType = "CONTAINER", fullMetadata = FALSE,
  useVerbose = FALSE)

Arguments

coreApi	coreApi object with valid jsessionid
containerBarcode	container barcode
containerWellNum	number location of container's well
containerType	entity type of container (default: "CONTAINER")
fullMetadata	get full metadata, default is FALSE
useVerbose	Use verbose communication for debugging (default: FALSE)

Details

getWellContents Gets content information of a single container well.

Value

RETURN returns a list $entity contains well information, $response contains the entire http response

Author(s)

Craig Parman [e-mail]

Scott Russell [e-mail]

Natasha Mora [e-mail]

Examples

## Not run: 
api <- coreAPI("PATH TO JSON FILE")
login <- authBasic(api)
well <- getWellContents(login$coreApi, "VIA9", "1", "VIAL")
logOut(login$coreApi)

## End(Not run)

ajwtech/pfsrsdk documentation built on June 14, 2019, 10:34 a.m.