public interface ParticipantReportsApi
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> |
deleteAllParticipantReportRecords(String userId,
String identifier)
Delete a participant 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<ForwardCursorReportDataList> |
getParticipantReportForWorkerV4(String appId,
String userId,
String reportId,
DateTime startTime,
DateTime endTime)
Get participant report records by date
|
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<ReportDataList> |
getUsersParticipantReportRecords(String userId,
String identifier,
LocalDate startDate,
LocalDate endDate)
Get participant report records
The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
|
retrofit2.Call<ForwardCursorReportDataList> |
getUsersParticipantReportRecordsV4(String userId,
String identifier,
DateTime startTime,
DateTime endTime,
String offsetKey,
Integer pageSize)
Get participant report records
The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
|
retrofit2.Call<Message> |
saveParticipantReportRecordsV4(String identifier,
ReportData reportData)
Save a participant report record
Save a report record.
|
@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") @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="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") @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="v3/participants/reports/{identifier}/index") retrofit2.Call<ReportIndex> getParticipantReportIndex(@Path(value="identifier") String identifier)
identifier
- identifier (required)@Headers(value="Content-Type:application/json") @GET(value="v3/participants/reports") retrofit2.Call<ReportIndexList> getParticipantReportIndices()
@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)
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)@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)
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)@Headers(value="Content-Type:application/json") @GET(value="v3/participants/{userId}/reports/{identifier}") retrofit2.Call<ReportDataList> getUsersParticipantReportRecords(@Path(value="userId") String userId, @Path(value="identifier") String identifier, @Query(value="startDate") LocalDate startDate, @Query(value="endDate") LocalDate endDate)
userId
- User ID (required)identifier
- identifier (required)startDate
- The first day to include in reports that are returned (required)endDate
- The last day to include in reports that are returned (required)@Headers(value="Content-Type:application/json") @GET(value="v4/participants/{userId}/reports/{identifier}") retrofit2.Call<ForwardCursorReportDataList> getUsersParticipantReportRecordsV4(@Path(value="userId") String userId, @Path(value="identifier") String identifier, @Query(value="startTime") DateTime startTime, @Query(value="endTime") DateTime endTime, @Query(value="offsetKey") String offsetKey, @Query(value="pageSize") Integer pageSize)
userId
- User ID (required)identifier
- identifier (required)startTime
- (required)endTime
- (required)offsetKey
- next page start key for pagination (optional)pageSize
- maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json") @POST(value="v4/users/self/reports/{identifier}") retrofit2.Call<Message> saveParticipantReportRecordsV4(@Path(value="identifier") String identifier, @Body ReportData reportData)
identifier
- identifier (required)reportData
- (required)Copyright © 2023 Sage Bionetworks. All rights reserved.