ForConsentedUsersApi (REST Client 0.25.35 API)

```
public interface ForConsentedUsersApi
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`retrofit2.Call<Message>`	`changeSharingScope(SharingScopeForm sharingScope)` Change the participant's sharing scope
`retrofit2.Call<UploadValidationStatus>`	`completeUploadSession(String uploadId, Boolean synchronous, Boolean redrive)` Notify Bridge an upload is complete Notify Bridge an upload is complete.
`retrofit2.Call<UserSessionInfo>`	`createConsentSignature(String subpopulationGuid, ConsentSignature consentSignature)` Consent to this subpopulation by submitting a signature Agree to the terms of participant represented by this subpopulation, by submitting a signature to the Bridge server.
`retrofit2.Call<Message>`	`createCustomActivityEvent(CustomActivityEventRequest customActivityEventRequest)` Deprecated.
`retrofit2.Call<GuidHolder>`	`createNotificationRegistration(NotificationRegistration notificationRegistration)` Register a client to receive push notifications Create a new registration.
`retrofit2.Call<ParticipantFile>`	`createParticipantFile(String fileId, ParticipantFile participantFile)` Create a new participant file
`retrofit2.Call<Message>`	`createStudyActivityEvent(String studyId, StudyActivityEventRequest studyActivityEventRequest, Boolean showError, Boolean updateBursts)` Create a new activity event for the caller in this study.
`retrofit2.Call<Message>`	`deleteCustomActivityEvent(String eventId)` Deprecated.
`retrofit2.Call<Message>`	`deleteDataByIdentifier(String identifier)` delete a participant data record
`retrofit2.Call<Message>`	`deleteNotificationRegistration(String guid)` Delete a push notification registration Delete a registration record.
`retrofit2.Call<Message>`	`deleteParticipantFile(String fileId)` Delete a participant file Delete a participant file
`retrofit2.Call<Message>`	`deleteStudyActivityEvent(String studyId, String eventId, Boolean showError)` Delete an activity event (for the caller) if it is mutable.
`retrofit2.Call<ActivityEventList>`	`getActivityEvents()` Deprecated.
`retrofit2.Call<ForwardCursorScheduledActivityList>`	`getActivityHistory(String activityGuid, DateTime scheduledOnStart, DateTime scheduledOnEnd, String offsetKey, Integer pageSize)` Deprecated.
`retrofit2.Call<ForwardCursorStringList>`	`getAllDataForSelf(String offsetKey, Integer pageSize)` Get list of identifiers for participant data
`retrofit2.Call<HealthDataRecordEx3List>`	`getAllRecordsEx3ForSelf(DateTime createdOnStart, DateTime createdOnEnd, Integer pageSize, String offsetKey)` Retrieves all records from the Exporter 3 implementation for the current user and time range - For developers to validate uploads from the app.
`retrofit2.Call<ForwardCursorScheduledActivityList>`	`getCompoundActivityHistory(String taskId, DateTime scheduledOnStart, DateTime scheduledOnEnd, String offsetKey, Integer pageSize)` Deprecated.
`retrofit2.Call<AppConfig>`	`getConfigForApp(String appId)` Get the config for the current version of the app making the request.
`retrofit2.Call<ConsentSignature>`	`getConsentSignature(String subpopulationGuid)` Get the participant's consent signature for the subpopulation
`retrofit2.Call<ParticipantData>`	`getDataByIdentifierForSelf(String identifier)` Get user's data based on the given identifier Get the participant data record based on the given identifier.
`retrofit2.Call<NotificationRegistration>`	`getNotificationRegistration(String guid)` Get a push notification registration Get a single push notification registration by its GUID.
`retrofit2.Call<NotificationRegistrationList>`	`getNotificationRegistrations()` Get all of a user's notification registrations Return all the registrations for this user.
`retrofit2.Call<okhttp3.ResponseBody>`	`getParticipantFile(String fileId)` Get a participant file
`retrofit2.Call<ParticipantFileList>`	`getParticipantFiles(String offsetKey, Integer pageSize)` Get a list of participant files from the user
`retrofit2.Call<ReportIndex>`	`getParticipantReportIndex(String identifier)` Get a single report index for participant reports
`retrofit2.Call<ReportIndexList>`	`getParticipantReportIndices()` Get list of report indices for participants
`retrofit2.Call<ReportDataList>`	`getParticipantReportRecords(String identifier, LocalDate startDate, LocalDate endDate)` Get a participant report Get the records for a specific participant report.
`retrofit2.Call<ForwardCursorReportDataList>`	`getParticipantReportRecordsV4(String identifier, DateTime startTime, DateTime endTime, Integer pageSize, String offsetKey)` Get a participant report Get the records for a specific participant report.
`retrofit2.Call<ParticipantSchedule>`	`getParticipantScheduleForSelf(String studyId, String clientTimeZone)` Get the caller’s scheduled activities in this study.
`retrofit2.Call<Survey>`	`getPublishedSurveyVersion(String surveyGuid)` Deprecated.
`retrofit2.Call<HealthDataRecordEx3>`	`getRecordEx3ById(String recordId, String download)` Retrieves the record for the given ID from the Exporter 3 implemention, provides a dowload link for the record if requested - For developers to validate uploads from the app.
`retrofit2.Call<ScheduledActivityList>`	`getScheduledActivities(String offset, Integer daysAhead, Integer minimumPerSchedule)` Deprecated.
`retrofit2.Call<ScheduledActivityListV4>`	`getScheduledActivitiesByDateRange(DateTime startTime, DateTime endTime)` Deprecated.
`retrofit2.Call<ScheduleList>`	`getSchedulesV1()` Deprecated.
`retrofit2.Call<Study>`	`getStudy(String studyId)` Get a study Get a study for this app.
`retrofit2.Call<StudyActivityEventPagedList>`	`getStudyActivityEventHistory(String studyId, String eventId, Integer offsetBy, Integer pageSize)` Get the history of past timestamps for this event (for the caller).
`retrofit2.Call<StudyActivityEventList>`	`getStudyActivityEvents(String studyId)` Get the activity events for this study (for the caller).
`retrofit2.Call<ReportIndexList>`	`getStudyReportIndices()` Get list of report indices for studies
`retrofit2.Call<ReportDataList>`	`getStudyReportRecords(String identifier, LocalDate startDate, LocalDate endDate)` Get study report records Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report record.
`retrofit2.Call<ForwardCursorReportDataList>`	`getStudyReportRecordsV4(String identifier, DateTime startTime, DateTime endTime, String offsetKey, Integer pageSize)` Get study report records Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
`retrofit2.Call<Survey>`	`getSurvey(String surveyGuid, DateTime createdOn)` Deprecated.
`retrofit2.Call<ForwardCursorScheduledActivityList>`	`getSurveyHistory(String surveyGuid, DateTime scheduledOnStart, DateTime scheduledOnEnd, String offsetKey, Integer pageSize)` Deprecated.
`retrofit2.Call<ForwardCursorScheduledActivityList>`	`getTaskHistory(String taskId, DateTime scheduledOnStart, DateTime scheduledOnEnd, String offsetKey, Integer pageSize)` Deprecated.
`retrofit2.Call<Timeline>`	`getTimelineForSelf(String studyId, DateTime ifModifiedSince)` Get the caller’s timeline of scheduled assessments in this study.
`retrofit2.Call<SubscriptionStatusList>`	`getTopicSubscriptions(String guid)` Get subscription status for all topics using a device registration For every topic in the app, get a status object describing whether or not the caller is subscribed to that topic.
`retrofit2.Call<UploadViewEx3>`	`getUploadEx3(String uploadId, Boolean fetchTimeline)` API to get an upload for Exporter 3.0, optionally with timeline metadata.
`retrofit2.Call<UploadViewEx3>`	`getUploadEx3ForStudy(String studyId, String uploadId, Boolean fetchTimeline, Boolean fetchAdherence)` API to get an upload in a study for Exporter 3.0, optionally with timeline metadata and adherence records.
`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<StudyParticipant>`	`getUsersParticipantRecord(Boolean consents)` Get user's participant record Get the current user's participant record.
`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<OAuthAccessToken>`	`requestOAuthAccessToken(String vendorId, OAuthAuthorizationToken oauthAuthorizationToken)` Request an access token from a given OAuth 2.0 provider.
`retrofit2.Call<UploadSession>`	`requestUploadSession(UploadRequest uploadRequest)` Request an upload session
`retrofit2.Call<Message>`	`resendConsentAgreement(String subpopulationGuid)` Email or SMS the consent agreement to the participant Although this method is to \"resend\" a consent agreement, if you have the automatic delivery of a signed consent disabled, this may be the method through which a user requests the consent for the first time, should they wish to retrieve a signed copy.
`retrofit2.Call<Message>`	`saveDataForSelf(String identifier, ParticipantData participantData)` Save a participant data record Save a participant record.
`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>`	`saveDemographicUserSelfAppLevel(DemographicUser demographicUser)` Save/overwrite all demographics for a user Save/overwrite all demographics for a user (app-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<DemographicUserResponse>`	`saveDemographicUserSelfAssessmentAppLevel(DemographicUserAssessment demographicUserAssessment)` Save/overwrite all demographics for a user Save/overwrite all demographics for a user (app-level, posted by the user), uses the assessment JSON model
`retrofit2.Call<Message>`	`saveParticipantReportRecordsV4(String identifier, ReportData reportData)` Save a participant report record Save a report record.
`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>`	`searchForAdherenceRecords(String studyId, AdherenceRecordsSearch adherenceRecordsSearch)` Search for adherence records.
`retrofit2.Call<Message>`	`sendDataToUser(DateRange dateRange)` Make user's data available for download via email or an SMS message Asynchronously request the uploaded data for this user, in a given time range (inclusive).
`retrofit2.Call<HealthDataRecord>`	`submitHealthData(HealthDataSubmission healthDataSubmission)` Upload health data Synchronous health data API.
`retrofit2.Call<SubscriptionStatusList>`	`subscribeToTopics(String guid, SubscriptionRequest subscriptionRequest)` Subscribe to a set of the topics using a device registration Provide a registration GUID and a set of topic GUIDs.
`retrofit2.Call<Message>`	`updateAdherenceRecords(String studyId, AdherenceRecordUpdates adherenceRecordUpdates)` Create or update one or more adherence records.
`retrofit2.Call<GuidHolder>`	`updateNotificationRegistration(String guid, NotificationRegistration notificationRegistration)` Update a push notification registration Update an existing device registration with a new token that has been assigned by the client operating system.
`retrofit2.Call<Message>`	`updateScheduledActivities(List<ScheduledActivity> scheduledActivity)` Deprecated.
`retrofit2.Call<UserSessionInfo>`	`updateUsersIdentifiers(IdentifierUpdate updateIdentifier)` Allows the caller to add additional identifier fields to an account (email, phone).
`retrofit2.Call<UserSessionInfo>`	`updateUsersParticipantRecord(StudyParticipant studyParticipant)` Update user's participant record Update the current user's participant record.
`retrofit2.Call<UserSessionInfo>`	`withdrawConsentFromSubpopulation(String subpopulationGuid, Withdrawal withdrawal)` Withdraw participant from this subpopulation consent group This withdraws the user from only one subpopulation.
`retrofit2.Call<Message>`	`withdrawFromApp(Withdrawal withdrawal)` Withdraw user from all studies in app Withdraw the user entirely from all studies in this app.

