SchedulesV2Api (REST Client 0.25.28 API)

```
public interface SchedulesV2Api
```

Method Summary

All Methods Instance Methods Abstract Methods
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.

Method Detail

deleteSchedule

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

Delete a schedule. This is always a physical delete and can only be performed by an admin.

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

getParticipantSchedule

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

Get the caller’s scheduled activities in this study.

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<ParticipantSchedule>

getScheduleForStudy

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/schedule")
retrofit2.Call<Schedule2> getScheduleForStudy(@Path(value="studyId")
                                                                                                                                           String studyId)

Get the schedule for this study.

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

getStudyParticipantTimeline

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

Get the timeline that is being assigned to the specific study participant. (Currently all users in a study are assigned the same timeline, but this will change with the introduction of study arms.)

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<Timeline>

getTimelineForStudy

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/timeline")
retrofit2.Call<Timeline> getTimelineForStudy(@Path(value="studyId")
                                                                                                                                          String studyId)

Get the timeline associated to this study through its schedule.

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

saveScheduleForStudy

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/schedule")
retrofit2.Call<Schedule2> saveScheduleForStudy(@Path(value="studyId")
                                                                                                                                             String studyId,
                                                                                                                                             @Body
                                                                                                                                             Schedule2 schedule)

Create or update a schedule associated with a study. This endpoint will return a status of 200 if the call is an update, or 201 if the schedule is being created for the first time.

Parameters:: studyId - Study identifier (required); schedule - (required)
Returns:: Call<Schedule2>

Interface SchedulesV2Api