public interface AlertsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
deleteAlerts(String studyId,
AlertIdCollection alertIdCollection)
Deletes alerts given a list of their ids.
|
retrofit2.Call<AlertCategoriesAndCounts> |
getAlertCategoriesAndCounts(String studyId)
Fetches a list of alert categories and the number of alerts in those categories for a particular study.
|
retrofit2.Call<AlertList> |
getAlerts(String studyId,
AlertFilter alertFilter,
Integer offsetBy,
Integer pageSize)
Fetches all alerts for a study.
|
retrofit2.Call<Message> |
markAlertsRead(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as read.
|
retrofit2.Call<Message> |
markAlertsUnread(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as unread.
|
@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/alerts/delete") retrofit2.Call<Message> deleteAlerts(@Path(value="studyId") String studyId, @Body AlertIdCollection alertIdCollection)
studyId
- Study identifier (required)alertIdCollection
- (required)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}/alerts/categories/counts") retrofit2.Call<AlertCategoriesAndCounts> getAlertCategoriesAndCounts(@Path(value="studyId") String studyId)
studyId
- Study identifier (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/alerts") retrofit2.Call<AlertList> getAlerts(@Path(value="studyId") String studyId, @Body AlertFilter alertFilter, @Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize)
studyId
- Study identifier (required)alertFilter
- (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") @POST(value="v5/studies/{studyId}/alerts/read") retrofit2.Call<Message> markAlertsRead(@Path(value="studyId") String studyId, @Body AlertIdCollection alertIdCollection)
studyId
- Study identifier (required)alertIdCollection
- (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/alerts/unread") retrofit2.Call<Message> markAlertsUnread(@Path(value="studyId") String studyId, @Body AlertIdCollection alertIdCollection)
studyId
- Study identifier (required)alertIdCollection
- (required)Copyright © 2023 Sage Bionetworks. All rights reserved.