ForResearchersApi (REST Client 0.25.18 API)

```
public interface ForResearchersApi
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`retrofit2.Call<Message>`	`createActivityEventForParticipant(String userId, CustomActivityEventRequest customActivityEventRequest)` Deprecated.
`retrofit2.Call<HealthDataDocumentation>`	`createOrUpdateHealthDataDocumentation(HealthDataDocumentation healthDataDocumentation)` Create or update health data documentation.
`retrofit2.Call<IdentifierHolder>`	`createParticipant(SignUp signUp)` Create a new study participant (user) If the caller is a developer account, then the participant record will automatically be created as a test user (marked with the “test_user” data group).
`retrofit2.Call<IdentifierHolder>`	`createStudyParticipant(String studyId, SignUp signUp)` Create a new study participant who will be enrolled (but not consented) in this study.
`retrofit2.Call<Message>`	`createStudyParticipantStudyActivityEvent(String studyId, String userId, StudyActivityEventRequest customActivityEventRequest, Boolean showError, Boolean updateBursts)` Create a new activity event for a participant in this study.
`retrofit2.Call<Message>`	`deleteAdherenceRecord(String studyId, String userId, String instanceGuid, DateTime eventTimestamp, DateTime startedOn)` Delete an adherence record Delete an existing adherence record
`retrofit2.Call<Message>`	`deleteDemographic(String studyId, String userId, String demographicId)` Deletes a specific demographic (single category) for a particular user Deletes a specific demographic (single category) for a particular user (study-level, done by researcher or study coordinator)
`retrofit2.Call<Message>`	`deleteDemographicUser(String studyId, String userId)` Deletes all of a user's demographics Deletes all of a user's demographics (study-level, done by researcher or study coordinator)
`retrofit2.Call<Message>`	`deleteParticipant(String userId)` Delete a study participant if the record has the `test_user` data group, or the account has not been used by the participant (the participant has never signed in to Bridge using the account) and it is only enrolled in one study.
`retrofit2.Call<Message>`	`deleteParticipantActivities(String userId)` Deprecated.
`retrofit2.Call<Message>`	`deleteStudyParticipant(String studyId, String userId)` Delete a study participant if the record has the `test_user` data group, or the account has not been used by the participant (the participant has never signed in to Bridge using the account) and it is only enrolled in one study.
`retrofit2.Call<Message>`	`deleteStudyParticipantStudyActivityEvent(String studyId, String userId, String eventId, Boolean showError)` Delete activity event for a study participant if it is mutable.
`retrofit2.Call<Enrollment>`	`enrollParticipant(String studyId, Enrollment enrollment)` Enroll an account in a study as a participant.
`retrofit2.Call<GeneratedPassword>`	`generatePassword(String externalId, Boolean createAccount)` Deprecated.
`retrofit2.Call<ActivityEventList>`	`getActivityEventsForParticipant(String userId)` Deprecated.
`retrofit2.Call<AdherenceStatistics>`	`getAdherenceStatistics(String studyId, Integer adherenceThreshold)` Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.
`retrofit2.Call<HealthDataDocumentationList>`	`getAllHealthDataDocumentationForParentId(String parentId, String offsetKey, Integer pageSize)` Get all health data documentation by parentId.
`retrofit2.Call<DemographicValuesValidationConfig>`	`getDemographicsValidationConfig(String studyId, String categoryName)` Fetch a DemographicValuesValidationConfig Fetch an existing DemographicValuesValidationConfig which is used to configure demographics validation.
`retrofit2.Call<DemographicUserResponse>`	`getDemographicUser(String studyId, String userId)` Fetches all demographics for a user Fetches all demographics for a user (study-level, done by researcher/study-coordinator)
`retrofit2.Call<DemographicUserResponseList>`	`getDemographicUsers(String studyId, Integer offsetBy, Integer pageSize)` Fetches all study-level demographics for all users within a study Fetches all study-level demographics for all users within a study (study-level, done by researcher/study-coordinator)
`retrofit2.Call<EnrollmentDetailList>`	`getEnrollments(String studyId, String enrollmentFilter, Boolean includeTesters, Integer offsetBy, Integer pageSize)` Get the enrollments in this study.
`retrofit2.Call<EnrollmentDetailList>`	`getEnrollmentsForUser(String userId)` Get enrollment records for this user
`retrofit2.Call<ExternalIdentifierList>`	`getExternalIdsForStudy(String studyId, Integer offsetBy, Integer pageSize, String idFilter)` Get external IDs for a study
`retrofit2.Call<HealthDataDocumentation>`	`getHealthDataDocumentationForId(String identifier)` Get a health data documentation with the given identifier This endpoint can be called by researchers and developers to get a specific documentation by identifier.
`retrofit2.Call<SurveyList>`	`getMostRecentSurveys(Boolean includeDeleted)` Deprecated.
`retrofit2.Call<UploadSchemaList>`	`getMostRecentUploadSchemas(Boolean includeDeleted)` Deprecated.
`retrofit2.Call<ForwardCursorScheduledActivityList>`	`getParticipantActivityHistory(String userId, String activityGuid, DateTime scheduledOnStart, DateTime scheduledOnEnd, String offsetKey, Integer pageSize)` Deprecated.
`retrofit2.Call<StudyParticipant>`	`getParticipantByExternalId(String externalId, Boolean consents)` Get a study participant (user) record using the external ID of the account
`retrofit2.Call<StudyParticipant>`	`getParticipantByHealthCode(String healthCode, Boolean consents)` Get a study participant (user) record using the health code of the account
`retrofit2.Call<StudyParticipant>`	`getParticipantById(String userId, Boolean consents)` Get a study participant (user) record This endpoint can be called by researchers (all authenticated users can retrieve their own StudyParticipant record by using the `getUsersParticipantRecord` method, which should be used by administrative accounts as well, such as developers).
`retrofit2.Call<ForwardCursorScheduledActivityList>`	`getParticipantCompoundActivityHistory(String userId, String taskId, DateTime scheduledOnStart, DateTime scheduledOnEnd, String offsetKey, Integer pageSize)` Deprecated.
`retrofit2.Call<NotificationRegistrationList>`	`getParticipantPushNotificationRegistrations(String userId)` Get a study participant's push notification registrations Get all of a study participant's registrations for push notifications.
`retrofit2.Call<RequestInfo>`	`getParticipantRequestInfo(String userId)` Get information about the last request made by this participant Retrieves information about the user agent headers and participant settings that were in effect the last time this participant contacted the Bridge server.
`retrofit2.Call<AccountSummaryList>`	`getParticipants(Integer offsetBy, Integer pageSize, String emailFilter, String phoneFilter, DateTime startTime, DateTime endTime)` Get a paged list of study participants (users)
`retrofit2.Call<ParticipantSchedule>`	`getParticipantSchedule(String studyId, String userId)` Get the caller’s scheduled activities in this study.
`retrofit2.Call<ForwardCursorScheduledActivityList>`	`getParticipantSurveyHistory(String userId, String surveyGuid, DateTime scheduledOnStart, DateTime scheduledOnEnd, String offsetKey, Integer pageSize)` Deprecated.
`retrofit2.Call<ForwardCursorScheduledActivityList>`	`getParticipantTaskHistory(String userId, String taskId, DateTime scheduledOnStart, DateTime scheduledOnEnd, String offsetKey, Integer pageSize)` Deprecated.
`retrofit2.Call<UploadList>`	`getParticipantUploads(String userId, DateTime startTime, DateTime endTime, Integer pageSize, String offsetKey)` Get a study participant's upload history Retrieve information about the uploads from a user.
`retrofit2.Call<SchedulePlanList>`	`getSchedulePlans(Boolean includeDeleted)` Deprecated.
`retrofit2.Call<OrganizationList>`	`getSponsors(String studyId, Integer offsetBy, Integer pageSize)` Get the sponsors of this study.
`retrofit2.Call<StudyList>`	`getStudies(Integer offsetBy, Integer pageSize, Boolean includeDeleted)` Get a list of the studies in this app
`retrofit2.Call<Study>`	`getStudy(String studyId)` Get a study Get a study for this app.
`retrofit2.Call<StudyAdherenceReport>`	`getStudyParticipantAdherenceReport(String studyId, String userId)` Get a detailed report on a participant’s full schedule of activities.
`retrofit2.Call<StudyParticipant>`	`getStudyParticipantById(String studyId, String userId, Boolean consents)` Get a study participant.
`retrofit2.Call<EnrollmentDetailList>`	`getStudyParticipantEnrollments(String studyId, String userId)` Get enrollment records for this user.
`retrofit2.Call<EventStreamAdherenceReport>`	`getStudyParticipantEventStreamAdherenceReport(String studyId, String userId, DateTime datetime, Boolean activeOnly)` Get a detailed report on a participant’s adherence to the entire study protocol’s schedule.
`retrofit2.Call<NotificationRegistrationList>`	`getStudyParticipantNotificationRegistrations(String studyId, String userId)` Get a study participant’s push notification registrations Get all of a study participant’s registrations for push notifications.
`retrofit2.Call<RequestInfo>`	`getStudyParticipantRequestInfo(String studyId, String userId)` Get information about the last request made by this participant
`retrofit2.Call<AccountSummaryList>`	`getStudyParticipants(String studyId, AccountSummarySearch accountSummarySearch)` Search for account summaries of study participants.
`retrofit2.Call<StudyActivityEventPagedList>`	`getStudyParticipantStudyActivityEventHistory(String studyId, String userId, String eventId, Integer offsetBy, Integer pageSize)` Get the history of past timestamps for this event (for the caller).
`retrofit2.Call<StudyActivityEventList>`	`getStudyParticipantStudyActivityEvents(String studyId, String userId)` Get activity events for the participants
`retrofit2.Call<Timeline>`	`getStudyParticipantTimeline(String studyId, String userId)` Get the timeline that is being assigned to the specific study participant.
`retrofit2.Call<UploadList>`	`getStudyParticipantUploads(String studyId, String userId, DateTime startTime, DateTime endTime, Integer pageSize, String offsetKey)` Get a study participant’s upload history Retrieve information about the uploads from a user.
`retrofit2.Call<ReportIndex>`	`getStudyReportIndex(String identifier)` Get a report index Get the index (or metadata) for a set of report records.
`retrofit2.Call<Subpopulation>`	`getSubpopulation(String subpopulationGuid)` Get a subpopulation
`retrofit2.Call<UploadValidationStatus>`	`getUploadStatus(String uploadId)` Get status of a single upload attempt Caller must either be a participant getting a status of one of the participant's own uploads, or a reearcher.
`retrofit2.Call<App>`	`getUsersApp()` Get an app Get the app of the currently signed in user account.
`retrofit2.Call<ReportDataList>`	`getUsersParticipantReportRecords(String userId, String identifier, LocalDate startDate, LocalDate endDate)` Get participant report records The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
`retrofit2.Call<ForwardCursorReportDataList>`	`getUsersParticipantReportRecordsV4(String userId, String identifier, DateTime startTime, DateTime endTime, String offsetKey, Integer pageSize)` Get participant report records The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
`retrofit2.Call<WeeklyAdherenceReport>`	`getWeeklyAdherenceReport(String studyId, String userId)` Get a detailed report on a participant’s current week of scheduled activities.
`retrofit2.Call<WeeklyAdherenceReportList>`	`getWeeklyAdherenceReports(String studyId, AdherenceReportSearch adherenceReportSearch)` Get the adherence for all study participants in their current week of the study.
`retrofit2.Call<Message>`	`requestParticipantRoster(ParticipantRosterRequest participantRosterRequest)` Request a roster of participants within an app, and optionally within a study if a studyId is provided.
`retrofit2.Call<Message>`	`resendParticipantConsentAgreement(String userId, String subpopulationGuid)` Re-send the consent agreement for this subpopulation When called, re-sends a signed consent agreement document to the participant's email address.
`retrofit2.Call<Message>`	`resendStudyParticipantConsentAgreement(String studyId, String userId, String guid)` Re-send the consent agreement for this study When called, re-sends a signed consent agreement document to the participant’s email address.
`retrofit2.Call<DemographicUserResponse>`	`saveDemographicUser(String studyId, String userId, DemographicUser demographicUser)` Save/overwrite all demographics for a user Save/overwrite all demographics for a user (study-level, posted on the user's behalf by researcher, study coordinator)
`retrofit2.Call<DemographicUserResponse>`	`saveDemographicUserAssessment(String studyId, String userId, DemographicUserAssessment demographicUserAssessment)` Save/overwrite all demographics for a user Save/overwrite all demographics for a user (study-level, posted on the user's behalf by researcher, study coordinator), uses the assessment JSON model
`retrofit2.Call<AccountSummaryList>`	`searchAccountSummaries(AccountSummarySearch accountSummarySearch)` Search for account summaries (participants) For developers, this API only returns test accounts (accounts marked with the “test_user” data group).
`retrofit2.Call<AdherenceRecordList>`	`searchForStudyParticipantAdherenceRecords(String studyId, String userId, AdherenceRecordsSearch adherenceRecordsSearch)` Search for adherence records.
`retrofit2.Call<Message>`	`sendInstallLinkMessage(String userId)` Send a message (SMS or email) to a participant explaining how to download and install the app When called, sends either an SMS message or an email message (depending on whether the account has a verified email address or phone number.
`retrofit2.Call<Message>`	`sendNotificationToParticipant(String userId, NotificationMessage notificationMessage)` Send a push notification to a single participant Send a push notification to an individual participant (assuming they have registered for push notifications).
`retrofit2.Call<Message>`	`sendParticipantEmailVerification(String userId)` Resend an email verification email to this user When called, resends the email to the user's email account, which contains a link they must click on to verify they control that email address.
`retrofit2.Call<Message>`	`sendParticipantPhoneVerification(String userId)` Resend a phone verification to this user When called, resends the SMS message to the user's email account, which contains a code they must enter into your application to call and verify this phone number.
`retrofit2.Call<Message>`	`sendParticipantResetPassword(String userId)` Trigger a request to reset password for this user When called, a reset password message will be sent to either the email address or the phone number for this account (preferencing the email address).
`retrofit2.Call<Message>`	`sendStudyParticipantEmailVerification(String studyId, String userId)` Resend an email verification email to this user When called, resends the email to the user's email account, which contains a link they must click on to verify they control that email address.
`retrofit2.Call<Message>`	`sendStudyParticipantNotification(String studyId, String userId, NotificationMessage notificationMessage)` Send a push notification to a single participant Send a push notification to an individual participant (assuming they have registered for push notifications).
`retrofit2.Call<Message>`	`sendStudyParticipantPhoneVerification(String studyId, String userId)` Resend a phone verification to this user When called, resends the SMS message to the user’s email account, which contains a code they must enter into your application to call and verify this phone number.
`retrofit2.Call<Message>`	`sendStudyParticipantResetPassword(String studyId, String userId)` Trigger a request to reset password for this user When called, a reset password message will be sent to either the email address or the phone number for this account (with a preference for the email address).
`retrofit2.Call<Message>`	`signOutParticipant(String userId, Boolean deleteReauthToken)` Sign the user out and delete their server session This endpoint can be called by researchers, and by other administrators for their own account.
`retrofit2.Call<Message>`	`signOutStudyParticipant(String studyId, String userId, Boolean deleteReauthToken)` Sign the participant out and delete their server session
`retrofit2.Call<Study>`	`transitionStudyToAnalysis(String studyId)` Transition a study’s phase to “analysis.” This can only be done with a study that is currently “in flight.”
`retrofit2.Call<Study>`	`transitionStudyToCompleted(String studyId)` Transition a study’s phase to “completed.” This can only be done with a study that is currently in the “analysis” phase.
`retrofit2.Call<Study>`	`transitionStudyToDesign(String studyId)` Transition a study’s phase to “design.” This can only be done with a study that is currently in the “legacy” phase.
`retrofit2.Call<Study>`	`transitionStudyToInFlight(String studyId)` Transition a study’s phase to “in flight.” This can only be done with a study that is currently in the “recruitment” phase.
`retrofit2.Call<Study>`	`transitionStudyToRecruitment(String studyId)` Transition a study’s phase to “recruitment.” This can only be done with a study that is currently in the “design” phase.
`retrofit2.Call<Study>`	`transitionStudyToWithdrawn(String studyId)` Transition a study’s phase to “withdrawn.” This can be done with a study that is currently in “design,” “recruitment,” “in flight,” or “analysis” phases.
`retrofit2.Call<Message>`	`updateEnrollment(String studyId, String userId, Enrollment enrollment)` Update a participant's enrollment record for a study Developers and Study Designers can only update test accounts.
`retrofit2.Call<Message>`	`updateParticipant(String userId, StudyParticipant studyParticipant)` Update an existing study participant (user) record This endpoint can be called by researchers, and by other administrators for their own account account.
`retrofit2.Call<Message>`	`updateStudyParticipant(String studyId, String userId, StudyParticipant studyParticipant)` Update an existing study participant (user) record
`retrofit2.Call<Message>`	`updateStudyParticipantAdherenceRecords(String studyId, String userId, AdherenceRecordUpdates adherenceRecordUpdates)` Update one or more adherence records for a participant
`retrofit2.Call<VersionHolder>`	`updateUsersApp(App app)` Update an app Update the app of the currently signed in developer account.
`retrofit2.Call<Enrollment>`	`withdrawParticipant(String studyId, String userId, String withdrawalNote)` Withdraw a participant from the study
`retrofit2.Call<Message>`	`withdrawParticipantFromApp(String userId, Withdrawal withdrawal)` Withdraw the participant from all studies in this app Withdraw the user entirely from all studies in this app.
`retrofit2.Call<Message>`	`withdrawParticipantFromSubpopulation(String userId, String subpopulationGuid, Withdrawal withdrawal)` Withdraw the participant from the specified subpopulation This endpoint will withdraw the user from consent to participate in one subpopulation of the app.

Method Detail

createActivityEventForParticipant

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/activityevents")
retrofit2.Call<Message> createActivityEventForParticipant(@Path(value="userId")
                                                                                                                                                                               String userId,
                                                                                                                                                                               @Body
                                                                                                                                                                               CustomActivityEventRequest customActivityEventRequest)

Deprecated.

Create a custom event for a participant This endpoint can be called by researchers in order to create an activity event for a participant. This is an event name and a timestamp for the event. A 201 is returned whether the event updates or not, to support concurrent and out-of-order POSTs from the client.

Parameters:: userId - (required); customActivityEventRequest - (required)
Returns:: Call<Message>

createOrUpdateHealthDataDocumentation

@Headers(value="Content-Type:application/json")
 @POST(value="v3/healthdatadocumentation")
retrofit2.Call<HealthDataDocumentation> createOrUpdateHealthDataDocumentation(@Body
                                                                                                                                                                         HealthDataDocumentation healthDataDocumentation)

Create or update health data documentation.

Parameters:: healthDataDocumentation - Health data documentation submitted by the user (required)
Returns:: Call<HealthDataDocumentation>

createParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants")
retrofit2.Call<IdentifierHolder> createParticipant(@Body
                                                                                                                                   SignUp signUp)

Create a new study participant (user) If the caller is a developer account, then the participant record will automatically be created as a test user (marked with the “test_user” data group).

Parameters:: signUp - Sign up (required)
Returns:: Call<IdentifierHolder>

createStudyParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants")
retrofit2.Call<IdentifierHolder> createStudyParticipant(@Path(value="studyId")
                                                                                                                                                          String studyId,
                                                                                                                                                          @Body
                                                                                                                                                          SignUp signUp)

Create a new study participant who will be enrolled (but not consented) in this study. If the caller is a developer or study designer account, then the participant record will automatically be created as a test user (marked with the “test_user” data group).

Parameters:: studyId - Study identifier (required); signUp - Sign up (required)
Returns:: Call<IdentifierHolder>

createStudyParticipantStudyActivityEvent

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/activityevents")
retrofit2.Call<Message> createStudyParticipantStudyActivityEvent(@Path(value="studyId")
                                                                                                                                                                                           String studyId,
                                                                                                                                                                                           @Path(value="userId")
                                                                                                                                                                                           String userId,
                                                                                                                                                                                           @Body
                                                                                                                                                                                           StudyActivityEventRequest customActivityEventRequest,
                                                                                                                                                                                           @Query(value="showError")
                                                                                                                                                                                           Boolean showError,
                                                                                                                                                                                           @Query(value="updateBursts")
                                                                                                                                                                                           Boolean updateBursts)

Create a new activity event for a participant in this study. Create a new activity event for a participant in this study. A 201 is returned whether the event updates or not, to support concurrent and out-of-order POSTs from the client.

Parameters:: studyId - Study identifier (required); userId - User ID (required); customActivityEventRequest - (required); showError - Return a 400 status if the submission cannot be persisted (optional, default to false); updateBursts - If this event is an originating event for a study burst, update the study burst events (while following their update type rules) (optional, default to true)
Returns:: Call<Message>

deleteAdherenceRecord

@Headers(value="Content-Type:application/json")
 @DELETE(value="v5/studies/{studyId}/participants/{userId}/adherence/{instanceGuid}/{eventTimestamp}/{startedOn}")
retrofit2.Call<Message> deleteAdherenceRecord(@Path(value="studyId")
                                                                                                                                                                                                                 String studyId,
                                                                                                                                                                                                                 @Path(value="userId")
                                                                                                                                                                                                                 String userId,
                                                                                                                                                                                                                 @Path(value="instanceGuid")
                                                                                                                                                                                                                 String instanceGuid,
                                                                                                                                                                                                                 @Path(value="eventTimestamp")
                                                                                                                                                                                                                 DateTime eventTimestamp,
                                                                                                                                                                                                                 @Path(value="startedOn")
                                                                                                                                                                                                                 DateTime startedOn)

Delete an adherence record Delete an existing adherence record

Parameters:: studyId - Study identifier (required); userId - User ID (required); instanceGuid - Instance GUID of the adherence record (required); eventTimestamp - Event timestamp (ISO 8601) of the adherence record (required); startedOn - Starting timestamp (ISO 8601) of the adherence record (required)
Returns:: Call<Message>

deleteDemographic

@Headers(value="Content-Type:application/json")
 @DELETE(value="v5/studies/{studyId}/participants/{userId}/demographics/{demographicId}")
retrofit2.Call<Message> deleteDemographic(@Path(value="studyId")
                                                                                                                                                                                    String studyId,
                                                                                                                                                                                    @Path(value="userId")
                                                                                                                                                                                    String userId,
                                                                                                                                                                                    @Path(value="demographicId")
                                                                                                                                                                                    String demographicId)

Deletes a specific demographic (single category) for a particular user Deletes a specific demographic (single category) for a particular user (study-level, done by researcher or study coordinator)

Parameters:: studyId - Study identifier (required); userId - User ID (required); demographicId - ID of a particular demographic for a specific category associated with a specific user (required)
Returns:: Call<Message>

deleteDemographicUser

@Headers(value="Content-Type:application/json")
 @DELETE(value="v5/studies/{studyId}/participants/{userId}/demographics")
retrofit2.Call<Message> deleteDemographicUser(@Path(value="studyId")
                                                                                                                                                                        String studyId,
                                                                                                                                                                        @Path(value="userId")
                                                                                                                                                                        String userId)

Deletes all of a user's demographics Deletes all of a user's demographics (study-level, done by researcher or study coordinator)

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<Message>

deleteParticipant

@Headers(value="Content-Type:application/json")
 @DELETE(value="v3/participants/{userId}")
retrofit2.Call<Message> deleteParticipant(@Path(value="userId")
                                                                                                                                     String userId)

Delete a study participant if the record has the `test_user` data group, or the account has not been used by the participant (the participant has never signed in to Bridge using the account) and it is only enrolled in one study.

Parameters:: userId - User ID (required)
Returns:: Call<Message>

deleteParticipantActivities
```
@Deprecated
 @Headers(value="Content-Type:application/json")
 @DELETE(value="v3/participants/{userId}/activities")
