StudyActivityEventsApi (REST Client 0.25.35 API)

```
public interface StudyActivityEventsApi
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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>`	`createStudyParticipantStudyActivityEvent(String studyId, String userId, StudyActivityEventRequest customActivityEventRequest, Boolean showError, Boolean updateBursts)` Create a new activity event for a participant in this study.
`retrofit2.Call<Message>`	`deleteStudyActivityEvent(String studyId, String eventId, Boolean showError)` Delete an activity event (for the caller) if it is mutable.
`retrofit2.Call<Message>`	`deleteStudyParticipantStudyActivityEvent(String studyId, String userId, String eventId, Boolean showError)` Delete activity event for a study participant if it is mutable.
`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<StudyActivityEventPagedList>`	`getStudyParticipantStudyActivityEventHistory(String studyId, String userId, String eventId, Integer offsetBy, Integer pageSize)` Get the history of past timestamps for this event (for the caller).
`retrofit2.Call<StudyActivityEventList>`	`getStudyParticipantStudyActivityEvents(String studyId, String userId)` Get activity events for the participants

Method Detail

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>

createStudyParticipantStudyActivityEvent

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

Create a new activity event for a participant in this study. Create a new activity event for a participant in this study. A 201 is returned whether the event updates or not, to support concurrent and out-of-order POSTs from the client.

Parameters:: studyId - Study identifier (required); userId - User ID (required); customActivityEventRequest - (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>

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>

deleteStudyParticipantStudyActivityEvent

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

Delete activity event for a study participant if it is mutable.

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

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>

getStudyParticipantStudyActivityEventHistory

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/activityevents/{eventId}")
retrofit2.Call<StudyActivityEventPagedList> getStudyParticipantStudyActivityEventHistory(@Path(value="studyId")
                                                                                                                                                                                                                            String studyId,
                                                                                                                                                                                                                            @Path(value="userId")
                                                                                                                                                                                                                            String userId,
                                                                                                                                                                                                                            @Path(value="eventId")
                                                                                                                                                                                                                            String eventId,
                                                                                                                                                                                                                            @Query(value="offsetBy")
                                                                                                                                                                                                                            Integer offsetBy,
                                                                                                                                                                                                                            @Query(value="pageSize")
                                                                                                                                                                                                                            Integer pageSize)