Method Detail

changeSharingScope

@Headers(value="Content-Type:application/json")
 @POST(value="v3/users/self/dataSharing")
retrofit2.Call<Message> changeSharingScope(@Body
                                                                                                                                     SharingScopeForm sharingScope)

Change the participant's sharing scope

Parameters:: sharingScope - Sharing scope (required)
Returns:: Call<Message>

completeUploadSession

@Headers(value="Content-Type:application/json")
 @POST(value="v3/uploads/{uploadId}/complete")
retrofit2.Call<UploadValidationStatus> completeUploadSession(@Path(value="uploadId")
                                                                                                                                                            String uploadId,
                                                                                                                                                            @Query(value="synchronous")
                                                                                                                                                            Boolean synchronous,
                                                                                                                                                            @Query(value="redrive")
                                                                                                                                                            Boolean redrive)

Notify Bridge an upload is complete Notify Bridge an upload is complete. Either a consented user or a worker process can access this endpoint, but failure to have the worker role will be treated like a consent error. If the upload metadata includes instanceGuid, eventTimestamp, and startedOn values matching an existing adherence record in the participant's schedule, then the adherence record will be updated to include this upload's identifier and uploadedOn date. If the adherence record does not exist then it will be created. In synchronous mode, this API will poll until upload validation is complete (or failed or is otherwise in a non-transient state), and return the upload validation status. In asynchronous mode, this API will return immediately and will also return the upload validation status, which is likely to be in \"validation_in_progress\".