retrofit2.Call<Message> deleteParticipantActivities(@Path(value="userId")
                                                                                                                                                                       String userId)
```
Deprecated.

Delete all activities for a participant Intended for use in development. Developers may wish to delete an account's scheduled activities in order to see the impact of changes to schedules for a study. Otherwise, activities from the original scheduling will persist until they expire, alongside tasks issued for the newly changed schedule. This endpoint can be called by researchers, and by other administrators for their own account. **This should not be called on production accounts.**

Parameters:

userId - User ID (required)

Returns:

Call<Message>

deleteStudyParticipant

@Headers(value="Content-Type:application/json")
 @DELETE(value="v5/studies/{studyId}/participants/{userId}")
retrofit2.Call<Message> deleteStudyParticipant(@Path(value="studyId")
                                                                                                                                                            String studyId,
                                                                                                                                                            @Path(value="userId")
                                                                                                                                                            String userId)

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<Message>

deleteStudyParticipantStudyActivityEvent

@Headers(value="Content-Type:application/json")
 @DELETE(value="v5/studies/{studyId}/participants/{userId}/activityevents/{eventId}")
retrofit2.Call<Message> deleteStudyParticipantStudyActivityEvent(@Path(value="studyId")
                                                                                                                                                                                                       String studyId,
                                                                                                                                                                                                       @Path(value="userId")
                                                                                                                                                                                                       String userId,
                                                                                                                                                                                                       @Path(value="eventId")
                                                                                                                                                                                                       String eventId,
                                                                                                                                                                                                       @Query(value="showError")
                                                                                                                                                                                                       Boolean showError)

Delete activity event for a study participant if it is mutable.

Parameters:: studyId - Study identifier (required); userId - User ID (required); eventId - An activity event key (required); showError - Return a 400 status if the submission cannot be persisted (optional, default to false)
Returns:: Call<Message>

enrollParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/enrollments")
retrofit2.Call<Enrollment> enrollParticipant(@Path(value="studyId")
                                                                                                                                              String studyId,
                                                                                                                                              @Body
                                                                                                                                              Enrollment enrollment)

Enroll an account in a study as a participant. When enrolling a participant in a study, be sure your process includes informed consent to research. Bridge also supports the delivery of an electronic informed consent process, but you can also opt to enroll someone, with or without a flag that indicates whether or not the user should still be required to go through the informed consent process defined for this study. For example, studies that handle consent prior to onboarding participants my choose to enroll them through this API with `consentRequired` set to false.

Parameters:: studyId - Study identifier (required); enrollment - Enrollment information for this user (required)
Returns:: Call<Enrollment>

generatePassword

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/externalids/{externalId}/password")
retrofit2.Call<GeneratedPassword> generatePassword(@Path(value="externalId")
                                                                                                                                                                     String externalId,
                                                                                                                                                                     @Query(value="createAccount")
                                                                                                                                                                     Boolean createAccount)

Deprecated.

Generate a password for a study participant's account Allows a researcher to generate a password for another account, identified by an external ID, when the app is configured to manage (verify) external IDs. (Developers can also test this functionality against test accounts.) This method should be called from the client so the password can be stored on the device being given to the study participant, usually in lab-based settings.

Parameters:: externalId - User's external ID (required); createAccount - If account has not been created for this external ID, create it (optional, default to true)
Returns:: Call<GeneratedPassword>

getActivityEventsForParticipant

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/activityevents")
retrofit2.Call<ActivityEventList> getActivityEventsForParticipant(@Path(value="userId")
                                                                                                                                                                                      String userId)

Deprecated.

Get activity events mapping for a participant This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - (required)
Returns:: Call<ActivityEventList>

getAdherenceStatistics

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/adherence/stats")
retrofit2.Call<AdherenceStatistics> getAdherenceStatistics(@Path(value="studyId")
                                                                                                                                                               String studyId,
                                                                                                                                                               @Query(value="adherenceThreshold")
                                                                                                                                                               Integer adherenceThreshold)

Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.

Parameters:: studyId - Study identifier (required); adherenceThreshold - The percentage cutoff to use to determine totals of compliant and noncompliant participants. (optional)
Returns:: Call<AdherenceStatistics>

getAllHealthDataDocumentationForParentId

@Headers(value="Content-Type:application/json")
 @GET(value="v3/healthdatadocumentation")
retrofit2.Call<HealthDataDocumentationList> getAllHealthDataDocumentationForParentId(@Query(value="parentId")
                                                                                                                                                                               String parentId,
                                                                                                                                                                               @Query(value="offsetKey")
                                                                                                                                                                               String offsetKey,
                                                                                                                                                                               @Query(value="pageSize")
                                                                                                                                                                               Integer pageSize)

Get all health data documentation by parentId. Gets a list of health data documentation for the given parentId.

Parameters:: parentId - The id used in place of appId, and in the future, studyId. (optional); offsetKey - next page start key for pagination (optional); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<HealthDataDocumentationList>

getDemographicUser

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/demographics")
retrofit2.Call<DemographicUserResponse> getDemographicUser(@Path(value="studyId")
                                                                                                                                                                                  String studyId,
                                                                                                                                                                                  @Path(value="userId")
                                                                                                                                                                                  String userId)

Fetches all demographics for a user Fetches all demographics for a user (study-level, done by researcher/study-coordinator)

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<DemographicUserResponse>

getDemographicUsers

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/demographics")
retrofit2.Call<DemographicUserResponseList> getDemographicUsers(@Path(value="studyId")
                                                                                                                                                                              String studyId,
                                                                                                                                                                              @Query(value="offsetBy")
                                                                                                                                                                              Integer offsetBy,
                                                                                                                                                                              @Query(value="pageSize")
                                                                                                                                                                              Integer pageSize)

Fetches all study-level demographics for all users within a study Fetches all study-level demographics for all users within a study (study-level, done by researcher/study-coordinator)

Parameters:: studyId - Study identifier (required); offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<DemographicUserResponseList>

getDemographicsValidationConfig

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/demographics/validation/{categoryName}")
retrofit2.Call<DemographicValuesValidationConfig> getDemographicsValidationConfig(@Path(value="studyId")
                                                                                                                                                                                                                          String studyId,
                                                                                                                                                                                                                          @Path(value="categoryName")
                                                                                                                                                                                                                          String categoryName)

Fetch a DemographicValuesValidationConfig Fetch an existing DemographicValuesValidationConfig which is used to configure demographics validation.

Parameters:: studyId - Study identifier (required); categoryName - Name of a demographics category. (required)
Returns:: Call<DemographicValuesValidationConfig>

getEnrollments

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/enrollments")
retrofit2.Call<EnrollmentDetailList> getEnrollments(@Path(value="studyId")
                                                                                                                                                    String studyId,
                                                                                                                                                    @Query(value="enrollmentFilter")
                                                                                                                                                    String enrollmentFilter,
                                                                                                                                                    @Query(value="includeTesters")
                                                                                                                                                    Boolean includeTesters,
                                                                                                                                                    @Query(value="offsetBy")
                                                                                                                                                    Integer offsetBy,
                                                                                                                                                    @Query(value="pageSize")
                                                                                                                                                    Integer pageSize)

Get the enrollments in this study. These include participants who have been withdrawn from the study (as we continue to document their historic participation).

Parameters:: studyId - Study identifier (required); enrollmentFilter - Filter enrollees (optional); includeTesters - Include accounts with 'test_user' data group (optional, default to false); offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<EnrollmentDetailList>

getEnrollmentsForUser

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/enrollments")
retrofit2.Call<EnrollmentDetailList> getEnrollmentsForUser(@Path(value="userId")
                                                                                                                                                               String userId)

Get enrollment records for this user

Parameters:: userId - User ID (required)
Returns:: Call<EnrollmentDetailList>

getExternalIdsForStudy

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/externalids")
retrofit2.Call<ExternalIdentifierList> getExternalIdsForStudy(@Path(value="studyId")
                                                                                                                                                              String studyId,
                                                                                                                                                              @Query(value="offsetBy")
                                                                                                                                                              Integer offsetBy,
                                                                                                                                                              @Query(value="pageSize")
                                                                                                                                                              Integer pageSize,
                                                                                                                                                              @Query(value="idFilter")
                                                                                                                                                              String idFilter)

Get external IDs for a study

Parameters:: studyId - Study identifier (required); offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50); idFilter - (optional)
Returns:: Call<ExternalIdentifierList>

getHealthDataDocumentationForId

@Headers(value="Content-Type:application/json")
 @GET(value="v3/healthdatadocumentation/{identifier}")
retrofit2.Call<HealthDataDocumentation> getHealthDataDocumentationForId(@Path(value="identifier")
                                                                                                                                                                               String identifier)

Get a health data documentation with the given identifier This endpoint can be called by researchers and developers to get a specific documentation by identifier.

Parameters:: identifier - identifier (required)
Returns:: Call<HealthDataDocumentation>

getMostRecentSurveys

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/surveys")
retrofit2.Call<SurveyList> getMostRecentSurveys(@Query(value="includeDeleted")
                                                                                                                                       Boolean includeDeleted)

Deprecated.

Get most recent version of each survey

Parameters:: includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<SurveyList>

getMostRecentUploadSchemas

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/uploadschemas")
retrofit2.Call<UploadSchemaList> getMostRecentUploadSchemas(@Query(value="includeDeleted")
                                                                                                                                                         Boolean includeDeleted)

Deprecated.

Get most recent revision of all upload schemas

Parameters:: includeDeleted - Should deleted upload schemas be returned in results? (optional, default to false)
Returns:: Call<UploadSchemaList>

getParticipantActivityHistory

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/activities/{activityGuid}")
retrofit2.Call<ForwardCursorScheduledActivityList> getParticipantActivityHistory(@Path(value="userId")
                                                                                                                                                                                                                String userId,
                                                                                                                                                                                                                @Path(value="activityGuid")
                                                                                                                                                                                                                String activityGuid,
                                                                                                                                                                                                                @Query(value="scheduledOnStart")
                                                                                                                                                                                                                DateTime scheduledOnStart,
                                                                                                                                                                                                                @Query(value="scheduledOnEnd")
                                                                                                                                                                                                                DateTime scheduledOnEnd,
                                                                                                                                                                                                                @Query(value="offsetKey")
                                                                                                                                                                                                                String offsetKey,
                                                                                                                                                                                                                @Query(value="pageSize")
                                                                                                                                                                                                                Integer pageSize)

Deprecated.

Get a study participant's history of activities This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required); activityGuid - Activity GUID (required); scheduledOnStart - Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional); scheduledOnEnd - Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional); offsetKey - next page start key for pagination (optional); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<ForwardCursorScheduledActivityList>

getParticipantByExternalId

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/externalId:{externalId}")
retrofit2.Call<StudyParticipant> getParticipantByExternalId(@Path(value="externalId")
                                                                                                                                                                   String externalId,
                                                                                                                                                                   @Query(value="consents")
                                                                                                                                                                   Boolean consents)

Get a study participant (user) record using the external ID of the account

Parameters:: externalId - User's external ID (required); consents - Should consent histories be included with this participant record? (optional)
Returns:: Call<StudyParticipant>

getParticipantByHealthCode

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/healthCode:{healthCode}")
retrofit2.Call<StudyParticipant> getParticipantByHealthCode(@Path(value="healthCode")
                                                                                                                                                                   String healthCode,
                                                                                                                                                                   @Query(value="consents")
                                                                                                                                                                   Boolean consents)

Get a study participant (user) record using the health code of the account

Parameters:: healthCode - User health code (required); consents - Should consent histories be included with this participant record? (optional)
Returns:: Call<StudyParticipant>

getParticipantById

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}")
retrofit2.Call<StudyParticipant> getParticipantById(@Path(value="userId")
                                                                                                                                            String userId,
                                                                                                                                            @Query(value="consents")
                                                                                                                                            Boolean consents)

Get a study participant (user) record This endpoint can be called by researchers (all authenticated users can retrieve their own StudyParticipant record by using the `getUsersParticipantRecord` method, which should be used by administrative accounts as well, such as developers).

Parameters:: userId - User ID (required); consents - Should consent histories be included with this participant record? (optional)
Returns:: Call<StudyParticipant>

getParticipantCompoundActivityHistory

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/activities/compoundactivities/{taskId}")
retrofit2.Call<ForwardCursorScheduledActivityList> getParticipantCompoundActivityHistory(@Path(value="userId")
                                                                                                                                                                                                                                     String userId,
                                                                                                                                                                                                                                     @Path(value="taskId")
                                                                                                                                                                                                                                     String taskId,
                                                                                                                                                                                                                                     @Query(value="scheduledOnStart")
                                                                                                                                                                                                                                     DateTime scheduledOnStart,
                                                                                                                                                                                                                                     @Query(value="scheduledOnEnd")
                                                                                                                                                                                                                                     DateTime scheduledOnEnd,
                                                                                                                                                                                                                                     @Query(value="offsetKey")
                                                                                                                                                                                                                                     String offsetKey,
                                                                                                                                                                                                                                     @Query(value="pageSize")
                                                                                                                                                                                                                                     Integer pageSize)

Deprecated.

Get a study participant's history of a compound activity This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required); taskId - Task ID (required); scheduledOnStart - Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional); scheduledOnEnd - Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional); offsetKey - next page start key for pagination (optional); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<ForwardCursorScheduledActivityList>

getParticipantPushNotificationRegistrations

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/notifications")
retrofit2.Call<NotificationRegistrationList> getParticipantPushNotificationRegistrations(@Path(value="userId")
                                                                                                                                                                                               String userId)

Get a study participant's push notification registrations Get all of a study participant's registrations for push notifications. There can be more than one of these if the participant has downloaded and installed the app on more than one device. There must be at least one record in order to send a push notification to the user. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required)
Returns:: Call<NotificationRegistrationList>

getParticipantRequestInfo

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/requestInfo")
retrofit2.Call<RequestInfo> getParticipantRequestInfo(@Path(value="userId")
                                                                                                                                                          String userId)

Get information about the last request made by this participant Retrieves information about the user agent headers and participant settings that were in effect the last time this participant contacted the Bridge server. Also provides the last time activities were retrieved and uploads were sent back to the server. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required)
Returns:: Call<RequestInfo>

getParticipantSchedule

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/schedule")
retrofit2.Call<ParticipantSchedule> getParticipantSchedule(@Path(value="studyId")
                                                                                                                                                                              String studyId,
                                                                                                                                                                              @Path(value="userId")
                                                                                                                                                                              String userId)

Get the caller’s scheduled activities in this study.

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<ParticipantSchedule>

getParticipantSurveyHistory

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/activities/surveys/{surveyGuid}")
retrofit2.Call<ForwardCursorScheduledActivityList> getParticipantSurveyHistory(@Path(value="userId")
                                                                                                                                                                                                                    String userId,
                                                                                                                                                                                                                    @Path(value="surveyGuid")
                                                                                                                                                                                                                    String surveyGuid,
                                                                                                                                                                                                                    @Query(value="scheduledOnStart")
                                                                                                                                                                                                                    DateTime scheduledOnStart,
                                                                                                                                                                                                                    @Query(value="scheduledOnEnd")
                                                                                                                                                                                                                    DateTime scheduledOnEnd,
                                                                                                                                                                                                                    @Query(value="offsetKey")
                                                                                                                                                                                                                    String offsetKey,
                                                                                                                                                                                                                    @Query(value="pageSize")
                                                                                                                                                                                                                    Integer pageSize)

Deprecated.

Get a study participant's history of a survey This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required); surveyGuid - Survey GUID (required); scheduledOnStart - Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional); scheduledOnEnd - Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional); offsetKey - next page start key for pagination (optional); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<ForwardCursorScheduledActivityList>

getParticipantTaskHistory

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/activities/tasks/{taskId}")
retrofit2.Call<ForwardCursorScheduledActivityList> getParticipantTaskHistory(@Path(value="userId")
                                                                                                                                                                                                            String userId,
                                                                                                                                                                                                            @Path(value="taskId")
                                                                                                                                                                                                            String taskId,
                                                                                                                                                                                                            @Query(value="scheduledOnStart")
                                                                                                                                                                                                            DateTime scheduledOnStart,
                                                                                                                                                                                                            @Query(value="scheduledOnEnd")
                                                                                                                                                                                                            DateTime scheduledOnEnd,
                                                                                                                                                                                                            @Query(value="offsetKey")
                                                                                                                                                                                                            String offsetKey,
                                                                                                                                                                                                            @Query(value="pageSize")
                                                                                                                                                                                                            Integer pageSize)

Deprecated.

Get a study participant's history of a task This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required); taskId - Task ID (required); scheduledOnStart - Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional); scheduledOnEnd - Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional); offsetKey - next page start key for pagination (optional); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<ForwardCursorScheduledActivityList>

getParticipantUploads

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/uploads")
retrofit2.Call<UploadList> getParticipantUploads(@Path(value="userId")
                                                                                                                                                 String userId,
                                                                                                                                                 @Query(value="startTime")
                                                                                                                                                 DateTime startTime,
                                                                                                                                                 @Query(value="endTime")
                                                                                                                                                 DateTime endTime,
                                                                                                                                                 @Query(value="pageSize")
                                                                                                                                                 Integer pageSize,
                                                                                                                                                 @Query(value="offsetKey")
                                                                                                                                                 String offsetKey)

Get a study participant's upload history Retrieve information about the uploads from a user. This is particularly useful during development to verify the mobile application is sending valid data back to the Bridge server. The API can retrieve any number of days worth of upload records, defined by the startTime and endTime timestamps (ISO 8601 format), and paginated using a pageSize and offsetKey value (null for the first page, but returned with subsequent requests to retrieve further pages in the time range). If the endTime is not provided, it will be one day after the startTime. If the startTime is not provided, it will be one day before the endTime. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required); startTime - (required); endTime - (required); pageSize - maximum number of records in each returned page (optional, default to 50); offsetKey - next page start key for pagination (optional)
Returns:: Call<UploadList>

getParticipants

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants")
retrofit2.Call<AccountSummaryList> getParticipants(@Query(value="offsetBy")
                                                                                                                                  Integer offsetBy,
                                                                                                                                  @Query(value="pageSize")
                                                                                                                                  Integer pageSize,
                                                                                                                                  @Query(value="emailFilter")
                                                                                                                                  String emailFilter,
                                                                                                                                  @Query(value="phoneFilter")
                                                                                                                                  String phoneFilter,
                                                                                                                                  @Query(value="startTime")
                                                                                                                                  DateTime startTime,
                                                                                                                                  @Query(value="endTime")
                                                                                                                                  DateTime endTime)

Get a paged list of study participants (users)

Parameters:: offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50); emailFilter - A string (can be a substring of an email address) to filter returned records against. (optional); phoneFilter - A string (can be a substring of a phone number) to filter returned records against. (optional); startTime - The first day to include in reports that are returned (optional); endTime - The last day to include in reports that are returned (optional)
Returns:: Call<AccountSummaryList>

getSchedulePlans

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/scheduleplans")
retrofit2.Call<SchedulePlanList> getSchedulePlans(@Query(value="includeDeleted")
                                                                                                                                               Boolean includeDeleted)

Deprecated.

Get schedule plans

Parameters:: includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<SchedulePlanList>

getSponsors

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/sponsors")
retrofit2.Call<OrganizationList> getSponsors(@Path(value="studyId")
                                                                                                                                          String studyId,
                                                                                                                                          @Query(value="offsetBy")
                                                                                                                                          Integer offsetBy,
                                                                                                                                          @Query(value="pageSize")
                                                                                                                                          Integer pageSize)

Get the sponsors of this study.

Parameters:: studyId - Study identifier (required); offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<OrganizationList>

getStudies

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies")
retrofit2.Call<StudyList> getStudies(@Query(value="offsetBy")
                                                                                                               Integer offsetBy,
                                                                                                               @Query(value="pageSize")
                                                                                                               Integer pageSize,
                                                                                                               @Query(value="includeDeleted")
                                                                                                               Boolean includeDeleted)

Get a list of the studies in this app

Parameters:: offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50); includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<StudyList>

getStudy

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}")
retrofit2.Call<Study> getStudy(@Path(value="studyId")
                                                                                                                   String studyId)

Get a study Get a study for this app.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Study>

getStudyParticipantAdherenceReport

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/adherence/study")
retrofit2.Call<StudyAdherenceReport> getStudyParticipantAdherenceReport(@Path(value="studyId")
                                                                                                                                                                                                  String studyId,
                                                                                                                                                                                                  @Path(value="userId")
                                                                                                                                                                                                  String userId)

Get a detailed report on a participant’s full schedule of activities.

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<StudyAdherenceReport>

getStudyParticipantById

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}")
retrofit2.Call<StudyParticipant> getStudyParticipantById(@Path(value="studyId")
                                                                                                                                                                   String studyId,
                                                                                                                                                                   @Path(value="userId")
                                                                                                                                                                   String userId,
                                                                                                                                                                   @Query(value="consents")
                                                                                                                                                                   Boolean consents)

Get a study participant.

Parameters:: studyId - Study identifier (required); userId - User ID (required); consents - Should consent histories be included with this participant record? (optional)
Returns:: Call<StudyParticipant>

getStudyParticipantEnrollments

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/enrollments")
retrofit2.Call<EnrollmentDetailList> getStudyParticipantEnrollments(@Path(value="studyId")
                                                                                                                                                                                          String studyId,
                                                                                                                                                                                          @Path(value="userId")
                                                                                                                                                                                          String userId)

Get enrollment records for this user. This endpoint is accessible if the caller can retrieve the participant’s record, and will only include enrollment records for studies that are visible to the caller (through their membership in a sponsoring organization). App-scoped roles (developer, researcher, admin) can see all enrollments.

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<EnrollmentDetailList>

getStudyParticipantEventStreamAdherenceReport

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/adherence/eventstream")
retrofit2.Call<EventStreamAdherenceReport> getStudyParticipantEventStreamAdherenceReport(@Path(value="studyId")
                                                                                                                                                                                                                         String studyId,
                                                                                                                                                                                                                         @Path(value="userId")
                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                         @Query(value="datetime")
                                                                                                                                                                                                                         DateTime datetime,
                                                                                                                                                                                                                         @Query(value="activeOnly")
                                                                                                                                                                                                                         Boolean activeOnly)

Get a detailed report on a participant’s adherence to the entire study protocol’s schedule.

Parameters:: studyId - Study identifier (required); userId - User ID (required); datetime - The timestamp to use as “now” for the calculation of adherence. This timestamp will be adjusted to the participant’s `clientTimeZone` value if this value has been persisted for the participant. (optional, default to The date and time on the server at the time of the request); activeOnly - Only return records that are currently actionable by the participant (optional, default to false)
Returns:: Call<EventStreamAdherenceReport>

getStudyParticipantNotificationRegistrations

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/notifications")
retrofit2.Call<NotificationRegistrationList> getStudyParticipantNotificationRegistrations(@Path(value="studyId")
                                                                                                                                                                                                                  String studyId,
                                                                                                                                                                                                                  @Path(value="userId")
                                                                                                                                                                                                                  String userId)

Get a study participant’s push notification registrations Get all of a study participant’s registrations for push notifications. There can be more than one of these if the participant has downloaded and installed the app on more than one device. There must be at least one record in order to send a push notification to the user. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<NotificationRegistrationList>

getStudyParticipantRequestInfo

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/requestInfo")
retrofit2.Call<RequestInfo> getStudyParticipantRequestInfo(@Path(value="studyId")
                                                                                                                                                                                 String studyId,
                                                                                                                                                                                 @Path(value="userId")
                                                                                                                                                                                 String userId)

Get information about the last request made by this participant

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<RequestInfo>

getStudyParticipantStudyActivityEventHistory

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/activityevents/{eventId}")
retrofit2.Call<StudyActivityEventPagedList> getStudyParticipantStudyActivityEventHistory(@Path(value="studyId")
                                                                                                                                                                                                                            String studyId,
                                                                                                                                                                                                                            @Path(value="userId")
                                                                                                                                                                                                                            String userId,
                                                                                                                                                                                                                            @Path(value="eventId")
                                                                                                                                                                                                                            String eventId,
                                                                                                                                                                                                                            @Query(value="offsetBy")
                                                                                                                                                                                                                            Integer offsetBy,
                                                                                                                                                                                                                            @Query(value="pageSize")
                                                                                                                                                                                                                            Integer pageSize)

Get the history of past timestamps for this event (for the caller).

Parameters:: studyId - Study identifier (required); userId - User ID (required); eventId - An activity event key (required); offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<StudyActivityEventPagedList>

getStudyParticipantStudyActivityEvents

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/activityevents")
retrofit2.Call<StudyActivityEventList> getStudyParticipantStudyActivityEvents(@Path(value="studyId")
                                                                                                                                                                                                       String studyId,
                                                                                                                                                                                                       @Path(value="userId")
                                                                                                                                                                                                       String userId)

Get activity events for the participants

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<StudyActivityEventList>

getStudyParticipantTimeline

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/timeline")
retrofit2.Call<Timeline> getStudyParticipantTimeline(@Path(value="studyId")
                                                                                                                                                                        String studyId,
                                                                                                                                                                        @Path(value="userId")
                                                                                                                                                                        String userId)

Get the timeline that is being assigned to the specific study participant. (Currently all users in a study are assigned the same timeline, but this will change with the introduction of study arms.)

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<Timeline>

getStudyParticipantUploads

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/uploads")
retrofit2.Call<UploadList> getStudyParticipantUploads(@Path(value="studyId")
                                                                                                                                                                        String studyId,
                                                                                                                                                                        @Path(value="userId")
                                                                                                                                                                        String userId,
                                                                                                                                                                        @Query(value="startTime")
                                                                                                                                                                        DateTime startTime,
                                                                                                                                                                        @Query(value="endTime")
                                                                                                                                                                        DateTime endTime,
                                                                                                                                                                        @Query(value="pageSize")
                                                                                                                                                                        Integer pageSize,
                                                                                                                                                                        @Query(value="offsetKey")
                                                                                                                                                                        String offsetKey)

Get a study participant’s upload history Retrieve information about the uploads from a user. This is particularly useful during development to verify the mobile application is sending valid data back to the Bridge server. The API can retrieve any number of days worth of upload records, defined by the startTime and endTime timestamps (ISO 8601 format), and paginated using a pageSize and offsetKey value (null for the first page, but returned with subsequent requests to retrieve further pages in the time range). If the endTime is not provided, it will be one day after the startTime. If the startTime is not provided, it will be one day before the endTime.

Parameters:: studyId - Study identifier (required); userId - User ID (required); startTime - (required); endTime - (required); pageSize - maximum number of records in each returned page (optional, default to 50); offsetKey - next page start key for pagination (optional)
Returns:: Call<UploadList>

getStudyParticipants

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/search")
retrofit2.Call<AccountSummaryList> getStudyParticipants(@Path(value="studyId")
                                                                                                                                                                 String studyId,
                                                                                                                                                                 @Body
                                                                                                                                                                 AccountSummarySearch accountSummarySearch)

Search for account summaries of study participants. For developers and study designers, this API only returns test accounts (accounts marked with the “test_user” data group).

Parameters:: studyId - Study identifier (required); accountSummarySearch - Account summary search parameters (required)
Returns:: Call<AccountSummaryList>

getStudyReportIndex

@Headers(value="Content-Type:application/json")
 @GET(value="v3/reports/{identifier}/index")
retrofit2.Call<ReportIndex> getStudyReportIndex(@Path(value="identifier")
                                                                                                                                             String identifier)

Get a report index Get the index (or metadata) for a set of report records. The caller must be authenticated to retrieve indices.

Parameters:: identifier - identifier (required)
Returns:: Call<ReportIndex>

getSubpopulation

@Headers(value="Content-Type:application/json")
 @GET(value="v3/subpopulations/{subpopulationGuid}")
retrofit2.Call<Subpopulation> getSubpopulation(@Path(value="subpopulationGuid")
                                                                                                                                                    String subpopulationGuid)

Get a subpopulation

Parameters:: subpopulationGuid - Subpopulation GUID (required)
Returns:: Call<Subpopulation>

getUploadStatus

@Headers(value="Content-Type:application/json")
 @GET(value="v3/uploadstatuses/{uploadId}")
retrofit2.Call<UploadValidationStatus> getUploadStatus(@Path(value="uploadId")
                                                                                                                                                   String uploadId)

Get status of a single upload attempt Caller must either be a participant getting a status of one of the participant's own uploads, or a reearcher.

Parameters:: uploadId - Upload ID (required)
Returns:: Call<UploadValidationStatus>

getUsersApp

@Headers(value="Content-Type:application/json")
 @GET(value="v1/apps/self")
retrofit2.Call<App> getUsersApp()

Get an app Get the app of the currently signed in user account.

Returns:: Call<App>

getUsersParticipantReportRecords

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/reports/{identifier}")
retrofit2.Call<ReportDataList> getUsersParticipantReportRecords(@Path(value="userId")
                                                                                                                                                                             String userId,
                                                                                                                                                                             @Path(value="identifier")
                                                                                                                                                                             String identifier,
                                                                                                                                                                             @Query(value="startDate")
                                                                                                                                                                             LocalDate startDate,
                                                                                                                                                                             @Query(value="endDate")
                                                                                                                                                                             LocalDate endDate)

Get participant report records The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.

Parameters:: userId - User ID (required); identifier - identifier (required); startDate - The first day to include in reports that are returned (required); endDate - The last day to include in reports that are returned (required)
Returns:: Call<ReportDataList>

getUsersParticipantReportRecordsV4

@Headers(value="Content-Type:application/json")
 @GET(value="v4/participants/{userId}/reports/{identifier}")
retrofit2.Call<ForwardCursorReportDataList> getUsersParticipantReportRecordsV4(@Path(value="userId")
                                                                                                                                                                                            String userId,
                                                                                                                                                                                            @Path(value="identifier")
                                                                                                                                                                                            String identifier,
                                                                                                                                                                                            @Query(value="startTime")
                                                                                                                                                                                            DateTime startTime,
                                                                                                                                                                                            @Query(value="endTime")
                                                                                                                                                                                            DateTime endTime,
                                                                                                                                                                                            @Query(value="offsetKey")
                                                                                                                                                                                            String offsetKey,
                                                                                                                                                                                            @Query(value="pageSize")
                                                                                                                                                                                            Integer pageSize)

Parameters:: userId - User ID (required); identifier - identifier (required); startTime - (required); endTime - (required); offsetKey - next page start key for pagination (optional); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<ForwardCursorReportDataList>

getWeeklyAdherenceReport

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/adherence/weekly")
retrofit2.Call<WeeklyAdherenceReport> getWeeklyAdherenceReport(@Path(value="studyId")
                                                                                                                                                                                          String studyId,
                                                                                                                                                                                          @Path(value="userId")
                                                                                                                                                                                          String userId)

Get a detailed report on a participant’s current week of scheduled activities.

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<WeeklyAdherenceReport>

getWeeklyAdherenceReports

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/adherence/weekly")
retrofit2.Call<WeeklyAdherenceReportList> getWeeklyAdherenceReports(@Path(value="studyId")
                                                                                                                                                                          String studyId,
                                                                                                                                                                          @Body
                                                                                                                                                                          AdherenceReportSearch adherenceReportSearch)

Get the adherence for all study participants in their current week of the study.

Parameters:: studyId - Study identifier (required); adherenceReportSearch - Search parameters for weekly adherence report (required)
Returns:: Call<WeeklyAdherenceReportList>

requestParticipantRoster

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/emailRoster")
retrofit2.Call<Message> requestParticipantRoster(@Body
                                                                                                                                             ParticipantRosterRequest participantRosterRequest)

Request a roster of participants within an app, and optionally within a study if a studyId is provided.

Parameters:: participantRosterRequest - (required)
Returns:: Call<Message>

resendParticipantConsentAgreement

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/consents/{subpopulationGuid}/resendConsent")
retrofit2.Call<Message> resendParticipantConsentAgreement(@Path(value="userId")
                                                                                                                                                                                              String userId,
                                                                                                                                                                                              @Path(value="subpopulationGuid")
                                                                                                                                                                                              String subpopulationGuid)

Re-send the consent agreement for this subpopulation When called, re-sends a signed consent agreement document to the participant's email address. This endpoint can be called by researchers, and by other administrators for their own account. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required); subpopulationGuid - Subpopulation GUID (required)
Returns:: Call<Message>

resendStudyParticipantConsentAgreement

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/consents/{guid}/resendConsent")
retrofit2.Call<Message> resendStudyParticipantConsentAgreement(@Path(value="studyId")
                                                                                                                                                                                                        String studyId,
                                                                                                                                                                                                        @Path(value="userId")
                                                                                                                                                                                                        String userId,
                                                                                                                                                                                                        @Path(value="guid")
                                                                                                                                                                                                        String guid)

Re-send the consent agreement for this study When called, re-sends a signed consent agreement document to the participant’s email address. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: studyId - Study identifier (required); userId - User ID (required); guid - A guid (required)
Returns:: Call<Message>

saveDemographicUser

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/demographics")
retrofit2.Call<DemographicUserResponse> saveDemographicUser(@Path(value="studyId")
                                                                                                                                                                                    String studyId,
                                                                                                                                                                                    @Path(value="userId")
                                                                                                                                                                                    String userId,
                                                                                                                                                                                    @Body
                                                                                                                                                                                    DemographicUser demographicUser)

Save/overwrite all demographics for a user Save/overwrite all demographics for a user (study-level, posted on the user's behalf by researcher, study coordinator)

Parameters:: studyId - Study identifier (required); userId - User ID (required); demographicUser - (required)
Returns:: Call<DemographicUserResponse>

saveDemographicUserAssessment

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/demographics/assessment")
retrofit2.Call<DemographicUserResponse> saveDemographicUserAssessment(@Path(value="studyId")
                                                                                                                                                                                                         String studyId,
                                                                                                                                                                                                         @Path(value="userId")
                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                         @Body
                                                                                                                                                                                                         DemographicUserAssessment demographicUserAssessment)

Save/overwrite all demographics for a user Save/overwrite all demographics for a user (study-level, posted on the user's behalf by researcher, study coordinator), uses the assessment JSON model

Parameters:: studyId - Study identifier (required); userId - User ID (required); demographicUserAssessment - (required)
Returns:: Call<DemographicUserResponse>

searchAccountSummaries

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/search")
retrofit2.Call<AccountSummaryList> searchAccountSummaries(@Body
                                                                                                                                                 AccountSummarySearch accountSummarySearch)

Search for account summaries (participants) For developers, this API only returns test accounts (accounts marked with the “test_user” data group).

Parameters:: accountSummarySearch - Account summary search parameters (required)
Returns:: Call<AccountSummaryList>

searchForStudyParticipantAdherenceRecords

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/adherence/search")
retrofit2.Call<AdherenceRecordList> searchForStudyParticipantAdherenceRecords(@Path(value="studyId")
                                                                                                                                                                                                          String studyId,
                                                                                                                                                                                                          @Path(value="userId")
                                                                                                                                                                                                          String userId,
                                                                                                                                                                                                          @Body
                                                                                                                                                                                                          AdherenceRecordsSearch adherenceRecordsSearch)

Search for adherence records.

Parameters:: studyId - Study identifier (required); userId - User ID (required); adherenceRecordsSearch - The search criteria. (required)
Returns:: Call<AdherenceRecordList>

sendInstallLinkMessage
```
@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/sendInstallLink")
retrofit2.Call<Message> sendInstallLinkMessage(@Path(value="userId")
                                                                                                                                                        String userId)
