Skip to content

Survey Export Participants List

asaweero edited this page Aug 22, 2017 · 3 revisions

Exports an array of objects representing participants in a given instrument and event.

Required Parameters

  • instrument: The instrument name show in the second column of the Data Dictionary.
  • event: The specific event name (for longitudinal projects only).

Return Value

  • Returns a list of all the participants. The return format is specified below.
email, email_occurrence, identifier, invitation_sent_status, invitation_send_time, response_status, survey_access_code, survey_link

Method Usage

   var params = {
      instrument: 'effective_transitional_care_checklist',
      event: 'event_1_arm_1'
   };

   redcap.survey.exportParticipants (params, function (err, res) {
      // error containts oprtional errors
      if (err) {
          // handle error
      }
      else {
          // res is return value
          console.log (res);
      }
   });