The code block below illustrates how one might use # and // as comments in your logic and calculations.
# Text can be put here to explain what the logic/calculation does and why.
if ([field1] = '1' and [field2] > 7,
// This comment can explain what the next line does.
[score] * [factor],
// Return '0' if the condition is False.
0
)
This value you provided is not a number. Please try again.
This value you provided is not an integer. Please try again.
The value entered is not a valid Vanderbilt Medical Record Number (i.e. 4- to 9-digit number, excluding leading zeros). Please try again.
The value you provided must be within the suggested range
The value you provided is outside the suggested range
This value is admissible, but you may wish to double check it.
The value entered must be a time value in the following format HH:MM within the range 00:00-23:59 (e.g., 04:32 or 23:19).
This field must be a 5 or 9 digit U.S. ZIP Code (like 94043). Please re-enter it now.
This field must be a 10 digit U.S. phone number (like 415 555 1212). Please re-enter it now.
This field must be a valid email address (like joe@user.com). Please re-enter it now.
The value you provided could not be validated because it does not follow the expected format. Please try again.
Required format:
3HUCsFLQJ3nTz7j9gyfVN5jY7kHP45VgLej98x3sAkduVBDYefEJmQGqIhkqozmAzZqp222rshp6Uqp2d4K3b2RLvCV77MnVx4VFBUbc4e3kkhNYP8dB
The code block below illustrates how one might use # and // as comments in your logic and calculations.
# Text can be put here to explain what the logic/calculation does and why.
if ([field1] = '1' and [field2] > 7,
// This comment can explain what the next line does.
[score] * [factor],
// Return '0' if the condition is False.
0
)
REDCap API Documentation
Introduction to the REDCap API
Provided here is all documentation for utilizing the REDCap API. For general information about the REDCap API or the methods supported by the REDCap API, see the list on the left-hand menu. Each API method provides a specific action that can be performed by REDCap.
The acronym 'API' stands for 'Application Programming Interface'. An API is just a defined way for a program to accomplish a task. The REDCap API is an interface that allows external applications to connect to REDCap remotely, and is used for programmatically retrieving or modifying data or settings within REDCap, such as performing automated data imports/exports for a specified REDCap project. Programmers can use the REDCap API to make applications, websites, apps, widgets, and other projects that interact with REDCap. Programs talk to the REDCap API over HTTP, the same protocol that your browser uses to visit and interact with web pages.
To get started using the REDCap API, begin with the General API Info section on the left-hand menu. There is also an API Playground page in each of your REDCap projects, in which the playground will allow you to experiment with the REDCap API and see the range of its functionality without even having to write any code.