```
Send a message (SMS or email) to a participant explaining how to download and install the app When called, sends either an SMS message or an email message (depending on whether the account has a verified email address or phone number. If both are present, it sends an SMS message. The message uses the \"install app\" templates for email and SMS. If the user account has neither a verified email address or phone number, this call will fail and return 400. This call can also return 400 if no install links have been configured for the app on the Bridge server.

Parameters:

userId - User ID (required)

Returns:

Call<Message>

sendNotificationToParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/sendNotification")
retrofit2.Call<Message> sendNotificationToParticipant(@Path(value="userId")
                                                                                                                                                                String userId,
                                                                                                                                                                @Body
                                                                                                                                                                NotificationMessage notificationMessage)

Send a push notification to a single participant Send a push notification to an individual participant (assuming they have registered for push notifications). Do not use this method to notify a group of participants; create a topic, ask your users to subscribe to that topic, and send a message via that topic instead.

Parameters:: userId - User ID (required); notificationMessage - (required)
Returns:: Call<Message>

sendParticipantEmailVerification

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/resendEmailVerification")
retrofit2.Call<Message> sendParticipantEmailVerification(@Path(value="userId")
                                                                                                                                                                          String userId)

Resend an email verification email to this user When called, resends the email to the user's email account, which contains a link they must click on to verify they control that email address. Account is not activated until this is done. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required)
Returns:: Call<Message>

sendParticipantPhoneVerification

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/resendPhoneVerification")
retrofit2.Call<Message> sendParticipantPhoneVerification(@Path(value="userId")
                                                                                                                                                                          String userId)

Resend a phone verification to this user When called, resends the SMS message to the user's email account, which contains a code they must enter into your application to call and verify this phone number. Account is not activated until this is done. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required)
Returns:: Call<Message>

sendParticipantResetPassword
```
@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/requestResetPassword")
retrofit2.Call<Message> sendParticipantResetPassword(@Path(value="userId")
                                                                                                                                                                   String userId)
