APIStudyInfo
General information about a study.
| Data Field | Data Type | Description |
|---|---|---|
| experiment_id | Int32 | the numeric identifier of the study |
| study_name | String | the name of the study |
| short_desc | String | the short description of the study |
| long_desc | String | the long description of the study |
| private_comments | String | admin-only comments |
| restrictions | String | participant-facing eligibility requirements for the study |
| pi_id | Int32 | the numeric identifier of the PI |
| duration | Int32 | duration (in mins.) of the study |
| preparation | String | participant-facing instructions describing any preparation required for the study |
| credits | Decimal | the credits for this part of the study (0 if a paid study) |
| type | String | the study’s compensation type: C = credit study | M = paid study |
| exp_pay_managed | Int32 | whether the study uses managed payments: 1 = managed by Sona | 0 = not managed by Sona |
| valid | Int32 | 1 = valid | 0 = invalid |
| previously_approved | Int32 | indicates whether the study was previously approved |
| active | Int32 | 1 = active | 0 = inactive |
| exp_signup_email | Int32 | 0 = no researcher email notifications | 1 = sign-up and cancellation notifications | 2 = cancellation notifications only |
| has_prereqs | Int32 | 1 = study has one or more prerequisite studies | 0 = no prerequisite studies |
| has_rests | Int32 | 1 = study has prescreen participation restrictions | 0 = no prescreen participation restrictions |
| is_neg_req | Int32 | 1 = study is used as a disqualifier for another study | 0 = not used as a disqualifier |
| prereq_any | Int32 | 0 = participant must satisfy all prerequisite studies | 1 = participant must satisfy at least one prerequisite study |
| neg_req_any | Int32 | Returned but not used. |
| course_restrictions | String | comma-delimited list of numeric course IDs allowed to participate; empty if there are no course restrictions |
| last_timeslot | Date | the last timeslot for the study |
| double_signup_flag | Int32 | 1 = duplicate signups allowed | 0 = no duplicate signups |
| signup_password | String | the invitation code |
| web_flag | Int32 | 0 = standard (lab) study | 1 = internal online survey or external web study |
| survey_flag | Int32 | 0 = standard (lab) or external web study | 1 = internal online survey |
| survey_anon_flag | Int32 | 1 = internal online survey responses are anonymous | 0 = responses are not anonymous |
| experiment_url | String | the URL for the external study |
| irb_code | String | the IRB code |
| irb_expiration_date | Date | the IRB expiration date |
| has_multipart | Int32 | 1 = multipart study | 0 = non-multipart study |
| multipart_exact | Int32 | 0 = can occur at any time compared to previous part | 1 = must occur at same time as previous part |
| multipart_number | Int32 | represents which part, of a multipart study, the study belongs to |
| parent_experiment_id | Int32 | 0 for a single-part study or the first part of a multipart study. Otherwise, the experiment_id of part 1. |
| multipart_min_days | Int32 | the minimum number of days of separation between this part of the study and the previous part (applies to multipart studies only) |
| multipart_max_days | Int32 | the maximum number of days of separation between this part of the study and the previous part (applies to multipart studies only) |
| total_parts | Int32 | the number of parts the study has |
| total_credits | Decimal | total credits for the entire study. Will be the same as the credits field, except in cases of multi-part studies. 0 for paid studies. |
| usage_limit | Int32 | timeslot usage limit (quota) for study, in hours |
| signup_limit | Int32 | signup deadline (in hours) |
| cancel_limit | Int32 | cancellation deadline (in hours) |
| auto_credit_enable | Int32 | 1 = auto crediting enabled | 0 = disabled |
| experimenter_timeslot | Int32 | 1 = researchers can be assigned at timeslot-level. |
| show_participants | Int32 | (not implemented) |
| study_alternative | Int32 | 1 = research alternative | 0 = not a research alternative |
| creation_date | Date | date when study was created. May be empty for older studies. |
| last_activity | Date | date when the study last underwent any changes |
| payment | String | display payment value for this study part; empty for credit studies |
| payment_numeric | Decimal | numeric payment amount for this study part; 0 for credit studies |
| total_payment | String | display value of the total payment across all parts of a multipart study; empty for credit studies |
| total_payment_numeric | Decimal | numeric total payment amount across all parts of a multipart study; 0 for credit studies |
| age_minimum | Decimal | Minimum age to sign up for the study. 0 = no age limits. |
| age_maximum | Decimal | Maximum age to sign up for the study. Ignore if age_minimum=0. |