https://github.com/ctsit/mobile_api_request_to_survey

A REDCap module to direct mobile api token requests to a survey
https://github.com/ctsit/mobile_api_request_to_survey

redcap redcap-external-module redcap-repo

Last synced: about 1 month ago
JSON representation

A REDCap module to direct mobile api token requests to a survey

• Host: GitHub
• URL: https://github.com/ctsit/mobile_api_request_to_survey
• Owner: ctsit
• License: other
• Created: 2018-01-12T16:18:14.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-30T21:00:17.000Z (over 6 years ago)
• Last Synced: 2023-10-20T19:08:11.857Z (about 1 year ago)
• Topics: redcap, redcap-external-module, redcap-repo
• Language: PHP
• Homepage:
• Size: 215 KB
• Stars: 0
• Watchers: 8
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# REDCap module: Mobile Api Request to Survey

A REDCap module to route mobile api token requests in the **REDCap Mobile App** page to a survey. It also provides the option of adding descriptive text to the same page.

## Prerequisites

- REDCap >= 8.0.3 (for versions < 8.0.3, [REDCap Modules](https://github.com/vanderbilt/redcap-external-modules) is required).

## Installation

- Clone this repo into `/modules/mobile_api_request_to_survey_v`.

- Go to **Control Center > External Modules** and enable Mobile Api Request to Survey.

- Still in **Control Center > External Modules** configure the module with a URL and optionally, a descriptive text. You may also include parameter name-value pairs to be appended to the URL. Lastly, activate this module for all projects.

## How to use

This module requires a Base URL to be provided as part of the system settings. The following values may be selected to be appended to the URL:

    user_firstname

    user_lastname

    email

    project_id

    USERID

The `USERID` field contains the redcap username.

To use the appended parameters, make sure the parameter names you chose coincide with the names of the fields in the target REDCap survey.

In addition, you may include an optional descriptive text, which may include html formatting. Such text will appear on the 'REDCap Mobile App' page before the title 'What is the REDCap Mobile App?'.

For example, using the configuration below:

![Example Configuration](example_configuration.png)

the rewritten target URL might look like this:

    https://redcap.org/surveys/?s=DUPrXGmx3L&Name=jdoe&Lastname=doe_lastname

and the text 'About the REDCap Mobile App' will be added on the 'REDCap Mobile App' before the title 'What is the REDCap Mobile App?'.