Parameters:: uploadId - Upload ID (required); synchronous - True if this API call should wait for upload validation to finish before returning. (optional, default to false); redrive - True if this API call should allow completing uploads that are already complete. This is to allow redrives and backfills. (optional, default to false)
Returns:: Call<UploadValidationStatus>

createConsentSignature

@Headers(value="Content-Type:application/json")
 @POST(value="v3/subpopulations/{subpopulationGuid}/consents/signature")
retrofit2.Call<UserSessionInfo> createConsentSignature(@Path(value="subpopulationGuid")
                                                                                                                                                                                String subpopulationGuid,
                                                                                                                                                                                @Body
                                                                                                                                                                                ConsentSignature consentSignature)

Consent to this subpopulation by submitting a signature Agree to the terms of participant represented by this subpopulation, by submitting a signature to the Bridge server.

Parameters:: subpopulationGuid - Subpopulation GUID (required); consentSignature - A consent signature (required)
Returns:: Call<UserSessionInfo>

createCustomActivityEvent

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v1/activityevents")
retrofit2.Call<Message> createCustomActivityEvent(@Body
                                                                                                                                                 CustomActivityEventRequest customActivityEventRequest)

Deprecated.

Create an app-scoped activity event for the current user Create an app-scoped activity event for the current user. The eventId must be defined in the app. A 201 is returned whether the event updates or not, to support concurrent and out-of-order POSTs from the client.

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

createNotificationRegistration
```
@Headers(value="Content-Type:application/json")
 @POST(value="v3/notifications")
retrofit2.Call<GuidHolder> createNotificationRegistration(@Body
                                                                                                                                           NotificationRegistration notificationRegistration)
```
Register a client to receive push notifications Create a new registration. The client will retrieve an identifying token (the exact format and name for the token varies by platform), and register it with Bridge. Bridge will return a Bridge-specific GUID to track this registration, which the client can use to update or delete the registration at a later time. If the token already exists in an existing registration record, then that registration record will be returned in lieu of creating a redundant record.

Parameters:

notificationRegistration - (required)

Returns:

Call<GuidHolder>

createParticipantFile

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/self/files/{fileId}")
retrofit2.Call<ParticipantFile> createParticipantFile(@Path(value="fileId")
                                                                                                                                                          String fileId,
                                                                                                                                                          @Body
                                                                                                                                                          ParticipantFile participantFile)

Create a new participant file

Parameters:: fileId - (required); participantFile - The participant file metadata (required)
Returns:: Call<ParticipantFile>

createStudyActivityEvent

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

Create a new activity event for the caller in this study. Create a new activity event for the caller in this study. This call returns 201 whether the event updates or not, to support concurrent and out-of-order POSTs from the client. To return 400 if an event fails to publish, set the `showError` parameter to true. The creation or update of an event that triggers a study burst will update the study burst events as well, even to the point of recreating study burst events that have been deleted (depending on the update type of the bursts). To decouple these events and update the origin event without changing the study burst events, set the `updateBursts` parameter to false.

