apiCall

List of parameters to be passed to <code>httr::POST</code>'s 
<code>body</code> argument or <code>RCurl::postForm</code>'s <code>.param</code> argument.

body

A list of options to be passed to <code>httr::POST</code>'s 
<code>config</code> argument or <code>RCurl::postForm</code>'s <code>.opts</code> argument.

config

<code>apiCall</code> is a wrapper for attempting to access the 
API via <code><a href="https://httr.r-lib.org/reference/POST.html">httr::POST</a></code>, and then via <code>RCurl::postForm</code> if a 
particular error occurs. This prevents a particular kind of error for 
which I haven't found a proper solution, but at least allows the 
expected behavior of the package. Since writing this, I have found
a solution to set the config option <code>encoding='identity'</code>. I 
may remove this function at some point in the future.

Access data stored in 'REDCap' databases using the Application
Programming Interface (API). 'REDCap' (Research Electronic Data CAPture;
<https://projectredcap.org>) is
a web application for building and managing online surveys and databases
developed at Vanderbilt University. The API allows users to access data
and project meta data (such as the data dictionary) from the web
programmatically. The 'redcapAPI' package facilitates the process of
accessing data with options to prepare an analysis-ready data set
consistent with the definitions in a database's data dictionary.

Benjamin Nutter

redcapAPI

Interface to 'REDCap'

Stephen Lane

Will Beasley

Jeffrey Horner

Will Gray

Jeremy Stephens

Marcus Lehr

apiCall function

<dl><dt>url</dt>
<dd>URL of the REDCap API</dd>
<dt>body</dt>
<dd>List of parameters to be passed to <code><a href="https://httr.r-lib.org/reference/POST.html">httr::POST</a></code>'s 
<code>body</code> argument or <code>RCurl::postForm</code>'s <code>.param</code> argument.</dd>
<dt>config</dt>
<dd>A list of options to be passed to <code><a href="https://httr.r-lib.org/reference/POST.html">httr::POST</a></code>'s 
<code>config</code> argument or <code>RCurl::postForm</code>'s <code>.opts</code> argument.</dd></dl>

Arguments

Author

<code>apiCall</code> is a wrapper for attempting to access the 
API via <code><a href='https://httr.r-lib.org/reference/POST.html'>httr::POST</a></code>, and then via <code>RCurl::postForm</code> if a 
particular error occurs. This prevents a particular kind of error for 
which I haven't found a proper solution, but at least allows the 
expected behavior of the package. Since writing this, I have found
a solution to set the config option <code>encoding='identity'</code>. I 
may remove this function at some point in the future.

Execute a Call to the REDCap API — apiCall

<dl>

<dt>url</dt>
<dd>URL of the REDCap API</dd>


<dt>body</dt>
<dd>List of parameters to be passed to <code><a href='https://httr.r-lib.org/reference/POST.html'>httr::POST</a></code>'s 
<code>body</code> argument or <code>RCurl::postForm</code>'s <code>.param</code> argument.</dd>


<dt>config</dt>
<dd>A list of options to be passed to <code><a href='https://httr.r-lib.org/reference/POST.html'>httr::POST</a></code>'s 
<code>config</code> argument or <code>RCurl::postForm</code>'s <code>.opts</code> argument.</dd>

</dl>

apiCall: Execute a Call to the REDCap API

Description

Usage

Arguments

Author

Details

References