public interface ForWorkersApi
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<Message> |
addParticipantReportRecord(String identifier,
ReportDataForWorker reportData)
Add a participant report record
Endpoint for a worker to add a report record for a participant.
|
retrofit2.Call<Message> |
addParticipantReportRecordV4(String userId,
String identifier,
ReportData reportData)
Add a participant report record
The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
|
retrofit2.Call<Message> |
addStudyReportRecord(String identifier,
ReportData reportData)
Add a record to a study report
Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
|
retrofit2.Call<Message> |
backfillParticipantVersion(String appId,
String userId)
Backfills participant version.
|
retrofit2.Call<UploadValidationStatus> |
completeUploadSession(String uploadId,
Boolean synchronous,
Boolean redrive)
Notify Bridge an upload is complete
Notify Bridge an upload is complete.
|
retrofit2.Call<HealthDataRecordEx3> |
createOrUpdateRecordEx3(String appId,
HealthDataRecordEx3 healthDataRecordEx3)
Create or update health data record using the Exporter 3 implementation.
|
retrofit2.Call<Message> |
deleteAllParticipantReportRecords(String userId,
String identifier)
Delete a participant report (all records)
|
retrofit2.Call<Message> |
deleteAllStudyReportRecords(String identifier)
Delete a study report (all records)
|
retrofit2.Call<Message> |
deleteParticipantReportRecord(String userId,
String identifier,
LocalDate date)
Delete a record for a specific day of a participant report
|
retrofit2.Call<Message> |
deleteStudyReportRecord(String identifier,
LocalDate date)
Delete a record for a specific day of a study report
|
retrofit2.Call<ActivityEventList> |
getActivityEventsForParticipantAndApp(String appId,
String userId)
Get activity event records for participant
|
retrofit2.Call<ForwardCursorStringList> |
getAllDataForAdminWorker(String appId,
String userId,
String offsetKey,
Integer pageSize)
Get list of identifiers for participant data
Endpoint for worker or admin to get a list of participant data identifiers.
|
retrofit2.Call<ParticipantVersionList> |
getAllParticipantVersionsForUser(String appId,
String userId)
Get all participant versions for health code.
|
retrofit2.Call<SurveyList> |
getAllPublishedSurveys(String appId,
Boolean includeDeleted)
Get the published surveys in an app
|
retrofit2.Call<App> |
getApp(String appId)
Get an app
|
retrofit2.Call<StudyList> |
getAppStudies(String appId,
Integer offsetBy,
Integer pageSize,
Boolean includeDeleted)
Get a paginated list of all studies in this app.
|
retrofit2.Call<ParticipantData> |
getDataByIdentifierForAdminWorker(String appId,
String userId,
String identifier)
Get participant data by identifier
Endpoint for worker or admin to get a participant data.
|
retrofit2.Call<ForwardCursorStringList> |
getHealthCodesGrantingOAuthAccess(String appId,
String vendorId,
Integer pageSize,
String offsetKey)
Get the health codes of the accounts that have granted OAuth access through a particular vendor.
|
retrofit2.Call<OAuthAccessToken> |
getOAuthAccessToken(String appId,
String vendorId,
String healthCode)
Get the access grant for a given account as specified by a health code.
|
retrofit2.Call<ForwardCursorScheduledActivityList> |
getParticipantActivityHistoryForApp(String appId,
String userId,
String activityGuid,
DateTime scheduledOnStart,
DateTime scheduledOnEnd,
String offsetKey,
Integer pageSize)
Get a study participant's history of activities
|
retrofit2.Call<StudyParticipant> |
getParticipantByExternalIdForApp(String appId,
String externalId,
Boolean consents)
Get a study participant (user) record in an app using the account's external ID.
|
retrofit2.Call<StudyParticipant> |
getParticipantByHealthCodeForApp(String appId,
String healthCode,
Boolean consents)
Get a study participant (user) record in an app using the account's health code.
|
retrofit2.Call<StudyParticipant> |
getParticipantByIdForApp(String appId,
String userId,
Boolean consents)
Get a study participant (user) record in an app
|
retrofit2.Call<ForwardCursorScheduledActivityList> |
getParticipantCompoundActivityHistoryForApp(String appId,
String userId,
String taskId,
DateTime scheduledOnStart,
DateTime scheduledOnEnd,
String offsetKey,
Integer pageSize)
Get a study participant's history of a compound activity
|
retrofit2.Call<ForwardCursorReportDataList> |
getParticipantReportForWorker(String appId,
String userId,
String reportId,
LocalDate startDate,
LocalDate endDate)
Get participant report records by date
|
retrofit2.Call<ForwardCursorReportDataList> |
getParticipantReportForWorkerV4(String appId,
String userId,
String reportId,
DateTime startTime,
DateTime endTime)
Get participant report records by date
|
retrofit2.Call<ReportDataList> |
getParticipantReportsForParticipant(String appId,
String userId,
String reportId,
LocalDate startDate,
LocalDate endDate)
Get participant report records by date.
|
retrofit2.Call<ForwardCursorReportDataList> |
getParticipantReportsForParticipantV2(String appId,
String userId,
String reportId,
DateTime startTime,
DateTime endTime,
String offsetKey,
Integer pageSize)
Get participant report records by date-time
|
retrofit2.Call<AccountSummaryList> |
getParticipantsForApp(String appId,
Integer offsetBy,
Integer pageSize,
String emailFilter,
String phoneFilter,
DateTime startTime,
DateTime endTime)
Get a paged list of study participants for an app
|
retrofit2.Call<ForwardCursorScheduledActivityList> |
getParticipantSurveyHistoryForApp(String appId,
String userId,
String surveyGuid,
DateTime scheduledOnStart,
DateTime scheduledOnEnd,
String offsetKey,
Integer pageSize)
Get a study participant's history of a survey
|
retrofit2.Call<ForwardCursorScheduledActivityList> |
getParticipantTaskHistoryForApp(String appId,
String userId,
String taskId,
DateTime scheduledOnStart,
DateTime scheduledOnEnd,
String offsetKey,
Integer pageSize)
Get a study participant's history of a task
|
retrofit2.Call<ParticipantVersion> |
getParticipantVersion(String appId,
String userId,
Integer version)
Get all participant versions for health code.
|
retrofit2.Call<HealthDataRecordEx3> |
getRecordEx3(String appId,
String recordId)
Retrieves the record for the given ID from the Exporter 3 implemention.
|
retrofit2.Call<HealthDataRecordEx3List> |
getRecordsEx3ForApp(String appId,
DateTime createdOnStart,
DateTime createdOnEnd,
Integer pageSize,
String offsetKey)
Retrieves all records from the Exporter 3 implemention in the specified app for the given time range.
|
retrofit2.Call<HealthDataRecordEx3List> |
getRecordsEx3ForStudy(String appId,
String studyId,
DateTime createdOnStart,
DateTime createdOnEnd,
Integer pageSize,
String offsetKey)
Retrieves all records from the Exporter 3 implementation in the given app and study and time range.
|
retrofit2.Call<HealthDataRecordEx3List> |
getRecordsEx3ForUser(String appId,
String userId,
DateTime createdOnStart,
DateTime createdOnEnd,
Integer pageSize,
String offsetKey)
Retrieves all records from the Exporter 3 implementation for the given user and time range.
|
retrofit2.Call<RequestInfo> |
getRequestInfoForWorker(String appId,
String userId)
Get information about the last request made by this participant
Retrieves information about the user agent headers and participant settings that were in effect the last time this participant contacted the Bridge server.
|
retrofit2.Call<SchedulePlanList> |
getSchedulePlansForApp(String appId,
Boolean includeDeleted)
Get schedule plans
|
retrofit2.Call<UploadSchema> |
getSchemaRevision(String appId,
String schemaId,
Long revision)
Get a schema revision from an app
|
retrofit2.Call<StudyList> |
getSponsoredStudiesForApp(String appId,
String orgId,
Integer offsetBy,
Integer pageSize)
Get the studies that are sponsored by the organization
|
retrofit2.Call<OrganizationList> |
getSponsors(String studyId,
Integer offsetBy,
Integer pageSize)
Get the sponsors of this study.
|
retrofit2.Call<Study> |
getStudyForWorker(String appId,
String studyId)
Worker API to get a study by app ID and study ID
|
retrofit2.Call<StringList> |
getStudyIdsUsingSchedule(String appId,
String scheduleGuid)
Returns a list of all study IDs in the given app that use the given schedule.
|
retrofit2.Call<Survey> |
getSurvey(String surveyGuid,
DateTime createdOn)
Deprecated.
|
retrofit2.Call<TimelineMetadata> |
getTimelineMetadata(String appId,
String instanceGuid)
For a given instance guid, get all the contextual information available for that assessment or session from the participant’s schedule.
|
retrofit2.Call<Upload> |
getUploadById(String uploadId)
Get an upload by ID
|
retrofit2.Call<Upload> |
getUploadByRecordId(String recordId)
Get an upload record by the health data record ID
A superadmin or worker can retrieve any upload in any app.
|
retrofit2.Call<UploadSchema> |
getUploadSchema(String schemaId,
Long revision)
Deprecated.
|
retrofit2.Call<UploadList> |
getUploadsForApp(String appId,
DateTime startTime,
DateTime endTime,
Integer pageSize,
String offsetKey)
Get uploads for a specified app
|
retrofit2.Call<WeeklyAdherenceReport> |
getWeeklyAdherenceReportForWorker(String appId,
String studyId,
String userId)
Get the weekly adherence report for a participant (which also persists this report for the paginated API of reports for an entire study)
|
retrofit2.Call<Message> |
saveDataForAdminWorker(String appId,
String userId,
String identifier,
ParticipantData participantData)
Save a participant data
Endpoint for worker or admin to save a participant data.
|
retrofit2.Call<Message> |
saveReport(String appId,
String identifier,
ReportData reportData)
save report for a study
Save a report for a specified study with arbitrary report id given by wokers into bridgePF.
|
retrofit2.Call<AccountSummaryList> |
searchAccountSummariesForApp(String appId,
AccountSummarySearch accountSummarySearch)
Search for account summaries (participants)
|
retrofit2.Call<Message> |
sendExportNotifications(ExportToAppNotification exportToAppNotification)
Called by the Worker to send export notifications.
|
retrofit2.Call<Message> |
sendSmsMessageToParticipantForApp(String appId,
String userId,
SmsTemplate smsTemplate)
Send an SMS message to a single participant
Send an SMS message to an individual participant (assuming they have a verified phone number).
|
retrofit2.Call<Message> |
updateRecordExportStatuses(RecordExportStatusRequest recordExportStatusRequest)
Updates the status of an export job
Updates the status of an export job on the health data records included in that job.
|
@Headers(value="Content-Type:application/json")
@POST(value="v3/participants/reports/{identifier}")
retrofit2.Call<Message> addParticipantReportRecord(@Path(value="identifier")
String identifier,
@Body
ReportDataForWorker reportData)
identifier - identifier (required)reportData - (required)@Headers(value="Content-Type:application/json")
@POST(value="v4/participants/{userId}/reports/{identifier}")
retrofit2.Call<Message> addParticipantReportRecordV4(@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier,
@Body
ReportData reportData)
userId - User ID (required)identifier - identifier (required)reportData - (required)@Headers(value="Content-Type:application/json")
@POST(value="v4/reports/{identifier}")
retrofit2.Call<Message> addStudyReportRecord(@Path(value="identifier")
String identifier,
@Body
ReportData reportData)
identifier - identifier (required)reportData - Report data (required)@Headers(value="Content-Type:application/json")
@POST(value="v1/apps/{appId}/participants/{userId}/exporter3/versions/backfill")
retrofit2.Call<Message> backfillParticipantVersion(@Path(value="appId")
String appId,
@Path(value="userId")
String userId)
appId - App ID (required)userId - User ID (required)@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)
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)@Headers(value="Content-Type:application/json")
@POST(value="v1/apps/{appId}/exporter3/healthdata")
retrofit2.Call<HealthDataRecordEx3> createOrUpdateRecordEx3(@Path(value="appId")
String appId,
@Body
HealthDataRecordEx3 healthDataRecordEx3)
appId - App ID (required)healthDataRecordEx3 - Health data record to be created or updated. (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v4/participants/{userId}/reports/{identifier}")
retrofit2.Call<Message> deleteAllParticipantReportRecords(@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier)
userId - User ID (required)identifier - identifier (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v4/reports/{identifier}")
retrofit2.Call<Message> deleteAllStudyReportRecords(@Path(value="identifier")
String identifier)
identifier - identifier (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v3/participants/{userId}/reports/{identifier}/{date}")
retrofit2.Call<Message> deleteParticipantReportRecord(@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier,
@Path(value="date")
LocalDate date)
userId - User ID (required)identifier - identifier (required)date - Date of records (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v3/reports/{identifier}/{date}")
retrofit2.Call<Message> deleteStudyReportRecord(@Path(value="identifier")
String identifier,
@Path(value="date")
LocalDate date)
identifier - identifier (required)date - Date of records (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/activityevents")
retrofit2.Call<ActivityEventList> getActivityEventsForParticipantAndApp(@Path(value="appId")
String appId,
@Path(value="userId")
String userId)
appId - App ID (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/data")
retrofit2.Call<ForwardCursorStringList> getAllDataForAdminWorker(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Query(value="offsetKey")
String offsetKey,
@Query(value="pageSize")
Integer pageSize)
appId - App ID (required)userId - User ID (required)offsetKey - next page start key for pagination (optional)pageSize - maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/versions")
retrofit2.Call<ParticipantVersionList> getAllParticipantVersionsForUser(@Path(value="appId")
String appId,
@Path(value="userId")
String userId)
appId - App ID (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/surveys/published")
retrofit2.Call<SurveyList> getAllPublishedSurveys(@Path(value="appId")
String appId,
@Query(value="includeDeleted")
Boolean includeDeleted)
appId - App ID (required)includeDeleted - Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}")
retrofit2.Call<App> getApp(@Path(value="appId")
String appId)
appId - App ID (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/studies")
retrofit2.Call<StudyList> getAppStudies(@Path(value="appId")
String appId,
@Query(value="offsetBy")
Integer offsetBy,
@Query(value="pageSize")
Integer pageSize,
@Query(value="includeDeleted")
Boolean includeDeleted)
appId - App ID (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)includeDeleted - Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/data/{identifier}")
retrofit2.Call<ParticipantData> getDataByIdentifierForAdminWorker(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier)
appId - App ID (required)userId - User ID (required)identifier - identifier (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/oauth/{vendorId}")
retrofit2.Call<ForwardCursorStringList> getHealthCodesGrantingOAuthAccess(@Path(value="appId")
String appId,
@Path(value="vendorId")
String vendorId,
@Query(value="pageSize")
Integer pageSize,
@Query(value="offsetKey")
String offsetKey)
appId - App ID (required)vendorId - OAuth 2.0 provider ID (required)pageSize - maximum number of records in each returned page (optional, default to 50)offsetKey - next page start key for pagination (optional)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/oauth/{vendorId}/{healthCode}")
retrofit2.Call<OAuthAccessToken> getOAuthAccessToken(@Path(value="appId")
String appId,
@Path(value="vendorId")
String vendorId,
@Path(value="healthCode")
String healthCode)
appId - App ID (required)vendorId - OAuth 2.0 provider ID (required)healthCode - User health code (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/activities/{activityGuid}")
retrofit2.Call<ForwardCursorScheduledActivityList> getParticipantActivityHistoryForApp(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="activityGuid")
String activityGuid,
@Query(value="scheduledOnStart")
DateTime scheduledOnStart,
@Query(value="scheduledOnEnd")
DateTime scheduledOnEnd,
@Query(value="offsetKey")
String offsetKey,
@Query(value="pageSize")
Integer pageSize)
appId - App ID (required)userId - User ID (required)activityGuid - Activity GUID (required)scheduledOnStart - Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)scheduledOnEnd - Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)offsetKey - next page start key for pagination (optional)pageSize - maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/externalId:{externalId}")
retrofit2.Call<StudyParticipant> getParticipantByExternalIdForApp(@Path(value="appId")
String appId,
@Path(value="externalId")
String externalId,
@Query(value="consents")
Boolean consents)
appId - App ID (required)externalId - User's external ID (required)consents - Should consent histories be included with this participant record? (optional)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/healthCode:{healthCode}")
retrofit2.Call<StudyParticipant> getParticipantByHealthCodeForApp(@Path(value="appId")
String appId,
@Path(value="healthCode")
String healthCode,
@Query(value="consents")
Boolean consents)
appId - App ID (required)healthCode - User health code (required)consents - Should consent histories be included with this participant record? (optional)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}")
retrofit2.Call<StudyParticipant> getParticipantByIdForApp(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Query(value="consents")
Boolean consents)
appId - App ID (required)userId - User ID (required)consents - Should consent histories be included with this participant record? (optional)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/activities/compoundactivities/{taskId}")
retrofit2.Call<ForwardCursorScheduledActivityList> getParticipantCompoundActivityHistoryForApp(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="taskId")
String taskId,
@Query(value="scheduledOnStart")
DateTime scheduledOnStart,
@Query(value="scheduledOnEnd")
DateTime scheduledOnEnd,
@Query(value="offsetKey")
String offsetKey,
@Query(value="pageSize")
Integer pageSize)
appId - App ID (required)userId - User ID (required)taskId - Task ID (required)scheduledOnStart - Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)scheduledOnEnd - Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)offsetKey - next page start key for pagination (optional)pageSize - maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json")
@GET(value="v3/studies/{appId}/participants/{userId}/reports/{reportId}")
retrofit2.Call<ForwardCursorReportDataList> getParticipantReportForWorker(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="reportId")
String reportId,
@Query(value="startDate")
LocalDate startDate,
@Query(value="endDate")
LocalDate endDate)
appId - App ID (required)userId - User ID (required)reportId - Report ID (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)@Headers(value="Content-Type:application/json")
@GET(value="v4/studies/{appId}/participants/{userId}/reports/{reportId}")
retrofit2.Call<ForwardCursorReportDataList> getParticipantReportForWorkerV4(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="reportId")
String reportId,
@Query(value="startTime")
DateTime startTime,
@Query(value="endTime")
DateTime endTime)
appId - App ID (required)userId - User ID (required)reportId - Report ID (required)startTime - (required)endTime - (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/reports/{reportId}")
retrofit2.Call<ReportDataList> getParticipantReportsForParticipant(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="reportId")
String reportId,
@Query(value="startDate")
LocalDate startDate,
@Query(value="endDate")
LocalDate endDate)
appId - App ID (required)userId - User ID (required)reportId - Report ID (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)@Headers(value="Content-Type:application/json")
@GET(value="v2/apps/{appId}/participants/{userId}/reports/{reportId}")
retrofit2.Call<ForwardCursorReportDataList> getParticipantReportsForParticipantV2(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="reportId")
String reportId,
@Query(value="startTime")
DateTime startTime,
@Query(value="endTime")
DateTime endTime,
@Query(value="offsetKey")
String offsetKey,
@Query(value="pageSize")
Integer pageSize)
appId - App ID (required)userId - User ID (required)reportId - Report ID (required)startTime - (required)endTime - (required)offsetKey - next page start key for pagination (optional)pageSize - maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/activities/surveys/{surveyGuid}")
retrofit2.Call<ForwardCursorScheduledActivityList> getParticipantSurveyHistoryForApp(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="surveyGuid")
String surveyGuid,
@Query(value="scheduledOnStart")
DateTime scheduledOnStart,
@Query(value="scheduledOnEnd")
DateTime scheduledOnEnd,
@Query(value="offsetKey")
String offsetKey,
@Query(value="pageSize")
Integer pageSize)
appId - App ID (required)userId - User ID (required)surveyGuid - Survey GUID (required)scheduledOnStart - Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)scheduledOnEnd - Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)offsetKey - next page start key for pagination (optional)pageSize - maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/activities/tasks/{taskId}")
retrofit2.Call<ForwardCursorScheduledActivityList> getParticipantTaskHistoryForApp(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="taskId")
String taskId,
@Query(value="scheduledOnStart")
DateTime scheduledOnStart,
@Query(value="scheduledOnEnd")
DateTime scheduledOnEnd,
@Query(value="offsetKey")
String offsetKey,
@Query(value="pageSize")
Integer pageSize)
appId - App ID (required)userId - User ID (required)taskId - Task ID (required)scheduledOnStart - Activities returned are at or after the timestamp. If scheduledOnStart is provided, scheduledOnEnd must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)scheduledOnEnd - Activities returned are at or before the timestamp. If scheduledOnEnd is provided, scheduledOnStart must be provided, and vice versa. Default range is 4 days in the future to 10 days in the past. (optional)offsetKey - next page start key for pagination (optional)pageSize - maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/versions/{version}")
retrofit2.Call<ParticipantVersion> getParticipantVersion(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="version")
Integer version)
appId - App ID (required)userId - User ID (required)version - version number (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants")
retrofit2.Call<AccountSummaryList> getParticipantsForApp(@Path(value="appId")
String appId,
@Query(value="offsetBy")
Integer offsetBy,
@Query(value="pageSize")
Integer pageSize,
@Query(value="emailFilter")
String emailFilter,
@Query(value="phoneFilter")
String phoneFilter,
@Query(value="startTime")
DateTime startTime,
@Query(value="endTime")
DateTime endTime)
appId - App ID (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)emailFilter - A string (can be a substring of an email address) to filter returned records against. (optional)phoneFilter - A string (can be a substring of a phone number) to filter returned records against. (optional)startTime - The first day to include in reports that are returned (optional)endTime - The last day to include in reports that are returned (optional)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/exporter3/healthdata/{recordId}")
retrofit2.Call<HealthDataRecordEx3> getRecordEx3(@Path(value="appId")
String appId,
@Path(value="recordId")
String recordId)
appId - App ID (required)recordId - Health data record ID (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/exporter3/healthdata")
retrofit2.Call<HealthDataRecordEx3List> getRecordsEx3ForApp(@Path(value="appId")
String appId,
@Query(value="createdOnStart")
DateTime createdOnStart,
@Query(value="createdOnEnd")
DateTime createdOnEnd,
@Query(value="pageSize")
Integer pageSize,
@Query(value="offsetKey")
String offsetKey)
appId - App ID (required)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)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/studies/{studyId}/exporter3/healthdata")
retrofit2.Call<HealthDataRecordEx3List> getRecordsEx3ForStudy(@Path(value="appId")
String appId,
@Path(value="studyId")
String studyId,
@Query(value="createdOnStart")
DateTime createdOnStart,
@Query(value="createdOnEnd")
DateTime createdOnEnd,
@Query(value="pageSize")
Integer pageSize,
@Query(value="offsetKey")
String offsetKey)
appId - App ID (required)studyId - Study identifier (required)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)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/exporter3/healthdata")
retrofit2.Call<HealthDataRecordEx3List> getRecordsEx3ForUser(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Query(value="createdOnStart")
DateTime createdOnStart,
@Query(value="createdOnEnd")
DateTime createdOnEnd,
@Query(value="pageSize")
Integer pageSize,
@Query(value="offsetKey")
String offsetKey)
appId - App ID (required)userId - User ID (required)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)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/participants/{userId}/requestInfo")
retrofit2.Call<RequestInfo> getRequestInfoForWorker(@Path(value="appId")
String appId,
@Path(value="userId")
String userId)
appId - App ID (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/scheduleplans")
retrofit2.Call<SchedulePlanList> getSchedulePlansForApp(@Path(value="appId")
String appId,
@Query(value="includeDeleted")
Boolean includeDeleted)
appId - App ID (required)includeDeleted - Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/uploadschemas/{schemaId}/revisions/{revision}")
retrofit2.Call<UploadSchema> getSchemaRevision(@Path(value="appId")
String appId,
@Path(value="schemaId")
String schemaId,
@Path(value="revision")
Long revision)
appId - App ID (required)schemaId - Upload schema ID (required)revision - Revision number (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/organizations/{orgId}/studies")
retrofit2.Call<StudyList> getSponsoredStudiesForApp(@Path(value="appId")
String appId,
@Path(value="orgId")
String orgId,
@Query(value="offsetBy")
Integer offsetBy,
@Query(value="pageSize")
Integer pageSize)
appId - App ID (required)orgId - Organization ID (required)offsetBy - next page start offset for pagination (optional, default to 0)pageSize - maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/sponsors")
retrofit2.Call<OrganizationList> getSponsors(@Path(value="studyId")
String studyId,
@Query(value="offsetBy")
Integer offsetBy,
@Query(value="pageSize")
Integer pageSize)
studyId - Study identifier (required)offsetBy - next page start offset for pagination (optional, default to 0)pageSize - maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json")
@GET(value="v2/apps/{appId}/studies/{studyId}")
retrofit2.Call<Study> getStudyForWorker(@Path(value="appId")
String appId,
@Path(value="studyId")
String studyId)
appId - App ID (required)studyId - Study identifier (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/schedules/{scheduleGuid}/studies")
retrofit2.Call<StringList> getStudyIdsUsingSchedule(@Path(value="appId")
String appId,
@Path(value="scheduleGuid")
String scheduleGuid)
appId - App ID (required)scheduleGuid - Schedule GUID (required)@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)
surveyGuid - Survey GUID (required)createdOn - Created on timestamp (ISO 8601) (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/timelinemetadata/{instanceGuid}")
retrofit2.Call<TimelineMetadata> getTimelineMetadata(@Path(value="appId")
String appId,
@Path(value="instanceGuid")
String instanceGuid)
appId - App ID (required)instanceGuid - Instance GUID of the adherence record (required)@Headers(value="Content-Type:application/json")
@GET(value="v3/uploads/{uploadId}")
retrofit2.Call<Upload> getUploadById(@Path(value="uploadId")
String uploadId)
uploadId - Upload ID (required)@Headers(value="Content-Type:application/json")
@GET(value="v3/uploads/recordId:{recordId}")
retrofit2.Call<Upload> getUploadByRecordId(@Path(value="recordId")
String recordId)
recordId - Health data record ID (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/uploadschemas/{schemaId}/revisions/{revision}") retrofit2.Call<UploadSchema> getUploadSchema(@Path(value="schemaId") String schemaId, @Path(value="revision") Long revision)
schemaId - Upload schema ID (required)revision - Revision number (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/uploads")
retrofit2.Call<UploadList> getUploadsForApp(@Path(value="appId")
String appId,
@Query(value="startTime")
DateTime startTime,
@Query(value="endTime")
DateTime endTime,
@Query(value="pageSize")
Integer pageSize,
@Query(value="offsetKey")
String offsetKey)
appId - App ID (required)startTime - (required)endTime - (required)pageSize - maximum number of records in each returned page (optional, default to 50)offsetKey - next page start key for pagination (optional)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/studies/{studyId}/participants/{userId}/adherence/weekly")
retrofit2.Call<WeeklyAdherenceReport> getWeeklyAdherenceReportForWorker(@Path(value="appId")
String appId,
@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId)
appId - App ID (required)studyId - Study identifier (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@POST(value="v1/apps/{appId}/participants/{userId}/data/{identifier}")
retrofit2.Call<Message> saveDataForAdminWorker(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier,
@Body
ParticipantData participantData)
appId - App ID (required)userId - User ID (required)identifier - identifier (required)participantData - (required)@Headers(value="Content-Type:application/json")
@POST(value="v1/apps/{appId}/reports/{identifier}")
retrofit2.Call<Message> saveReport(@Path(value="appId")
String appId,
@Path(value="identifier")
String identifier,
@Body
ReportData reportData)
appId - App ID (required)identifier - identifier (required)reportData - Report data (required)@Headers(value="Content-Type:application/json")
@POST(value="v1/apps/{appId}/participants/search")
retrofit2.Call<AccountSummaryList> searchAccountSummariesForApp(@Path(value="appId")
String appId,
@Body
AccountSummarySearch accountSummarySearch)
appId - App ID (required)accountSummarySearch - Account summary search parameters (required)@Headers(value="Content-Type:application/json") @POST(value="v1/exporter3/notifications/export") retrofit2.Call<Message> sendExportNotifications(@Body ExportToAppNotification exportToAppNotification)
exportToAppNotification - Notification of export to Synapse. (required)@Headers(value="Content-Type:application/json")
@POST(value="v1/apps/{appId}/participants/{userId}/sendSmsMessage")
retrofit2.Call<Message> sendSmsMessageToParticipantForApp(@Path(value="appId")
String appId,
@Path(value="userId")
String userId,
@Body
SmsTemplate smsTemplate)
appId - App ID (required)userId - User ID (required)smsTemplate - (required)@Headers(value="Content-Type:application/json") @POST(value="v3/recordexportstatuses") retrofit2.Call<Message> updateRecordExportStatuses(@Body RecordExportStatusRequest recordExportStatusRequest)
recordExportStatusRequest - A record export status request (required)Copyright © 2023 Sage Bionetworks. All rights reserved.