Parameters:: studyId - Study identifier (required); studyActivityEventRequest - (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>

deleteCustomActivityEvent

@Deprecated
 @Headers(value="Content-Type:application/json")
 @DELETE(value="v1/activityevents/{eventId}")
retrofit2.Call<Message> deleteCustomActivityEvent(@Path(value="eventId")
                                                                                                                                                             String eventId)

Deprecated.

Delete a custom activity event. The eventId must be defined in the app.

Parameters:: eventId - An activity event key (required)
Returns:: Call<Message>

deleteDataByIdentifier

@Headers(value="Content-Type:application/json")
 @DELETE(value="v3/users/self/data/{identifier}")
retrofit2.Call<Message> deleteDataByIdentifier(@Path(value="identifier")
                                                                                                                                                 String identifier)

delete a participant data record

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

deleteNotificationRegistration

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

Delete a push notification registration Delete a registration record. Bridge can no longer send push notifications to this device.

Parameters:: guid - A guid (required)
Returns:: Call<Message>

deleteParticipantFile

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

Delete a participant file Delete a participant file

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

deleteStudyActivityEvent

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

Delete an activity event (for the caller) if it is mutable.

Parameters:: studyId - Study identifier (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>

getActivityEvents

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v1/activityevents")
retrofit2.Call<ActivityEventList> getActivityEvents()

Deprecated.

Get activity events for current user Gets all activity events for the current user.

Returns:: Call<ActivityEventList>

getActivityHistory

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/activities/{activityGuid}")
retrofit2.Call<ForwardCursorScheduledActivityList> getActivityHistory(@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 history of activities

Parameters:: 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>

getAllDataForSelf

@Headers(value="Content-Type:application/json")
 @GET(value="v3/users/self/data")
retrofit2.Call<ForwardCursorStringList> getAllDataForSelf(@Query(value="offsetKey")
                                                                                                                                            String offsetKey,
                                                                                                                                            @Query(value="pageSize")
                                                                                                                                            Integer pageSize)

Get list of identifiers for participant data

Parameters:: offsetKey - next page start key for pagination (optional); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<ForwardCursorStringList>

getAllRecordsEx3ForSelf

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/self/exporter3/healthdata")
retrofit2.Call<HealthDataRecordEx3List> getAllRecordsEx3ForSelf(@Query(value="createdOnStart")
                                                                                                                                                                         DateTime createdOnStart,
                                                                                                                                                                         @Query(value="createdOnEnd")
                                                                                                                                                                         DateTime createdOnEnd,
                                                                                                                                                                         @Query(value="pageSize")
                                                                                                                                                                         Integer pageSize,
                                                                                                                                                                         @Query(value="offsetKey")
                                                                                                                                                                         String offsetKey)

Retrieves all records from the Exporter 3 implementation for the current user and time range - For developers to validate uploads from the app.

Parameters:: createdOnStart - Start time (ISO 8601) for a createdOn date-time range (optional); createdOnEnd - End time (ISO 8601) for a createdOn date-time range (optional); pageSize - maximum number of records in each returned page (optional, default to 50); offsetKey - next page start key for pagination (optional)
Returns:: Call<HealthDataRecordEx3List>

getCompoundActivityHistory

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v4/activities/compoundactivities/{taskId}")
retrofit2.Call<ForwardCursorScheduledActivityList> getCompoundActivityHistory(@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 history of compound activities

Parameters:: 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>

getConfigForApp

@Headers(value="Content-Type:application/json")
 @GET(value="v1/apps/{appId}/appconfig")
retrofit2.Call<AppConfig> getConfigForApp(@Path(value="appId")
                                                                                                                                   String appId)

Get the config for the current version of the app making the request. Although this call uses Bridge's common filtering framework (see https://developer.sagebridge.org/articles/study_design.html#filtering), the request does not require authentication, so only User-Agent and Accept-Language filtering criteria are used.

Parameters:: appId - App ID (required)
Returns:: Call<AppConfig>

getConsentSignature

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

Get the participant's consent signature for the subpopulation

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

getDataByIdentifierForSelf

@Headers(value="Content-Type:application/json")
 @GET(value="v3/users/self/data/{identifier}")
retrofit2.Call<ParticipantData> getDataByIdentifierForSelf(@Path(value="identifier")
                                                                                                                                                          String identifier)

Get user's data based on the given identifier Get the participant data record based on the given identifier. Participants can get reports for their own account. Note that this call does require consent and authentication.

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

getNotificationRegistration

@Headers(value="Content-Type:application/json")
 @GET(value="v3/notifications/{guid}")
retrofit2.Call<NotificationRegistration> getNotificationRegistration(@Path(value="guid")
                                                                                                                                                            String guid)

Get a push notification registration Get a single push notification registration by its GUID. This request is scoped to the user.

Parameters:: guid - A guid (required)
Returns:: Call<NotificationRegistration>

getNotificationRegistrations
```
@Headers(value="Content-Type:application/json")
 @GET(value="v3/notifications")
retrofit2.Call<NotificationRegistrationList> getNotificationRegistrations()
```
Get all of a user's notification registrations Return all the registrations for this user. There may be more than one if the user installs the application on different devices. Bridge attempts to prevent multiple registrations on the save device.

Returns:

Call<NotificationRegistrationList>

getParticipantFile

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/self/files/{fileId}")
retrofit2.Call<okhttp3.ResponseBody> getParticipantFile(@Path(value="fileId")
                                                                                                                                                           String fileId)

Get a participant file

Parameters:: fileId - (required)
Returns:: Call<ResponseBody>

getParticipantFiles

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/self/files")
retrofit2.Call<ParticipantFileList> getParticipantFiles(@Query(value="offsetKey")
                                                                                                                                                  String offsetKey,
                                                                                                                                                  @Query(value="pageSize")
                                                                                                                                                  Integer pageSize)

Get a list of participant files from the user

Parameters:: offsetKey - next page start key for pagination (optional); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<ParticipantFileList>

getParticipantReportIndex

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

Get a single report index for participant reports

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

getParticipantReportIndices

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/reports")
retrofit2.Call<ReportIndexList> getParticipantReportIndices()

Get list of report indices for participants

Returns:: Call<ReportIndexList>

getParticipantReportRecords

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

Get a participant report Get the records for a specific participant report. Participants can get reports for their own account. Note that this call does not require consent, but does require authentication.

Parameters:: 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>

getParticipantReportRecordsV4

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

Get a participant report Get the records for a specific participant report. Note that this call does not require consent, but does require authentication.

Parameters:: identifier - identifier (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<ForwardCursorReportDataList>

getParticipantScheduleForSelf

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

Get the caller’s scheduled activities in this study.

Parameters:: studyId - Study identifier (required); clientTimeZone - Participant's time zone. Must be an IANA time zone name. (required)
Returns:: Call<ParticipantSchedule>

getPublishedSurveyVersion

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/surveys/{surveyGuid}/revisions/published")
retrofit2.Call<Survey> getPublishedSurveyVersion(@Path(value="surveyGuid")
                                                                                                                                                                         String surveyGuid)

Deprecated.

Get most recently published revision of a survey

Parameters:: surveyGuid - Survey GUID (required)
Returns:: Call<Survey>

getRecordEx3ById

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/self/exporter3/healthdata/{recordId}")
retrofit2.Call<HealthDataRecordEx3> getRecordEx3ById(@Path(value="recordId")
                                                                                                                                                                         String recordId,
                                                                                                                                                                         @Query(value="download")
                                                                                                                                                                         String download)

Retrieves the record for the given ID from the Exporter 3 implemention, provides a dowload link for the record if requested - For developers to validate uploads from the app. Retrieves the record for the given ID from the Exporter 3 implemention if the given ID belongs to the current user, , provides a dowload link for the record if requested.

Parameters:: recordId - Health data record ID (required); download - If the user requires to download their record. (optional, default to false)
Returns:: Call<HealthDataRecordEx3>

getScheduledActivities

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/activities")
retrofit2.Call<ScheduledActivityList> getScheduledActivities(@Query(value="offset")
                                                                                                                                                       String offset,
                                                                                                                                                       @Query(value="daysAhead")
                                                                                                                                                       Integer daysAhead,
                                                                                                                                                       @Query(value="minimumPerSchedule")
                                                                                                                                                       Integer minimumPerSchedule)

Deprecated.

Get a list of the participant's scheduled activities Gets all available, started, or scheduled activities for a user. Once an activity is finished, or expires (the time has passed for it to be started), it will be removed from the list of activities returned to the user.

Parameters:: offset - The user's time zone offset (e.g. +07:00). Scheduled activities will be returned in the timezone submitted at the time of the request. (required); daysAhead - Retrieve activities that are scheduled in the future for the indicated number of days past today. (required); minimumPerSchedule - Force a look-ahead on repeating activities until at least the indicated number of activities are scheduled (this is applied to the each schedule in the system that applies to this user). The system will then return either the activities for N days, or the minimum number of activities, whichever is the greatest in number. This setting can help to expose infrequent tasks (weekly, monthly, etc.) to users. (optional)
Returns:: Call<ScheduledActivityList>

getScheduledActivitiesByDateRange

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v4/activities")
retrofit2.Call<ScheduledActivityListV4> getScheduledActivitiesByDateRange(@Query(value="startTime")
                                                                                                                                                                    DateTime startTime,
                                                                                                                                                                    @Query(value="endTime")
                                                                                                                                                                    DateTime endTime)

Deprecated.

Get a list of the participant's scheduled activities Get all scheduled activities in a given date range (from inclusive `startTime` to excluded `endTime`, must be less than 32 days), in one or more pages of results. An activity is included in the results if its scheduling window (`scheduledOn` to `expiresOn`) overlaps with the time range indicated by the request. The `startedOn` and `finishedOn` timestamps, if they exist for an activity, have no impact on whether it is included in this search query with the exception of deleted activities. These will not be returned in this query, and they are indicated by setting a `finishedOn` timestamp but no `startedOn` timestamp. **Persistent** activities will only ever return the current, active instance of that activity (you cannot retrieve the sequence of finished persistent activity instances, because this sequence is unbounded).

Parameters:: startTime - (required); endTime - (required)
Returns:: Call<ScheduledActivityListV4>

getSchedulesV1

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v4/schedules")
retrofit2.Call<ScheduleList> getSchedulesV1()

Deprecated.

Get schedules for user

Returns:: Call<ScheduleList>

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>

getStudyActivityEventHistory

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/self/activityevents/{eventId}")
retrofit2.Call<StudyActivityEventPagedList> getStudyActivityEventHistory(@Path(value="studyId")
                                                                                                                                                                                                        String studyId,
                                                                                                                                                                                                        @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); 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>

getStudyActivityEvents

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

Get the activity events for this study (for the caller).

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

getStudyReportIndices

@Headers(value="Content-Type:application/json")
 @GET(value="v3/reports")
retrofit2.Call<ReportIndexList> getStudyReportIndices()

Get list of report indices for studies

Returns:: Call<ReportIndexList>

getStudyReportRecords

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

Get study report records Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report record.

Parameters:: 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>

getStudyReportRecordsV4

@Headers(value="Content-Type:application/json")
 @GET(value="v4/reports/{identifier}")
retrofit2.Call<ForwardCursorReportDataList> getStudyReportRecordsV4(@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)

Get study report records Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.

Parameters:: 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>

getSurvey

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/surveys/{surveyGuid}/revisions/{createdOn}")
retrofit2.Call<Survey> getSurvey(@Path(value="surveyGuid")
                                                                                                                                                           String surveyGuid,
                                                                                                                                                           @Path(value="createdOn")
                                                                                                                                                           DateTime createdOn)

Deprecated.

Get a survey revision

Parameters:: surveyGuid - Survey GUID (required); createdOn - Created on timestamp (ISO 8601) (required)
Returns:: Call<Survey>

getSurveyHistory

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v4/activities/surveys/{surveyGuid}")
retrofit2.Call<ForwardCursorScheduledActivityList> getSurveyHistory(@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 history of surveys

Parameters:: 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>

getTaskHistory

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v4/activities/tasks/{taskId}")
retrofit2.Call<ForwardCursorScheduledActivityList> getTaskHistory(@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 history of tasks

Parameters:: 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>

getTimelineForSelf

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/self/timeline")
retrofit2.Call<Timeline> getTimelineForSelf(@Path(value="studyId")
                                                                                                                                                           String studyId,
                                                                                                                                                           @Header(value="If-Modified-Since")
                                                                                                                                                           DateTime ifModifiedSince)

Get the caller’s timeline of scheduled assessments in this study. Timelines rarely change and can be large, though they are sent compressed by the server. This method also supports long-term caching through both the `If-Modified-Since` (timestamp) and `If-None-Match` (etag) HTTP request headers.

Parameters:: studyId - Study identifier (required); ifModifiedSince - ISO 8601 timestamp value (optional)
Returns:: Call<Timeline>

getTopicSubscriptions

@Headers(value="Content-Type:application/json")
 @GET(value="v3/notifications/{guid}/subscriptions")
retrofit2.Call<SubscriptionStatusList> getTopicSubscriptions(@Path(value="guid")
                                                                                                                                                                  String guid)

Get subscription status for all topics using a device registration For every topic in the app, get a status object describing whether or not the caller is subscribed to that topic.

Parameters:: guid - A guid (required)
Returns:: Call<SubscriptionStatusList>

getUploadEx3

@Headers(value="Content-Type:application/json")
 @GET(value="v3/uploads/{uploadId}/exporter3")
retrofit2.Call<UploadViewEx3> getUploadEx3(@Path(value="uploadId")
                                                                                                                                          String uploadId,
                                                                                                                                          @Query(value="fetchTimeline")
                                                                                                                                          Boolean fetchTimeline)

API to get an upload for Exporter 3.0, optionally with timeline metadata. Caller must either be a participant getting their own uploads, or a developer or researcher.

Parameters:: uploadId - Upload ID (required); fetchTimeline - True if this API should fetch timeline metadata corresponding to this upload (optional, default to false)
Returns:: Call<UploadViewEx3>

getUploadEx3ForStudy

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/uploads/{uploadId}/exporter3")
retrofit2.Call<UploadViewEx3> getUploadEx3ForStudy(@Path(value="studyId")
                                                                                                                                                                    String studyId,
                                                                                                                                                                    @Path(value="uploadId")
                                                                                                                                                                    String uploadId,
                                                                                                                                                                    @Query(value="fetchTimeline")
                                                                                                                                                                    Boolean fetchTimeline,
                                                                                                                                                                    @Query(value="fetchAdherence")
                                                                                                                                                                    Boolean fetchAdherence)

API to get an upload in a study for Exporter 3.0, optionally with timeline metadata and adherence records. Caller must either be a participant getting their own uploads, or a study coordinator or a study designer getting an upload in a study they have access to, or a developer or researcher.

Parameters:: studyId - Study identifier (required); uploadId - Upload ID (required); fetchTimeline - True if this API should fetch timeline metadata corresponding to this upload (optional, default to false); fetchAdherence - True if this API should fetch adherence records corresponding to this upload (optional, default to false)
Returns:: Call<UploadViewEx3>

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>

getUsersParticipantRecord

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/self")
retrofit2.Call<StudyParticipant> getUsersParticipantRecord(@Query(value="consents")
                                                                                                                                               Boolean consents)

Get user's participant record Get the current user's participant record. Any authenticated user may call this endpoint. **The user does not need to have consented a study in the app in order to access their participant record.**

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

getUsersStudyParticipantEventStreamAdherenceReport

@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)

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

Parameters:: 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)
Returns:: Call<EventStreamAdherenceReport>

getUsersStudyParticipantReport

@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)

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).

Parameters:: 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)
Returns:: Call<ForwardCursorReportDataList>

requestOAuthAccessToken

@Headers(value="Content-Type:application/json")
 @POST(value="v3/oauth/{vendorId}")
retrofit2.Call<OAuthAccessToken> requestOAuthAccessToken(@Path(value="vendorId")
                                                                                                                                             String vendorId,
                                                                                                                                             @Body
                                                                                                                                             OAuthAuthorizationToken oauthAuthorizationToken)

Request an access token from a given OAuth 2.0 provider. Request an access token from a given OAuth 2.0 provider. The vendor ID must be defined for the app. The authorization token is optional. If the server can, a request without an authorization token will be refreshed with the provider and the access token will be returned. If a grant has never been given or this request fails to get a valid grant, a 404 will be returned.

Parameters:: vendorId - OAuth 2.0 provider ID (required); oauthAuthorizationToken - (required)
Returns:: Call<OAuthAccessToken>

requestUploadSession

@Headers(value="Content-Type:application/json")
 @POST(value="v3/uploads")
retrofit2.Call<UploadSession> requestUploadSession(@Body
                                                                                                                              UploadRequest uploadRequest)

Request an upload session

Parameters:: uploadRequest - An upload request (required)
Returns:: Call<UploadSession>

resendConsentAgreement

@Headers(value="Content-Type:application/json")
 @POST(value="v3/subpopulations/{subpopulationGuid}/consents/signature/resend")
retrofit2.Call<Message> resendConsentAgreement(@Path(value="subpopulationGuid")
                                                                                                                                                                               String subpopulationGuid)

Email or SMS the consent agreement to the participant Although this method is to \"resend\" a consent agreement, if you have the automatic delivery of a signed consent disabled, this may be the method through which a user requests the consent for the first time, should they wish to retrieve a signed copy.

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

saveDataForSelf

@Headers(value="Content-Type:application/json")
 @POST(value="v3/users/self/data/{identifier}")
retrofit2.Call<Message> saveDataForSelf(@Path(value="identifier")
                                                                                                                                        String identifier,
                                                                                                                                        @Body
                                                                                                                                        ParticipantData participantData)

Save a participant data record Save a participant record. If a record exists with the given identifier, it will be replaced with this record. Note that this call requires consent and authentication.

Parameters:: identifier - identifier (required); participantData - (required)
Returns:: Call<Message>

saveDemographicUserSelf

@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)

Save/overwrite all demographics for a user Save/overwrite all demographics for a user (study-level, posted by the user)

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

saveDemographicUserSelfAppLevel

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/self/demographics")
retrofit2.Call<DemographicUserResponse> saveDemographicUserSelfAppLevel(@Body
                                                                                                                                                                          DemographicUser demographicUser)

Save/overwrite all demographics for a user Save/overwrite all demographics for a user (app-level, posted by the user)

Parameters:: demographicUser - (required)
Returns:: Call<DemographicUserResponse>

saveDemographicUserSelfAssessment

@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)

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

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

