public interface ConsentsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<StudyConsent> |
addNewDefaultConsentRevision()
Deprecated.
|
retrofit2.Call<UserSessionInfo> |
createConsentSignature(String subpopulationGuid,
ConsentSignature consentSignature)
Consent to this subpopulation by submitting a signature
Agree to the terms of participant represented by this subpopulation, by submitting a signature to the Bridge server.
|
retrofit2.Call<StudyConsentList> |
getAllDefaultConsentRevisions()
Deprecated.
|
retrofit2.Call<ConsentSignature> |
getConsentSignature(String subpopulationGuid)
Get the participant's consent signature for the subpopulation
|
retrofit2.Call<StudyConsent> |
getDefaultConsentRevision(DateTime createdOn)
Deprecated.
|
retrofit2.Call<EnrollmentDetailList> |
getEnrollmentsForUser(String userId)
Get enrollment records for this user
|
retrofit2.Call<StudyConsent> |
getMostRecentDefaultConsentRevision()
Deprecated.
|
retrofit2.Call<StudyConsent> |
getPublishedDefaultConsentRevision()
Deprecated.
|
retrofit2.Call<Message> |
resendConsentAgreement(String subpopulationGuid)
Email or SMS the consent agreement to the participant
Although this method is to \"resend\" a consent agreement, if you have the automatic delivery of a signed consent disabled, this may be the method through which a user requests the consent for the first time, should they wish to retrieve a signed copy.
|
retrofit2.Call<Message> |
submitIntentToParticipate(IntentToParticipate intentToParticipate)
Send a consent signature to Bridge before the user has signed up to the server.
|
retrofit2.Call<UserSessionInfo> |
withdrawConsentFromSubpopulation(String subpopulationGuid,
Withdrawal withdrawal)
Withdraw participant from this subpopulation consent group
This withdraws the user from only one subpopulation.
|
retrofit2.Call<Message> |
withdrawFromApp(Withdrawal withdrawal)
Withdraw user from all studies in app
Withdraw the user entirely from all studies in this app.
|
retrofit2.Call<Message> |
withdrawParticipantFromApp(String userId,
Withdrawal withdrawal)
Withdraw the participant from all studies in this app
Withdraw the user entirely from all studies in this app.
|
retrofit2.Call<Message> |
withdrawParticipantFromSubpopulation(String userId,
String subpopulationGuid,
Withdrawal withdrawal)
Withdraw the participant from the specified subpopulation
This endpoint will withdraw the user from consent to participate in one subpopulation of the app.
|
@Deprecated @Headers(value="Content-Type:application/json") @POST(value="v3/consents") retrofit2.Call<StudyConsent> addNewDefaultConsentRevision()
@Headers(value="Content-Type:application/json") @POST(value="v3/subpopulations/{subpopulationGuid}/consents/signature") retrofit2.Call<UserSessionInfo> createConsentSignature(@Path(value="subpopulationGuid") String subpopulationGuid, @Body ConsentSignature consentSignature)
subpopulationGuid
- Subpopulation GUID (required)consentSignature
- A consent signature (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/consents") retrofit2.Call<StudyConsentList> getAllDefaultConsentRevisions()
@Headers(value="Content-Type:application/json") @GET(value="v3/subpopulations/{subpopulationGuid}/consents/signature") retrofit2.Call<ConsentSignature> getConsentSignature(@Path(value="subpopulationGuid") String subpopulationGuid)
subpopulationGuid
- Subpopulation GUID (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/consents/{createdOn}") retrofit2.Call<StudyConsent> getDefaultConsentRevision(@Path(value="createdOn") DateTime createdOn)
createdOn
- Created on timestamp (ISO 8601) (required)@Headers(value="Content-Type:application/json") @GET(value="v3/participants/{userId}/enrollments") retrofit2.Call<EnrollmentDetailList> getEnrollmentsForUser(@Path(value="userId") String userId)
userId
- User ID (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/consents/recent") retrofit2.Call<StudyConsent> getMostRecentDefaultConsentRevision()
@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/consents/published") retrofit2.Call<StudyConsent> getPublishedDefaultConsentRevision()
@Headers(value="Content-Type:application/json") @POST(value="v3/subpopulations/{subpopulationGuid}/consents/signature/resend") retrofit2.Call<Message> resendConsentAgreement(@Path(value="subpopulationGuid") String subpopulationGuid)
subpopulationGuid
- Subpopulation GUID (required)@Headers(value="Content-Type:application/json") @POST(value="v3/itp") retrofit2.Call<Message> submitIntentToParticipate(@Body IntentToParticipate intentToParticipate)
intentToParticipate
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/subpopulations/{subpopulationGuid}/consents/signature/withdraw") retrofit2.Call<UserSessionInfo> withdrawConsentFromSubpopulation(@Path(value="subpopulationGuid") String subpopulationGuid, @Body Withdrawal withdrawal)
subpopulationGuid
- Subpopulation GUID (required)withdrawal
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/consents/withdraw") retrofit2.Call<Message> withdrawFromApp(@Body Withdrawal withdrawal)
withdrawal
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/participants/{userId}/consents/withdraw") retrofit2.Call<Message> withdrawParticipantFromApp(@Path(value="userId") String userId, @Body Withdrawal withdrawal)
userId
- User ID (required)withdrawal
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/participants/{userId}/consents/{subpopulationGuid}/withdraw") retrofit2.Call<Message> withdrawParticipantFromSubpopulation(@Path(value="userId") String userId, @Path(value="subpopulationGuid") String subpopulationGuid, @Body Withdrawal withdrawal)
userId
- User ID (required)subpopulationGuid
- Subpopulation GUID (required)withdrawal
- (required)Copyright © 2023 Sage Bionetworks. All rights reserved.