APIPerson
Represents one user and their account details. Refer to each function's output description for the number of users returned.
| Data Field | Data Type | Description |
|---|---|---|
| person_id | Int32 | the person_id of the user |
| first_name | String | the user’s first name |
| last_name | String | the user’s last name |
| user_id | String | the user’s user ID |
| anon_id_code | String | applies only when Anonymous ID codes are enabled, otherwise blank |
| student_id_num | String | the user’s student ID number (if available) |
| phone | String | the user’s phone number (if available) |
| office | String | the user’s office location (if available) |
| alt_email | String | the user’s alternate email address (or main email address, if @ Suffix is not enabled in System Settings) |
| person_type_a | Int32 | possible values: 1 = admin | 0 = not an admin |
| person_type_e | Int32 | possible values: 1 = researcher | 0 = not a researcher |
| person_type_p | Int32 | possible values: 1 = PI | 0 = not a PI |
| person_type_i | Int32 | possible values: 1 = instructor | 0 = not an instructor |
| person_type_s | Int32 | possible values: 1 = student (participant) | 0 = not a student (participant) |
| person_type_pref | String | possible values: A = admin | E = researcher | P = PI | I = instructor | S = student (participant) |
| credits_earned | Decimal | the total credits earned by the participant |
| credits_needed | Decimal | the total credits needed (requirements) by the participant |
| pretest | Int32 | Whether the participant has completed the prescreen. possible values: 0 = prescreen not taken | 1 = prescreen completed | 2 = opted out | 3 = currently taking prescreen |
| login_allowed | Int32 | possible values: 0 = login not allowed | 1 = login allowed |
| approved | Int32 | possible values: 0 = account not approved | 1 = account approved |
| admin_comments | String | comments seen by administrators only |
| hipaa_ack_date | Date | the date when the participant acknowledged privacy policy |
| hipaa_ack_date_nonp | Date | the date when the non-participant user role acknowledged privacy policy |
| login_sent_date | Date | the date when the user's login info was last sent |
| daily_reminder | Int32 | possible values: 0 = no daily reminders | 1 = receives daily reminders |
| weekly_reminder | Int32 | possible values: 0 = no weekly reminders | 1 = receives weekly reminders |
| study_invitation | Int32 | possible values: 0 = no study invitations | 1 = receives study invitations |
| classes_needed | Int32 | possible values: 0 = already in at least one course | 1 = needs to join a course |
| email_needed | Int32 | possible values: 0 = email not needed | 1 = email needed (currently not implemented) |
| password_change_needed | Int32 | possible values: 0 = password change not required | 1 = password change required on next login |
| password_failed_count | Int32 | the number of failed password login attempts |
| last_login | Date | the user's last login date |
| creation_date | Date | the date when the user's account was created (if available) |
| login_days | Int32 | the number of unique days the user has logged into the system |
| noshow_count | Int32 | the number of unexcused no-shows accrued |
| limited | Int32 | possible values: 0 = not limited to research alternatives | 1 = limited to research alternatives |
| limit_date | Date | the date when the participant’s account was limited |
| limit_type | String | possible values: M = manual (administrator set the limit) | A = automatic (limit was set based on no-show accrual) |
| language_pref | String | The user's preferred language code. Examples include EN = English, ZH = Simplified Chinese, ZH-TW = Traditional Chinese, JA = Japanese, KO = Korean, FR = French, PT = Brazilian Portuguese, and DE = German. |
| birthdate | Date | the date when the user was born |
| usage_limit | Int32 | Study Time Usage Limit for this user, in participant-hours. |