saveDemographicUserSelfAssessmentAppLevel

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/self/demographics/assessment")
retrofit2.Call<DemographicUserResponse> saveDemographicUserSelfAssessmentAppLevel(@Body
                                                                                                                                                                                               DemographicUserAssessment demographicUserAssessment)

Save/overwrite all demographics for a user Save/overwrite all demographics for a user (app-level, posted by the user), uses the assessment JSON model

Parameters:: demographicUserAssessment - (required)
Returns:: Call<DemographicUserResponse>

saveParticipantReportRecordsV4

@Headers(value="Content-Type:application/json")
 @POST(value="v4/users/self/reports/{identifier}")
retrofit2.Call<Message> saveParticipantReportRecordsV4(@Path(value="identifier")
                                                                                                                                                          String identifier,
                                                                                                                                                          @Body
                                                                                                                                                          ReportData reportData)

Save a participant report record Save a report record. If a record exists at the given DateTime value, it will be replaced with this report record. Note that this call does not require consent, but does require authentication.

Parameters:: identifier - identifier (required); reportData - (required)
Returns:: Call<Message>

saveUsersStudyParticipantReportRecord

@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)

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).

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

searchForAdherenceRecords

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

Search for adherence records.

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

sendDataToUser

@Headers(value="Content-Type:application/json")
 @POST(value="v3/users/self/sendData")
