REDCap

The code block below illustrates how one might use # and // as comments in your logic and calculations.

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:

59DxhntshDmtrpxIUUXduUXBQIMzJhbWf6HzPZEkm3BaYtDyf3PshrfnYJAbu8fiN83kRR3NLIzcSutIwWWpj

The code block below illustrates how one might use # and // as comments in your logic and calculations.

REDCap API Documentation

HTTP Status Codes:

The REDCap API attempts to return appropriate HTTP status codes for every request. Below is a comprehensive list of all possible HTTP codes that could be returned from the API and what each code signifies.

200 OK: Success!
400 Bad Request: The request was invalid. An accompanying message will explain why.
401 Unauthorized: API token was missing or incorrect.
403 Forbidden: You do not have permissions to use the API.
404 Not Found: The URI you requested is invalid or the resource does not exist.
406 Not Acceptable: The data being imported was formatted incorrectly.
500 Internal Server Error: The server encountered an error processing your request.
501 Not Implemented: The requested method is not implemented.

Error Messages:

When the API returns error messages, it does so in the return format that you specified in your API request (and if not specified, it returns in default format). You can specify the format you want using the returnFormat parameter. For example, an error from an XML method might look like this:

<?xml version="1.0" encoding="UTF-8" ?>
<hash>
  <error>detailed error message</error>
</hash>

General API Info

Supported Methods