public interface StudyConsentsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
createConsent(String subpopulationGuid,
StudyConsent studyConsent)
Add a new study consent version to this subpopulation
|
retrofit2.Call<StudyConsentList> |
getAllConsents(String subpopulationGuid)
Get a list of all consents for this subpopulation
|
retrofit2.Call<StudyConsent> |
getConsent(String subpopulationGuid,
DateTime createdOn)
Get a specific consent revision
Get a specific revision of this subpopulation consent by its creation timestamp.
|
retrofit2.Call<StudyConsent> |
getMostRecentConsent(String subpopulationGuid)
Get the most recently created consent revision
Get the most recently created revision of this subpopulation consent.
|
retrofit2.Call<StudyConsent> |
getPublishedConsent(String subpopulationGuid)
Get the published consent revision
Get the published revision of this subpopulation consent.
|
retrofit2.Call<Message> |
publishConsent(String subpopulationGuid,
DateTime createdOn)
Publish a specific consent revision
Publish a specific revision of this subpopulation consent by its creation timestamp.
|
@Headers(value="Content-Type:application/json") @POST(value="v3/subpopulations/{subpopulationGuid}/consents") retrofit2.Call<Message> createConsent(@Path(value="subpopulationGuid") String subpopulationGuid, @Body StudyConsent studyConsent)
subpopulationGuid
- Subpopulation GUID (required)studyConsent
- Study consent (required)@Headers(value="Content-Type:application/json") @GET(value="v3/subpopulations/{subpopulationGuid}/consents") retrofit2.Call<StudyConsentList> getAllConsents(@Path(value="subpopulationGuid") String subpopulationGuid)
subpopulationGuid
- Subpopulation GUID (required)@Headers(value="Content-Type:application/json") @GET(value="v3/subpopulations/{subpopulationGuid}/consents/{createdOn}") retrofit2.Call<StudyConsent> getConsent(@Path(value="subpopulationGuid") String subpopulationGuid, @Path(value="createdOn") DateTime createdOn)
subpopulationGuid
- Subpopulation GUID (required)createdOn
- creation timestamp of the revision (required)@Headers(value="Content-Type:application/json") @GET(value="v3/subpopulations/{subpopulationGuid}/consents/recent") retrofit2.Call<StudyConsent> getMostRecentConsent(@Path(value="subpopulationGuid") String subpopulationGuid)
subpopulationGuid
- Subpopulation GUID (required)@Headers(value="Content-Type:application/json") @GET(value="v3/subpopulations/{subpopulationGuid}/consents/published") retrofit2.Call<StudyConsent> getPublishedConsent(@Path(value="subpopulationGuid") String subpopulationGuid)
subpopulationGuid
- Subpopulation GUID (required)@Headers(value="Content-Type:application/json") @POST(value="v3/subpopulations/{subpopulationGuid}/consents/{createdOn}/publish") retrofit2.Call<Message> publishConsent(@Path(value="subpopulationGuid") String subpopulationGuid, @Path(value="createdOn") DateTime createdOn)
subpopulationGuid
- Subpopulation GUID (required)createdOn
- creation timestamp of the revision (required)Copyright © 2023 Sage Bionetworks. All rights reserved.