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:

eywgRsf6ZxBMDabwTJv77sxVV3SWjfTs4IxieXA6K

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

REDCap API Documentation

Method Name

Export a Survey Link for a Participant

Description

This method returns a unique survey link (i.e., a URL) in plain text format for a specified record and data collection instrument (and event, if longitudinal) in a project. If the user does not have 'Survey Distribution Tools' privileges, they will not be able to use this method, and an error will be returned. If the specified data collection instrument has not been enabled as a survey in the project, an error will be returned.

URL

https://chi-redcap.dshs.texas.gov/redcap/api/

Supported Request Method

POST

Permissions Required

To use this method, you must have API Export privileges in the project.

Parameters (case sensitive)

Required

token
The API token specific to your REDCap project and username (each token is unique to each user for each project). See the section on the left-hand menu for obtaining a token for a given project.

content
surveyLink

record
the record ID. The name of the record in the project.

instrument
the unique instrument name as seen in the second column of the Data Dictionary. This instrument must be enabled as a survey in the project.

event
the unique event name (for longitudinal projects only).

repeat_instance
(only for projects with repeating instruments/events) The repeat instance number of the repeating event (if longitudinal) or the repeating instrument (if classic or longitudinal). Default value is '1'.

Optional

returnFormat
csv, json, xml [default] - The returnFormat is only used with regard to the format of any error messages that might be returned.

Returns

Returns a unique survey link (i.e., a URL) in plain text format for the specified record and instrument (and event, if longitudinal).

General API Info

Supported Methods