public interface StudyParticipantsApi
| Modifier and Type | Method and Description |
|---|---|
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> |
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> |
deleteDemographicsValidationConfig(String studyId,
String categoryName)
Delete a DemographicValuesValidationConfig
Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation.
|
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> |
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> |
deleteStudyParticipantReport(String studyId,
String userId,
String identifier)
Delete all records for a report for one member of the study.
|
retrofit2.Call<Message> |
deleteStudyParticipantReportIndex(String studyId,
String identifier)
Delete a single report index (note that deleting an index in effect makes all report records under that identifier less accessible...the reports are not deleted, but they are not listed in the indices, either).
|
retrofit2.Call<Message> |
deleteStudyParticipantReportRecord(String studyId,
String userId,
String identifier,
DateTime date)
Delete one record for a report for one member of the 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<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<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<ExternalIdentifierList> |
getExternalIdsForStudy(String studyId,
Integer offsetBy,
Integer pageSize,
String idFilter)
Get external IDs for a study
|
retrofit2.Call<ParticipantSchedule> |
getParticipantSchedule(String studyId,
String userId)
Get the caller’s scheduled activities in this study.
|
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<ForwardCursorReportDataList> |
getStudyParticipantReport(String studyId,
String userId,
String identifier,
DateTime startTime,
DateTime endTime,
String offsetKey,
Integer pageSize)
Get a series of report records for a specific date and time range (this API uses dates and times and not just dates; use a standard time of day portion like “T00:00:00.000Z” if a time portion is unnecessary, being sure to create and retrieve records with the same set time).
|
retrofit2.Call<ReportIndex> |
getStudyParticipantReportIndex(String studyId,
String identifier)
Get a single report index with some additional metadata about the report series.
|
retrofit2.Call<ReportIndexList> |
getStudyParticipantReportIndices(String studyId)
Get the indices (identifiers) of all the reports available for participants in the given study.
|
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<EventStreamAdherenceReport> |
getUsersStudyParticipantEventStreamAdherenceReport(String studyId,
DateTime datetime,
Boolean activeOnly)
Get a detailed report on the caller’s adherence to the entire study protocol’s schedule.
|
retrofit2.Call<ForwardCursorReportDataList> |
getUsersStudyParticipantReport(String studyId,
String identifier,
DateTime startTime,
DateTime endTime,
String offsetKey,
Integer pageSize)
Get a series of report records for a specific date and time range for the caller (this API uses dates and times and not just dates; use a standard time of day portion like “T00:00:00.000Z” if a time portion is unnecessary, being sure to create and retrieve records with the same set time).
|
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> |
requestStudyParticipantRoster(String studyId,
ParticipantRosterRequest participantRosterRequest)
Request a roster of participants for a specific study.
|
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<DemographicValuesValidationConfig> |
saveDemographicsValidationConfig(String studyId,
String categoryName,
DemographicValuesValidationConfig demographicValuesValidationConfig)
Save a DemographicValuesValidationConfig
Save a DemographicValuesValidationConfig to configure demographics validation.
|
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<DemographicUserResponse> |
saveDemographicUserSelf(String studyId,
DemographicUser demographicUser)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (study-level, posted by the user)
|
retrofit2.Call<DemographicUserResponse> |
saveDemographicUserSelfAssessment(String studyId,
DemographicUserAssessment demographicUser)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (study-level, posted by the user), uses the assessment JSON model
|
retrofit2.Call<Message> |
saveStudyParticipantReportRecord(String studyId,
String userId,
String identifier,
ReportData reportData)
Add a participant report for a single date and time (this API uses dates and times and not just dates; use a standard time of day portion like “T00:00:00.000Z” if a time portion is unnecessary, being sure to create and retrieve records with the same set time).
|
retrofit2.Call<Message> |
saveUsersStudyParticipantReportRecord(String studyId,
String identifier,
ReportData reportData)
Add a participant report for a single date and time for the caller (this API uses dates and times and not just dates; use a standard time of day portion like “T00:00:00.000Z” if a time portion is unnecessary, being sure to create and retrieve records with the same set time).
|
retrofit2.Call<AdherenceRecordList> |
searchForStudyParticipantAdherenceRecords(String studyId,
String userId,
AdherenceRecordsSearch adherenceRecordsSearch)
Search for adherence records.
|
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> |
sendStudyParticipantInstallLinkMessage(String studyId,
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> |
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> |
signOutStudyParticipant(String studyId,
String userId,
Boolean deleteReauthToken)
Sign the participant out and delete their server session
|
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> |
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<Enrollment> |
withdrawParticipant(String studyId,
String userId,
String withdrawalNote)
Withdraw a participant from the study
|
@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants")
retrofit2.Call<IdentifierHolder> createStudyParticipant(@Path(value="studyId")
String studyId,
@Body
SignUp signUp)
studyId - Study identifier (required)signUp - Sign up (required)@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)
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)@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)
studyId - Study identifier (required)userId - User ID (required)demographicId - ID of a particular demographic for a specific category associated with a specific user (required)@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)
studyId - Study identifier (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}/participants/demographics/validation/{categoryName}")
retrofit2.Call<Message> deleteDemographicsValidationConfig(@Path(value="studyId")
String studyId,
@Path(value="categoryName")
String categoryName)
studyId - Study identifier (required)categoryName - Name of a demographics category. (required)@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)
studyId - Study identifier (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}/participants/{userId}/reports/{identifier}")
retrofit2.Call<Message> deleteStudyParticipantReport(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier)
studyId - Study identifier (required)userId - User ID (required)identifier - identifier (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}/participants/reports/{identifier}")
retrofit2.Call<Message> deleteStudyParticipantReportIndex(@Path(value="studyId")
String studyId,
@Path(value="identifier")
String identifier)
studyId - Study identifier (required)identifier - identifier (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}/participants/{userId}/reports/{identifier}/{date}")
retrofit2.Call<Message> deleteStudyParticipantReportRecord(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier,
@Path(value="date")
DateTime date)
studyId - Study identifier (required)userId - User ID (required)identifier - identifier (required)date - The date and time of the record to delete (required)@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)
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)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/enrollments")
retrofit2.Call<Enrollment> enrollParticipant(@Path(value="studyId")
String studyId,
@Body
Enrollment enrollment)
studyId - Study identifier (required)enrollment - Enrollment information for this user (required)@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)
studyId - Study identifier (required)adherenceThreshold - The percentage cutoff to use to determine totals of compliant and noncompliant participants. (optional)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
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)@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)
studyId - Study identifier (required)categoryName - Name of a demographics category. (required)@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)
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)@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)
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)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
studyId - Study identifier (required)userId - User ID (required)consents - Should consent histories be included with this participant record? (optional)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
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)@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)
studyId - Study identifier (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/{userId}/reports/{identifier}")
retrofit2.Call<ForwardCursorReportDataList> getStudyParticipantReport(@Path(value="studyId")
String studyId,
@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)
studyId - Study identifier (required)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)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/reports/{identifier}")
retrofit2.Call<ReportIndex> getStudyParticipantReportIndex(@Path(value="studyId")
String studyId,
@Path(value="identifier")
String identifier)
studyId - Study identifier (required)identifier - identifier (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/reports")
retrofit2.Call<ReportIndexList> getStudyParticipantReportIndices(@Path(value="studyId")
String studyId)
studyId - Study identifier (required)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
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)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
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)@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)
studyId - Study identifier (required)accountSummarySearch - Account summary search parameters (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/self/adherence/eventstream")
retrofit2.Call<EventStreamAdherenceReport> getUsersStudyParticipantEventStreamAdherenceReport(@Path(value="studyId")
String studyId,
@Query(value="datetime")
DateTime datetime,
@Query(value="activeOnly")
Boolean activeOnly)
studyId - Study identifier (required)datetime - The timestamp to use as “now” for the calculation of adherence. This timestamp will be adjusted to the caller’s `clientTimeZone` value if this value has been persisted. (optional, default to The date and time on the server at the time of the request)activeOnly - Only return records that are currently active and actionable for the participant. (optional, default to false)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/self/reports/{identifier}")
retrofit2.Call<ForwardCursorReportDataList> getUsersStudyParticipantReport(@Path(value="studyId")
String studyId,
@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)
studyId - Study identifier (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)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
studyId - Study identifier (required)adherenceReportSearch - Search parameters for weekly adherence report (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/emailRoster")
retrofit2.Call<Message> requestStudyParticipantRoster(@Path(value="studyId")
String studyId,
@Body
ParticipantRosterRequest participantRosterRequest)
studyId - Study identifier (required)participantRosterRequest - Account summary search parameters (required)@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)
studyId - Study identifier (required)userId - User ID (required)guid - A guid (required)@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)
studyId - Study identifier (required)userId - User ID (required)demographicUser - (required)@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)
studyId - Study identifier (required)userId - User ID (required)demographicUserAssessment - (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/self/demographics")
retrofit2.Call<DemographicUserResponse> saveDemographicUserSelf(@Path(value="studyId")
String studyId,
@Body
DemographicUser demographicUser)
studyId - Study identifier (required)demographicUser - (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/self/demographics/assessment")
retrofit2.Call<DemographicUserResponse> saveDemographicUserSelfAssessment(@Path(value="studyId")
String studyId,
@Body
DemographicUserAssessment demographicUser)
studyId - Study identifier (required)demographicUser - (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/demographics/validation/{categoryName}")
retrofit2.Call<DemographicValuesValidationConfig> saveDemographicsValidationConfig(@Path(value="studyId")
String studyId,
@Path(value="categoryName")
String categoryName,
@Body
DemographicValuesValidationConfig demographicValuesValidationConfig)
studyId - Study identifier (required)categoryName - Name of a demographics category. (required)demographicValuesValidationConfig - (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/{userId}/reports/{identifier}")
retrofit2.Call<Message> saveStudyParticipantReportRecord(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier,
@Body
ReportData reportData)
studyId - Study identifier (required)userId - User ID (required)identifier - identifier (required)reportData - (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/self/reports/{identifier}")
retrofit2.Call<Message> saveUsersStudyParticipantReportRecord(@Path(value="studyId")
String studyId,
@Path(value="identifier")
String identifier,
@Body
ReportData reportData)
studyId - Study identifier (required)identifier - identifier (required)reportData - (required)@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)
studyId - Study identifier (required)userId - User ID (required)adherenceRecordsSearch - The search criteria. (required)@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)
studyId - Study identifier (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/{userId}/sendInstallLink")
retrofit2.Call<Message> sendStudyParticipantInstallLinkMessage(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId)
studyId - Study identifier (required)userId - User ID (required)@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)
studyId - Study identifier (required)userId - User ID (required)notificationMessage - (required)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
studyId - Study identifier (required)userId - User ID (required)deleteReauthToken - Should sign out also delete any extant reauthentication tokens? (optional, default to true)@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)
studyId - Study identifier (required)userId - User ID (required)enrollment - Updated enrollment (required)@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)
studyId - Study identifier (required)userId - User ID (required)studyParticipant - Study participant (required)@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)
studyId - Study identifier (required)userId - User ID (required)adherenceRecordUpdates - One ore more adherence records (required)@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)
studyId - Study identifier (required)userId - User ID (required)withdrawalNote - The reason given for a user’s withdrawal from a study. (optional)Copyright © 2023 Sage Bionetworks. All rights reserved.