```
Trigger a request to reset password for this user When called, a reset password message will be sent to either the email address or the phone number for this account (preferencing the email address). The user account does not have to be active for a researcher to trigger a reset password message on their behalf. The act of resetting the password successfully will activate the account and verify the credential used to send the reset token (email address or phone number). This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:

userId - User ID (required)

Returns:

Call<Message>

sendStudyParticipantEmailVerification

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/resendEmailVerification")
retrofit2.Call<Message> sendStudyParticipantEmailVerification(@Path(value="studyId")
                                                                                                                                                                                                 String studyId,
                                                                                                                                                                                                 @Path(value="userId")
                                                                                                                                                                                                 String userId)

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<Message>

sendStudyParticipantNotification

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/sendNotification")
retrofit2.Call<Message> sendStudyParticipantNotification(@Path(value="studyId")
                                                                                                                                                                                     String studyId,
                                                                                                                                                                                     @Path(value="userId")
                                                                                                                                                                                     String userId,
                                                                                                                                                                                     @Body
                                                                                                                                                                                     NotificationMessage notificationMessage)

Parameters:: studyId - Study identifier (required); userId - User ID (required); notificationMessage - (required)
Returns:: Call<Message>

sendStudyParticipantPhoneVerification

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/resendPhoneVerification")
retrofit2.Call<Message> sendStudyParticipantPhoneVerification(@Path(value="studyId")
                                                                                                                                                                                                 String studyId,
                                                                                                                                                                                                 @Path(value="userId")
                                                                                                                                                                                                 String userId)

Resend a phone verification to this user When called, resends the SMS message to the user’s email account, which contains a code they must enter into your application to call and verify this phone number. Account is not activated until this is done.

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<Message>

sendStudyParticipantResetPassword

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/requestResetPassword")
retrofit2.Call<Message> sendStudyParticipantResetPassword(@Path(value="studyId")
                                                                                                                                                                                          String studyId,
                                                                                                                                                                                          @Path(value="userId")
                                                                                                                                                                                          String userId)

Trigger a request to reset password for this user When called, a reset password message will be sent to either the email address or the phone number for this account (with a preference for the email address). The user account does not have to be active for a researcher to trigger a reset password message on their behalf. The act of resetting the password successfully will activate the account and verify the credential used to send the reset token (email address or phone number).

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<Message>

signOutParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/signOut")
retrofit2.Call<Message> signOutParticipant(@Path(value="userId")
                                                                                                                                            String userId,
                                                                                                                                            @Query(value="deleteReauthToken")
                                                                                                                                            Boolean deleteReauthToken)

Sign the user out and delete their server session This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required); deleteReauthToken - Should sign out also delete any extant reauthentication tokens? (optional, default to true)
Returns:: Call<Message>

signOutStudyParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/signOut")
retrofit2.Call<Message> signOutStudyParticipant(@Path(value="studyId")
                                                                                                                                                                   String studyId,
                                                                                                                                                                   @Path(value="userId")
                                                                                                                                                                   String userId,
                                                                                                                                                                   @Query(value="deleteReauthToken")
                                                                                                                                                                   Boolean deleteReauthToken)

Sign the participant out and delete their server session

Parameters:: studyId - Study identifier (required); userId - User ID (required); deleteReauthToken - Should sign out also delete any extant reauthentication tokens? (optional, default to true)
Returns:: Call<Message>

transitionStudyToAnalysis

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/analyze")
retrofit2.Call<Study> transitionStudyToAnalysis(@Path(value="studyId")
                                                                                                                                             String studyId)

Transition a study’s phase to “analysis.” This can only be done with a study that is currently “in flight.”

Parameters:: studyId - Study identifier (required)
Returns:: Call<Study>

transitionStudyToCompleted

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/complete")
retrofit2.Call<Study> transitionStudyToCompleted(@Path(value="studyId")
                                                                                                                                               String studyId)

Transition a study’s phase to “completed.” This can only be done with a study that is currently in the “analysis” phase.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Study>

transitionStudyToDesign

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/design")
retrofit2.Call<Study> transitionStudyToDesign(@Path(value="studyId")
                                                                                                                                          String studyId)

Transition a study’s phase to “design.” This can only be done with a study that is currently in the “legacy” phase.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Study>

transitionStudyToInFlight

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/conduct")
retrofit2.Call<Study> transitionStudyToInFlight(@Path(value="studyId")
                                                                                                                                             String studyId)

Transition a study’s phase to “in flight.” This can only be done with a study that is currently in the “recruitment” phase.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Study>

transitionStudyToRecruitment

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/recruit")
retrofit2.Call<Study> transitionStudyToRecruitment(@Path(value="studyId")
                                                                                                                                                String studyId)

Transition a study’s phase to “recruitment.” This can only be done with a study that is currently in the “design” phase.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Study>

transitionStudyToWithdrawn

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/withdraw")
retrofit2.Call<Study> transitionStudyToWithdrawn(@Path(value="studyId")
                                                                                                                                               String studyId)

Transition a study’s phase to “withdrawn.” This can be done with a study that is currently in “design,” “recruitment,” “in flight,” or “analysis” phases.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Study>

updateEnrollment

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/enrollments/{userId}")
retrofit2.Call<Message> updateEnrollment(@Path(value="studyId")
                                                                                                                                                   String studyId,
                                                                                                                                                   @Path(value="userId")
                                                                                                                                                   String userId,
                                                                                                                                                   @Body
                                                                                                                                                   Enrollment enrollment)

Update a participant's enrollment record for a study Developers and Study Designers can only update test accounts.

Parameters:: studyId - Study identifier (required); userId - User ID (required); enrollment - Updated enrollment (required)
Returns:: Call<Message>

updateParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}")
retrofit2.Call<Message> updateParticipant(@Path(value="userId")
                                                                                                                                   String userId,
                                                                                                                                   @Body
                                                                                                                                   StudyParticipant studyParticipant)

Update an existing study participant (user) record This endpoint can be called by researchers, and by other administrators for their own account account.

Parameters:: userId - User ID (required); studyParticipant - Study participant (required)
Returns:: Call<Message>

updateStudyParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}")
retrofit2.Call<Message> updateStudyParticipant(@Path(value="studyId")
                                                                                                                                                          String studyId,
                                                                                                                                                          @Path(value="userId")
                                                                                                                                                          String userId,
                                                                                                                                                          @Body
                                                                                                                                                          StudyParticipant studyParticipant)

Update an existing study participant (user) record

Parameters:: studyId - Study identifier (required); userId - User ID (required); studyParticipant - Study participant (required)
Returns:: Call<Message>

updateStudyParticipantAdherenceRecords

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/adherence")
retrofit2.Call<Message> updateStudyParticipantAdherenceRecords(@Path(value="studyId")
                                                                                                                                                                                    String studyId,
                                                                                                                                                                                    @Path(value="userId")
                                                                                                                                                                                    String userId,
                                                                                                                                                                                    @Body
                                                                                                                                                                                    AdherenceRecordUpdates adherenceRecordUpdates)

Update one or more adherence records for a participant

Parameters:: studyId - Study identifier (required); userId - User ID (required); adherenceRecordUpdates - One ore more adherence records (required)
Returns:: Call<Message>

updateUsersApp

@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/self")
retrofit2.Call<VersionHolder> updateUsersApp(@Body
                                                                                                                          App app)

Update an app Update the app of the currently signed in developer account. This API only works for Developers (administrators should use the ForAdminsApi.updateApp() API).

Parameters:: app - (required)
Returns:: Call<VersionHolder>

withdrawParticipant

@Headers(value="Content-Type:application/json")
 @DELETE(value="v5/studies/{studyId}/enrollments/{userId}")
retrofit2.Call<Enrollment> withdrawParticipant(@Path(value="studyId")
                                                                                                                                                           String studyId,
                                                                                                                                                           @Path(value="userId")
                                                                                                                                                           String userId,
                                                                                                                                                           @Query(value="withdrawalNote")
                                                                                                                                                           String withdrawalNote)

Withdraw a participant from the study

Parameters:: studyId - Study identifier (required); userId - User ID (required); withdrawalNote - The reason given for a user’s withdrawal from a study. (optional)
Returns:: Call<Enrollment>

withdrawParticipantFromApp

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/consents/withdraw")
retrofit2.Call<Message> withdrawParticipantFromApp(@Path(value="userId")
                                                                                                                                                              String userId,
                                                                                                                                                              @Body
                                                                                                                                                              Withdrawal withdrawal)

Withdraw the participant from all studies in this app Withdraw the user entirely from all studies in this app. The user is withdraw from all consents, no further data will be exported from Bridge, the device will be unregistered from any push notifications, and the account's identifiers (email, phone number, and external ID) will be deleted. The account remains to verify the consent history for a given health code. The app consent administration email will receive a notification of the withdrawal. This withdrawal cannot be reversed. If the user signs up again with the app, a new account under a new `healthCode` will be generated. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required); withdrawal - (required)
Returns:: Call<Message>

withdrawParticipantFromSubpopulation

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/consents/{subpopulationGuid}/withdraw")
retrofit2.Call<Message> withdrawParticipantFromSubpopulation(@Path(value="userId")
                                                                                                                                                                                            String userId,
                                                                                                                                                                                            @Path(value="subpopulationGuid")
                                                                                                                                                                                            String subpopulationGuid,
                                                                                                                                                                                            @Body
                                                                                                                                                                                            Withdrawal withdrawal)

Withdraw the participant from the specified subpopulation This endpoint will withdraw the user from consent to participate in one subpopulation of the app. This endpoint can be called by researchers, and by other administrators for their own account.

Parameters:: userId - User ID (required); subpopulationGuid - Subpopulation GUID (required); withdrawal - (required)
Returns:: Call<Message>

Interface ForResearchersApi

Method Summary

Method Detail

createActivityEventForParticipant

createOrUpdateHealthDataDocumentation

createParticipant

createStudyParticipant

createStudyParticipantStudyActivityEvent

deleteAdherenceRecord

deleteDemographic

deleteDemographicUser

deleteParticipant

deleteParticipantActivities

deleteStudyParticipant

deleteStudyParticipantStudyActivityEvent

enrollParticipant

generatePassword

getActivityEventsForParticipant

getAdherenceStatistics

getAllHealthDataDocumentationForParentId

getDemographicUser

getDemographicUsers

getDemographicsValidationConfig

getEnrollments

getEnrollmentsForUser

getExternalIdsForStudy

getHealthDataDocumentationForId

getMostRecentSurveys

getMostRecentUploadSchemas

getParticipantActivityHistory

getParticipantByExternalId

getParticipantByHealthCode

getParticipantById

getParticipantCompoundActivityHistory

getParticipantPushNotificationRegistrations

getParticipantRequestInfo

getParticipantSchedule

getParticipantSurveyHistory

getParticipantTaskHistory

getParticipantUploads

getParticipants

getSchedulePlans

getSponsors

getStudies

getStudy

getStudyParticipantAdherenceReport

getStudyParticipantById

getStudyParticipantEnrollments

getStudyParticipantEventStreamAdherenceReport

getStudyParticipantNotificationRegistrations

getStudyParticipantRequestInfo

getStudyParticipantStudyActivityEventHistory

getStudyParticipantStudyActivityEvents

getStudyParticipantTimeline

getStudyParticipantUploads

getStudyParticipants

getStudyReportIndex

getSubpopulation

getUploadStatus

getUsersApp

getUsersParticipantReportRecords

getUsersParticipantReportRecordsV4

getWeeklyAdherenceReport

getWeeklyAdherenceReports

requestParticipantRoster

resendParticipantConsentAgreement

resendStudyParticipantConsentAgreement

saveDemographicUser

saveDemographicUserAssessment

searchAccountSummaries

searchForStudyParticipantAdherenceRecords

sendInstallLinkMessage

sendNotificationToParticipant

sendParticipantEmailVerification

sendParticipantPhoneVerification

sendParticipantResetPassword

sendStudyParticipantEmailVerification

sendStudyParticipantNotification

sendStudyParticipantPhoneVerification

sendStudyParticipantResetPassword