REDCap

REDCap API Documentation

Method Name

Import User-DAG Assignments

Description

This method allows you to assign users to any data access group.

NOTE: If you wish to modify an existing mapping, you *must* provide its unique username and group name. If the 'redcap_data_access_group' column is not provided, user will not assigned to any group. There should be only one record per username.

URL

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

Supported Request Method

POST

Permissions Required

To use this method, you must have API Import/Update privileges *and* Data Access Groups 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
userDagMapping

action
import

format
csv, json, xml [default]

data
Contains the attributes 'username' (referring to the existing unique username) and 'redcap_data_access_group' (referring to existing unique group name) of each User-DAG assignments to be modified, in which they are provided in the specified format.

JSON Example:

[{"username":"ca_dt_person","redcap_data_access_group":"ca_site"},
{"username":"fl_dt_person","redcap_data_access_group":"fl_site"},
{"username":"global_user","redcap_data_access_group":""}]

CSV Example:

username,redcap_data_access_group
ca_dt_person,ca_site
fl_dt_person,fl_site
global_user,

XML Example:

<?xml version="1.0" encoding="UTF-8" ?>
<items>
   <item>
      <username>ca_dt_person</username>
      <redcap_data_access_group>ca_site</redcap_data_access_group>
   </item>
   <item>
      <username>fl_dt_person</username>
      <redcap_data_access_group>fl_site</redcap_data_access_group>
   </item>
   <item>
      <username>global_user</username>
      <redcap_data_access_group></redcap_data_access_group>
   </item>
</items>

Optional

returnFormat
csv, json, xml - specifies the format of error messages. If you do not pass in this flag, it will select the default format for you passed based on the 'format' flag you passed in or if no format flag was passed in, it will default to 'xml'.
NOTE: Does not apply when importing as a background process (i.e., backgroundProcess=true). When using a background process, success:true (upon success) or success:false (upon failure) will be returned in the appropriate format (csv, json, xml).

Returns

Number of User-DAG assignments added or updated

General API Info

Supported Methods