retrofit2.Call<Message> sendDataToUser(@Body
                                                                                                                              DateRange dateRange)

Make user's data available for download via email or an SMS message Asynchronously request the uploaded data for this user, in a given time range (inclusive). Bridge server will gather the user's data for the given time zone and either email or SMS a secure link to the user's registered email address.

Parameters:: dateRange - startDate and endDate of the request. (required)
Returns:: Call<Message>

submitHealthData

@Headers(value="Content-Type:application/json")
 @POST(value="v3/healthdata")
retrofit2.Call<HealthDataRecord> submitHealthData(@Body
                                                                                                                                HealthDataSubmission healthDataSubmission)

Upload health data Synchronous health data API. Used to submit small health data payloads (such as survey responses) without incurring the overhead of creating a bunch of small files to upload to S3.

Parameters:: healthDataSubmission - Health data submitted by the user (required)
Returns:: Call<HealthDataRecord>

subscribeToTopics

@Headers(value="Content-Type:application/json")
 @POST(value="v3/notifications/{guid}/subscriptions")
retrofit2.Call<SubscriptionStatusList> subscribeToTopics(@Path(value="guid")
                                                                                                                                                               String guid,
                                                                                                                                                               @Body
                                                                                                                                                               SubscriptionRequest subscriptionRequest)

