public interface DemographicsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
deleteDemographic(String studyId,
String userId,
String demographicId)
Deletes a specific demographic (single category) for a particular user
Deletes a specific demographic (single category) for a particular user (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
deleteDemographicAppLevel(String userId,
String demographicId)
Deletes a specific demographic (single category) for a particular user
Deletes a specific demographic (single category) for a particular user (app-level, done by app admin)
|
retrofit2.Call<Message> |
deleteDemographicsValidationConfig(String studyId,
String categoryName)
Delete a DemographicValuesValidationConfig
Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation.
|
retrofit2.Call<Message> |
deleteDemographicsValidationConfigAppLevel(String categoryName)
Delete a DemographicValuesValidationConfig at the app level
Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation for app-level demographics.
|
retrofit2.Call<Message> |
deleteDemographicUser(String studyId,
String userId)
Deletes all of a user's demographics
Deletes all of a user's demographics (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
deleteDemographicUserAppLevel(String userId)
Deletes all of a user's demographics
Deletes all of a user's demographics (app-level, done by app admin)
|
retrofit2.Call<DemographicValuesValidationConfig> |
getDemographicsValidationConfig(String studyId,
String categoryName)
Fetch a DemographicValuesValidationConfig
Fetch an existing DemographicValuesValidationConfig which is used to configure demographics validation.
|
retrofit2.Call<DemographicValuesValidationConfig> |
getDemographicsValidationConfigAppLevel(String categoryName)
Fetch a DemographicValuesValidationConfig at the app level
Fetch an existing DemographicValuesValidationConfig which is used to configure demographics validation for app-level demographics.
|
retrofit2.Call<DemographicUserResponse> |
getDemographicUser(String studyId,
String userId)
Fetches all demographics for a user
Fetches all demographics for a user (study-level, done by researcher/study-coordinator)
|
retrofit2.Call<DemographicUserResponse> |
getDemographicUserAppLevel(String userId)
Fetches all demographics for a user
Fetches all demographics for a user (app-level, done by app admin)
|
retrofit2.Call<DemographicUserResponseList> |
getDemographicUsers(String studyId,
Integer offsetBy,
Integer pageSize)
Fetches all study-level demographics for all users within a study
Fetches all study-level demographics for all users within a study (study-level, done by researcher/study-coordinator)
|
retrofit2.Call<DemographicUserResponseList> |
getDemographicUsersAppLevel(Integer offsetBy,
Integer pageSize)
Fetches all app-level demographics for all users within an app
Fetches all app-level demographics for all users within an app (app-level, done by app admin)
|
retrofit2.Call<DemographicValuesValidationConfig> |
saveDemographicsValidationConfig(String studyId,
String categoryName,
DemographicValuesValidationConfig demographicValuesValidationConfig)
Save a DemographicValuesValidationConfig
Save a DemographicValuesValidationConfig to configure demographics validation.
|
retrofit2.Call<DemographicValuesValidationConfig> |
saveDemographicsValidationConfigAppLevel(String categoryName,
DemographicValuesValidationConfig demographicValuesValidationConfig)
Save a DemographicValuesValidationConfig at the app level
Save a DemographicValuesValidationConfig to configure demographics validation for app-level demographics.
|
retrofit2.Call<DemographicUserResponse> |
saveDemographicUser(String studyId,
String userId,
DemographicUser demographicUser)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (study-level, posted on the user's behalf by researcher, study coordinator)
|
retrofit2.Call<DemographicUserResponse> |
saveDemographicUserAppLevel(String userId,
DemographicUser demographicUser)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (app-level, posted on the user's behalf (by app admin))
|
retrofit2.Call<DemographicUserResponse> |
saveDemographicUserAssessment(String studyId,
String userId,
DemographicUserAssessment demographicUserAssessment)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (study-level, posted on the user's behalf by researcher, study coordinator), uses the assessment JSON model
|
retrofit2.Call<DemographicUserResponse> |
saveDemographicUserAssessmentAppLevel(String userId,
DemographicUserAssessment demographicUserAssessment)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (app-level, posted on the user's behalf (by app admin)), Uses the assessment JSON model
|
retrofit2.Call<DemographicUserResponse> |
saveDemographicUserSelf(String studyId,
DemographicUser demographicUser)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (study-level, posted by the user)
|
retrofit2.Call<DemographicUserResponse> |
saveDemographicUserSelfAppLevel(DemographicUser demographicUser)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (app-level, posted by the user)
|
retrofit2.Call<DemographicUserResponse> |
saveDemographicUserSelfAssessment(String studyId,
DemographicUserAssessment demographicUser)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (study-level, posted by the user), uses the assessment JSON model
|
retrofit2.Call<DemographicUserResponse> |
saveDemographicUserSelfAssessmentAppLevel(DemographicUserAssessment demographicUserAssessment)
Save/overwrite all demographics for a user
Save/overwrite all demographics for a user (app-level, posted by the user), uses the assessment JSON model
|
@Headers(value="Content-Type:application/json") @DELETE(value="v5/studies/{studyId}/participants/{userId}/demographics/{demographicId}") retrofit2.Call<Message> deleteDemographic(@Path(value="studyId") String studyId, @Path(value="userId") String userId, @Path(value="demographicId") String demographicId)
studyId
- Study identifier (required)userId
- User ID (required)demographicId
- ID of a particular demographic for a specific category associated with a specific user (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/participants/{userId}/demographics/{demographicId}") retrofit2.Call<Message> deleteDemographicAppLevel(@Path(value="userId") String userId, @Path(value="demographicId") String demographicId)
userId
- User ID (required)demographicId
- ID of a particular demographic for a specific category associated with a specific user (required)@Headers(value="Content-Type:application/json") @DELETE(value="v5/studies/{studyId}/participants/{userId}/demographics") retrofit2.Call<Message> deleteDemographicUser(@Path(value="studyId") String studyId, @Path(value="userId") String userId)
studyId
- Study identifier (required)userId
- User ID (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/participants/{userId}/demographics") retrofit2.Call<Message> deleteDemographicUserAppLevel(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @DELETE(value="v5/studies/{studyId}/participants/demographics/validation/{categoryName}") retrofit2.Call<Message> deleteDemographicsValidationConfig(@Path(value="studyId") String studyId, @Path(value="categoryName") String categoryName)
studyId
- Study identifier (required)categoryName
- Name of a demographics category. (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/participants/demographics/validation/{categoryName}") retrofit2.Call<Message> deleteDemographicsValidationConfigAppLevel(@Path(value="categoryName") String categoryName)
categoryName
- Name of a demographics category. (required)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}/participants/{userId}/demographics") retrofit2.Call<DemographicUserResponse> getDemographicUser(@Path(value="studyId") String studyId, @Path(value="userId") String userId)
studyId
- Study identifier (required)userId
- User ID (required)@Headers(value="Content-Type:application/json") @GET(value="v3/participants/{userId}/demographics") retrofit2.Call<DemographicUserResponse> getDemographicUserAppLevel(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}/participants/demographics") retrofit2.Call<DemographicUserResponseList> getDemographicUsers(@Path(value="studyId") String studyId, @Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize)
studyId
- Study identifier (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") @GET(value="v3/participants/demographics") retrofit2.Call<DemographicUserResponseList> getDemographicUsersAppLevel(@Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize)
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") @GET(value="v5/studies/{studyId}/participants/demographics/validation/{categoryName}") retrofit2.Call<DemographicValuesValidationConfig> getDemographicsValidationConfig(@Path(value="studyId") String studyId, @Path(value="categoryName") String categoryName)
studyId
- Study identifier (required)categoryName
- Name of a demographics category. (required)@Headers(value="Content-Type:application/json") @GET(value="v3/participants/demographics/validation/{categoryName}") retrofit2.Call<DemographicValuesValidationConfig> getDemographicsValidationConfigAppLevel(@Path(value="categoryName") String categoryName)
categoryName
- Name of a demographics category. (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/participants/{userId}/demographics") retrofit2.Call<DemographicUserResponse> saveDemographicUser(@Path(value="studyId") String studyId, @Path(value="userId") String userId, @Body DemographicUser demographicUser)
studyId
- Study identifier (required)userId
- User ID (required)demographicUser
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/participants/{userId}/demographics") retrofit2.Call<DemographicUserResponse> saveDemographicUserAppLevel(@Path(value="userId") String userId, @Body DemographicUser demographicUser)
userId
- User ID (required)demographicUser
- (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/participants/{userId}/demographics/assessment") retrofit2.Call<DemographicUserResponse> saveDemographicUserAssessment(@Path(value="studyId") String studyId, @Path(value="userId") String userId, @Body DemographicUserAssessment demographicUserAssessment)
studyId
- Study identifier (required)userId
- User ID (required)demographicUserAssessment
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/participants/{userId}/demographics/assessment") retrofit2.Call<DemographicUserResponse> saveDemographicUserAssessmentAppLevel(@Path(value="userId") String userId, @Body DemographicUserAssessment demographicUserAssessment)
userId
- User ID (required)demographicUserAssessment
- (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/participants/self/demographics") retrofit2.Call<DemographicUserResponse> saveDemographicUserSelf(@Path(value="studyId") String studyId, @Body DemographicUser demographicUser)
studyId
- Study identifier (required)demographicUser
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/participants/self/demographics") retrofit2.Call<DemographicUserResponse> saveDemographicUserSelfAppLevel(@Body DemographicUser demographicUser)
demographicUser
- (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/participants/self/demographics/assessment") retrofit2.Call<DemographicUserResponse> saveDemographicUserSelfAssessment(@Path(value="studyId") String studyId, @Body DemographicUserAssessment demographicUser)
studyId
- Study identifier (required)demographicUser
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/participants/self/demographics/assessment") retrofit2.Call<DemographicUserResponse> saveDemographicUserSelfAssessmentAppLevel(@Body DemographicUserAssessment demographicUserAssessment)
demographicUserAssessment
- (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/participants/demographics/validation/{categoryName}") retrofit2.Call<DemographicValuesValidationConfig> saveDemographicsValidationConfig(@Path(value="studyId") String studyId, @Path(value="categoryName") String categoryName, @Body DemographicValuesValidationConfig demographicValuesValidationConfig)
studyId
- Study identifier (required)categoryName
- Name of a demographics category. (required)demographicValuesValidationConfig
- (required)@Headers(value="Content-Type:application/json") @POST(value="v3/participants/demographics/validation/{categoryName}") retrofit2.Call<DemographicValuesValidationConfig> saveDemographicsValidationConfigAppLevel(@Path(value="categoryName") String categoryName, @Body DemographicValuesValidationConfig demographicValuesValidationConfig)
categoryName
- Name of a demographics category. (required)demographicValuesValidationConfig
- (required)Copyright © 2023 Sage Bionetworks. All rights reserved.