public interface SchedulesV2Api
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
deleteSchedule(String guid)
Delete a schedule.
|
retrofit2.Call<ParticipantSchedule> |
getParticipantSchedule(String studyId,
String userId)
Get the caller’s scheduled activities in this study.
|
retrofit2.Call<Schedule2> |
getScheduleForStudy(String studyId)
Get the schedule for this study.
|
retrofit2.Call<Timeline> |
getStudyParticipantTimeline(String studyId,
String userId)
Get the timeline that is being assigned to the specific study participant.
|
retrofit2.Call<Timeline> |
getTimelineForStudy(String studyId)
Get the timeline associated to this study through its schedule.
|
retrofit2.Call<Schedule2> |
saveScheduleForStudy(String studyId,
Schedule2 schedule)
Create or update a schedule associated with a study.
|
@Headers(value="Content-Type:application/json") @DELETE(value="v5/schedules/{guid}") retrofit2.Call<Message> deleteSchedule(@Path(value="guid") String guid)
guid
- A guid (required)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}/participants/{userId}/schedule") retrofit2.Call<ParticipantSchedule> getParticipantSchedule(@Path(value="studyId") String studyId, @Path(value="userId") String userId)
studyId
- Study identifier (required)userId
- User ID (required)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}/schedule") retrofit2.Call<Schedule2> getScheduleForStudy(@Path(value="studyId") String studyId)
studyId
- Study identifier (required)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}/participants/{userId}/timeline") retrofit2.Call<Timeline> getStudyParticipantTimeline(@Path(value="studyId") String studyId, @Path(value="userId") String userId)
studyId
- Study identifier (required)userId
- User ID (required)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}/timeline") retrofit2.Call<Timeline> getTimelineForStudy(@Path(value="studyId") String studyId)
studyId
- Study identifier (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/schedule") retrofit2.Call<Schedule2> saveScheduleForStudy(@Path(value="studyId") String studyId, @Body Schedule2 schedule)
studyId
- Study identifier (required)schedule
- (required)Copyright © 2023 Sage Bionetworks. All rights reserved.