Subscribe to a set of the topics using a device registration Provide a registration GUID and a set of topic GUIDs. For every topic in the app, either subscribe or unsubscribe the registration GUID from the topic to bring the caller's subscription into line with the set provided.

Parameters:: guid - A guid (required); subscriptionRequest - (required)
Returns:: Call<SubscriptionStatusList>

updateAdherenceRecords

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

Create or update one or more adherence records.

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

updateNotificationRegistration

@Headers(value="Content-Type:application/json")
 @POST(value="v3/notifications/{guid}")
retrofit2.Call<GuidHolder> updateNotificationRegistration(@Path(value="guid")
                                                                                                                                                  String guid,
                                                                                                                                                  @Body
                                                                                                                                                  NotificationRegistration notificationRegistration)

Update a push notification registration Update an existing device registration with a new token that has been assigned by the client operating system. At least on iOS, the device token can change over the lifetime of the app, and it is considered best practice to re-send this token to the server on every start-up of the app. The guid returned from an update will always match the GUID that was submitted.

Parameters:: guid - A guid (required); notificationRegistration - (required)
Returns:: Call<GuidHolder>

updateScheduledActivities

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v4/activities")
retrofit2.Call<Message> updateScheduledActivities(@Body
                                                                                                                                             List<ScheduledActivity> scheduledActivity)

Deprecated.

Update the status of one or more scheduled activities. Submit one or more scheduled activities with updated startedOn or finishedOn timestamps. The only values needed in the JSON for each activity are the guid, startedOn and finishedOn fields.

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

updateUsersIdentifiers

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/self/identifiers")
retrofit2.Call<UserSessionInfo> updateUsersIdentifiers(@Body
                                                                                                                                                        IdentifierUpdate updateIdentifier)

Allows the caller to add additional identifier fields to an account (email, phone). Once set, these fields cannot currently be changed. The caller must be authenticated to make this call, *and* must provide a valid sign in object for either authentication or reauthentication.

Parameters:: updateIdentifier - Information to authenticate and update an account identifier (required)
Returns:: Call<UserSessionInfo>

updateUsersParticipantRecord
```
@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/self")
retrofit2.Call<UserSessionInfo> updateUsersParticipantRecord(@Body
                                                                                                                                                  StudyParticipant studyParticipant)
```
Update user's participant record Update the current user's participant record. **Unlike most other calls in this API, you can send partically complete JSON to this endpoint,** and it will selectively update the participant's record (rather than treating missing properties as an instruction to delete those fields in the record). This means that many existing APIs that sent a single update value, can direct those payloads to this endpoint and they will still work fine. For this reason most `/v3/users/_*` endpoints are now deprecated, though there is no plan to remove them. Any authenticated user may call this endpoint. **The user does not need to have consented to a study in the app in order to update their participant

Parameters:

studyParticipant - Study participant (required)

Returns:

Call<UserSessionInfo>

withdrawConsentFromSubpopulation

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

Withdraw participant from this subpopulation consent group This withdraws the user from only one subpopulation.

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

withdrawFromApp
```
@Headers(value="Content-Type:application/json")
 @POST(value="v3/consents/withdraw")
retrofit2.Call<Message> withdrawFromApp(@Body
                                                                                                                             Withdrawal withdrawal)
```
Withdraw user from all studies in 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 study consent administration email will receive a notification of the withdrawal. Finally, the user will be signed out from the Bridge server. This withdrawal cannot be reversed. If the user signs up again with a study, a new account under a new `healthCode` will be generated.

Parameters:

withdrawal - (required)

Returns:

Call<Message>

Interface ForConsentedUsersApi

Method Summary

Method Detail

changeSharingScope

completeUploadSession

createConsentSignature

createCustomActivityEvent

createNotificationRegistration

createParticipantFile

createStudyActivityEvent

deleteCustomActivityEvent

deleteDataByIdentifier

deleteNotificationRegistration

deleteParticipantFile

deleteStudyActivityEvent

getActivityEvents

getActivityHistory

getAllDataForSelf

getAllRecordsEx3ForSelf

getCompoundActivityHistory

getConfigForApp

getConsentSignature

getDataByIdentifierForSelf

getNotificationRegistration

getNotificationRegistrations

getParticipantFile

getParticipantFiles

getParticipantReportIndex

getParticipantReportIndices

getParticipantReportRecords

getParticipantReportRecordsV4

getParticipantScheduleForSelf

getPublishedSurveyVersion

getRecordEx3ById

getScheduledActivities

getScheduledActivitiesByDateRange

getSchedulesV1

getStudy

getStudyActivityEventHistory

getStudyActivityEvents

getStudyReportIndices

getStudyReportRecords

getStudyReportRecordsV4

getSurvey

getSurveyHistory

getTaskHistory

getTimelineForSelf

getTopicSubscriptions

getUploadEx3

getUploadEx3ForStudy

getUploadStatus

getUsersParticipantRecord

getUsersStudyParticipantEventStreamAdherenceReport

getUsersStudyParticipantReport

requestOAuthAccessToken

requestUploadSession

resendConsentAgreement

saveDataForSelf

saveDemographicUserSelf

saveDemographicUserSelfAppLevel

saveDemographicUserSelfAssessment

saveDemographicUserSelfAssessmentAppLevel

saveParticipantReportRecordsV4

saveUsersStudyParticipantReportRecord

searchForAdherenceRecords

sendDataToUser

submitHealthData

subscribeToTopics

updateAdherenceRecords

updateNotificationRegistration

updateScheduledActivities

updateUsersIdentifiers

updateUsersParticipantRecord

withdrawConsentFromSubpopulation

withdrawFromApp