public interface ForAdminsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
addMember(String orgId,
String userId)
Add user as a member of the organization (this will return an error if the user is already assigned to another organization).
|
retrofit2.Call<Message> |
addStudySponsor(String studyId,
String orgId)
Add this organization as a sponsor
|
retrofit2.Call<Message> |
addStudySponsorship(String orgId,
String studyId)
Sponsor this study
|
retrofit2.Call<Organization> |
createOrganization(Organization organization)
Create a new organization
Create a new organization.
|
retrofit2.Call<PermissionDetail> |
createPermission(Permission permission)
Creates a permission record.
|
retrofit2.Call<VersionHolder> |
createStudy(Study study)
Create a new study
|
retrofit2.Call<UserSessionInfo> |
createUser(SignUp signUp)
Create a new user
|
retrofit2.Call<Message> |
deleteAllAppConfigElementRevisions(String id,
Boolean physical)
Delete all revisions of an app config element
Delete all revisions of an app config element.
|
retrofit2.Call<Message> |
deleteAllHealthDataDocumentationForParentId(String parentId)
Delete all documentation associated with given parentId
|
retrofit2.Call<Message> |
deleteAllParticipantDataForAdmin(String appId,
String userId)
Delete all participant data
Endpoint for admin to delete all participant data for the given participant.
|
retrofit2.Call<Message> |
deleteAllRevisionsOfUploadSchema(String schemaId,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
deleteAppConfig(String guid,
Boolean physical)
Delete an app config
Delete an existing configuration object.
|
retrofit2.Call<Message> |
deleteAppConfigElement(String id,
Long revision,
Boolean physical)
Delete an app config element
Delete an existing configuration element.
|
retrofit2.Call<Message> |
deleteAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
deleteAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting an assessment
|
retrofit2.Call<Message> |
deleteDataForAdmin(String appId,
String userId,
String identifier)
Delete a participant data
Endpoint for admin to delete a participnt data.
|
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> |
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> |
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<Message> |
deleteExternalId(String externalId)
Deprecated.
|
retrofit2.Call<Message> |
deleteFile(String guid,
Boolean physical)
Delete file resource (and all revisions)
Delete an existing file resource (and all its revisions, if the delete is physical).
|
retrofit2.Call<Message> |
deleteHealthDataDocumentationForIdentifier(String identifier)
Delete a health data documentation with the given identifier.
|
retrofit2.Call<Message> |
deleteMetadataByIdAllVersions(String moduleId,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
deleteMetadataByIdAndVersion(String moduleId,
Integer moduleVersion,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
deleteNotificationTopic(String guid,
Boolean physical)
Delete a notification topic
|
retrofit2.Call<Message> |
deleteOrganization(String orgId)
Delete an organization.
|
retrofit2.Call<Message> |
deleteParticipantReportIndex(String identifier)
Delete a participant report index
Delete a participant report index.
|
retrofit2.Call<Message> |
deletePermission(String guid)
Delete a permission record, removing a user's access to an entity.
|
retrofit2.Call<Message> |
deleteSchedule(String guid)
Delete a schedule.
|
retrofit2.Call<Message> |
deleteSchedulePlan(String schedulePlanGuid,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
deleteStudy(String studyId,
Boolean physical)
Delete a study.
|
retrofit2.Call<Message> |
deleteSubpopulation(String subpopulationGuid,
Boolean physical)
Delete a subpopulation
Delete a subpopulation unless it is a default subpopulation, which cannot be deleted.
|
retrofit2.Call<Message> |
deleteSurvey(String surveyGuid,
DateTime createdOn,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
deleteTemplate(String guid,
Boolean physical)
Delete template (and all revisions)
Delete an existing template (and all its revisions).
|
retrofit2.Call<Message> |
deleteUploadSchema(String schemaId,
Long revision,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
deleteUser(String userId)
Delete a user
This is a heavyweight operation; it is better to disable a user account when possible.
|
retrofit2.Call<Enrollment> |
enrollParticipant(String studyId,
Enrollment enrollment)
Enroll an account in a study as a participant.
|
retrofit2.Call<ForwardCursorStringList> |
getAllDataForAdminWorker(String appId,
String userId,
String offsetKey,
Integer pageSize)
Get list of identifiers for participant data
Endpoint for worker or admin to get a list of participant data identifiers.
|
retrofit2.Call<ParticipantData> |
getDataByIdentifierForAdminWorker(String appId,
String userId,
String identifier)
Get participant data by identifier
Endpoint for worker or admin to get a participant data.
|
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> |
getDemographicUserAppLevel(String userId)
Fetches all demographics for a user
Fetches all demographics for a user (app-level, done by app admin)
|
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<SmsMessage> |
getMostRecentSmsMessage(String userId)
Returns the most recent message sent to the phone number of the given user.
|
retrofit2.Call<PermissionDetailResourceList> |
getPermissionsForEntity(String entityType,
String entityId)
Get a set of permission records for an entity.
|
retrofit2.Call<PermissionDetailResourceList> |
getPermissionsForUser(String userId)
Get a set of permission records granted to a user.
|
retrofit2.Call<SchedulePlan> |
getSchedulePlan(String schedulePlanGuid)
Deprecated.
|
retrofit2.Call<DateTimeHolder> |
getSchedulerStatus()
Get the last time the scheduler ran
|
retrofit2.Call<StudyList> |
getStudies(Integer offsetBy,
Integer pageSize,
Boolean includeDeleted)
Get a list of the studies in this app
|
retrofit2.Call<Study> |
getStudy(String studyId)
Get a study
Get a study for this app.
|
retrofit2.Call<Upload> |
getUploadById(String uploadId)
Get an upload by ID
|
retrofit2.Call<Upload> |
getUploadByRecordId(String recordId)
Get an upload record by the health data record ID
A superadmin or worker can retrieve any upload in any app.
|
retrofit2.Call<UploadList> |
getUploads(DateTime startTime,
DateTime endTime,
Integer pageSize,
String offsetKey)
Get uploads for the app
|
retrofit2.Call<App> |
getUsersApp()
Get an app
Get the app of the currently signed in user account.
|
retrofit2.Call<Exporter3Configuration> |
initExporter3()
Initializes configs and Synapse resources for Exporter 3.0.
|
retrofit2.Call<Exporter3Configuration> |
initExporter3ForStudy(String studyId)
Initializes configs and Synapse resources for Exporter 3.0.
|
retrofit2.Call<Message> |
removeMember(String orgId,
String userId)
Remove a member from this organization (the user will no longer belong to any organization).
|
retrofit2.Call<Message> |
removeStudySponsor(String studyId,
String orgId)
Remove this organization as a sponsor
|
retrofit2.Call<Message> |
removeStudySponsorship(String orgId,
String studyId)
Stop sponsoring this study
|
retrofit2.Call<Message> |
saveDataForAdminWorker(String appId,
String userId,
String identifier,
ParticipantData participantData)
Save a participant data
Endpoint for worker or admin to save a participant data.
|
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> |
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> |
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<Message> |
sendNotificationToTopic(String guid,
NotificationMessage notificationMessage)
Send a push notification to all topic subscribers
|
retrofit2.Call<ExporterSubscriptionResult> |
subscribeToCreateStudyNotifications(ExporterSubscriptionRequest exporterSubscriptionRequest)
Subscribe to be notified when a study is initialized for Exporter 3.0 in caller's app.
|
retrofit2.Call<ExporterSubscriptionResult> |
subscribeToExportNotificationsForApp(ExporterSubscriptionRequest exporterSubscriptionRequest)
Subscribe to be notified when health data is exported to any Synapse projects in the app.
|
retrofit2.Call<ExporterSubscriptionResult> |
subscribeToExportNotificationsForStudy(String studyId,
ExporterSubscriptionRequest exporterSubscriptionRequest)
Subscribe to be notified when health data is exported to the study-specific Synapse project.
|
retrofit2.Call<Organization> |
updateOrganization(String orgId,
Organization organization)
Update an organization
Update an existing organization.
|
retrofit2.Call<PermissionDetail> |
updatePermission(String guid,
Permission permission)
Updates a permission record.
|
retrofit2.Call<VersionHolder> |
updateUsersApp(App app)
Update an app
Update the app of the currently signed in developer account.
|
@Headers(value="Content-Type:application/json") @POST(value="v1/organizations/{orgId}/members/{userId}") retrofit2.Call<Message> addMember(@Path(value="orgId") String orgId, @Path(value="userId") String userId)
orgId
- Organization ID (required)userId
- User ID (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/sponsors/{orgId}") retrofit2.Call<Message> addStudySponsor(@Path(value="studyId") String studyId, @Path(value="orgId") String orgId)
studyId
- Study identifier (required)orgId
- Organization ID (required)@Headers(value="Content-Type:application/json") @POST(value="v1/organizations/{orgId}/studies/{studyId}") retrofit2.Call<Message> addStudySponsorship(@Path(value="orgId") String orgId, @Path(value="studyId") String studyId)
orgId
- Organization ID (required)studyId
- Study identifier (required)@Headers(value="Content-Type:application/json") @POST(value="v1/organizations") retrofit2.Call<Organization> createOrganization(@Body Organization organization)
organization
- (required)@Headers(value="Content-Type:application/json") @POST(value="v1/permissions") retrofit2.Call<PermissionDetail> createPermission(@Body Permission permission)
permission
- (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies") retrofit2.Call<VersionHolder> createStudy(@Body Study study)
study
- New study (required)@Headers(value="Content-Type:application/json") @POST(value="v3/users") retrofit2.Call<UserSessionInfo> createUser(@Body SignUp signUp)
signUp
- New user (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/appconfigs/elements/{id}") retrofit2.Call<Message> deleteAllAppConfigElementRevisions(@Path(value="id") String id, @Query(value="physical") Boolean physical)
id
- An identifier (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/healthdatadocumentation") retrofit2.Call<Message> deleteAllHealthDataDocumentationForParentId(@Query(value="parentId") String parentId)
parentId
- The id used in place of appId, and in the future, studyId. (optional)@Headers(value="Content-Type:application/json") @DELETE(value="v1/apps/{appId}/participants/{userId}/data") retrofit2.Call<Message> deleteAllParticipantDataForAdmin(@Path(value="appId") String appId, @Path(value="userId") String userId)
appId
- App ID (required)userId
- User ID (required)@Deprecated @Headers(value="Content-Type:application/json") @DELETE(value="v3/uploadschemas/{schemaId}") retrofit2.Call<Message> deleteAllRevisionsOfUploadSchema(@Path(value="schemaId") String schemaId, @Query(value="physical") Boolean physical)
schemaId
- Upload schema ID (required)physical
- Physically delete the upload schema (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/appconfigs/{guid}") retrofit2.Call<Message> deleteAppConfig(@Path(value="guid") String guid, @Query(value="physical") Boolean physical)
guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/appconfigs/elements/{id}/revisions/{revision}") retrofit2.Call<Message> deleteAppConfigElement(@Path(value="id") String id, @Path(value="revision") Long revision, @Query(value="physical") Boolean physical)
id
- An identifier (required)revision
- Revision number (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v1/assessments/{guid}") retrofit2.Call<Message> deleteAssessment(@Path(value="guid") String guid, @Query(value="physical") Boolean physical)
guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v1/assessments/identifier:{assessmentId}/resources/{guid}") retrofit2.Call<Message> deleteAssessmentResource(@Path(value="assessmentId") String assessmentId, @Path(value="guid") String guid, @Query(value="physical") Boolean physical)
assessmentId
- The identifier for a stream of assessment revisions (required)guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v1/apps/{appId}/participants/{userId}/data/{identifier}") retrofit2.Call<Message> deleteDataForAdmin(@Path(value="appId") String appId, @Path(value="userId") String userId, @Path(value="identifier") String identifier)
appId
- App ID (required)userId
- User ID (required)identifier
- identifier (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="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="v3/participants/demographics/validation/{categoryName}") retrofit2.Call<Message> deleteDemographicsValidationConfigAppLevel(@Path(value="categoryName") String categoryName)
categoryName
- Name of a demographics category. (required)@Deprecated @Headers(value="Content-Type:application/json") @DELETE(value="v4/externalids/{externalId}") retrofit2.Call<Message> deleteExternalId(@Path(value="externalId") String externalId)
externalId
- User's external ID (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/files/{guid}") retrofit2.Call<Message> deleteFile(@Path(value="guid") String guid, @Query(value="physical") Boolean physical)
guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/healthdatadocumentation/{identifier}") retrofit2.Call<Message> deleteHealthDataDocumentationForIdentifier(@Path(value="identifier") String identifier)
identifier
- identifier (required)@Deprecated @Headers(value="Content-Type:application/json") @DELETE(value="v3/sharedmodules/metadata/{moduleId}/versions") retrofit2.Call<Message> deleteMetadataByIdAllVersions(@Path(value="moduleId") String moduleId, @Query(value="physical") Boolean physical)
moduleId
- Unique ID of the module. (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Deprecated @Headers(value="Content-Type:application/json") @DELETE(value="v3/sharedmodules/metadata/{moduleId}/versions/{moduleVersion}") retrofit2.Call<Message> deleteMetadataByIdAndVersion(@Path(value="moduleId") String moduleId, @Path(value="moduleVersion") Integer moduleVersion, @Query(value="physical") Boolean physical)
moduleId
- Unique ID of the module. (required)moduleVersion
- Module version. (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/topics/{guid}") retrofit2.Call<Message> deleteNotificationTopic(@Path(value="guid") String guid, @Query(value="physical") Boolean physical)
guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v1/organizations/{orgId}") retrofit2.Call<Message> deleteOrganization(@Path(value="orgId") String orgId)
orgId
- Organization ID (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/participants/reports/{identifier}") retrofit2.Call<Message> deleteParticipantReportIndex(@Path(value="identifier") String identifier)
identifier
- identifier (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/permissions/{guid}") retrofit2.Call<Message> deletePermission(@Path(value="guid") String guid)
guid
- A guid (required)@Headers(value="Content-Type:application/json") @DELETE(value="v5/schedules/{guid}") retrofit2.Call<Message> deleteSchedule(@Path(value="guid") String guid)
guid
- A guid (required)@Deprecated @Headers(value="Content-Type:application/json") @DELETE(value="v3/scheduleplans/{schedulePlanGuid}") retrofit2.Call<Message> deleteSchedulePlan(@Path(value="schedulePlanGuid") String schedulePlanGuid, @Query(value="physical") Boolean physical)
schedulePlanGuid
- Schedule plan GUID (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v5/studies/{studyId}") retrofit2.Call<Message> deleteStudy(@Path(value="studyId") String studyId, @Query(value="physical") Boolean physical)
studyId
- Study identifier (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/subpopulations/{subpopulationGuid}") retrofit2.Call<Message> deleteSubpopulation(@Path(value="subpopulationGuid") String subpopulationGuid, @Query(value="physical") Boolean physical)
subpopulationGuid
- Subpopulation GUID (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Deprecated @Headers(value="Content-Type:application/json") @DELETE(value="v3/surveys/{surveyGuid}/revisions/{createdOn}") retrofit2.Call<Message> deleteSurvey(@Path(value="surveyGuid") String surveyGuid, @Path(value="createdOn") DateTime createdOn, @Query(value="physical") Boolean physical)
surveyGuid
- Survey GUID (required)createdOn
- Created on timestamp (ISO 8601) (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/templates/{guid}") retrofit2.Call<Message> deleteTemplate(@Path(value="guid") String guid, @Query(value="physical") Boolean physical)
guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Deprecated @Headers(value="Content-Type:application/json") @DELETE(value="v3/uploadschemas/{schemaId}/revisions/{revision}") retrofit2.Call<Message> deleteUploadSchema(@Path(value="schemaId") String schemaId, @Path(value="revision") Long revision, @Query(value="physical") Boolean physical)
schemaId
- Upload schema ID (required)revision
- Revision number (required)physical
- Physically delete the upload schema (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v3/users/{userId}") retrofit2.Call<Message> deleteUser(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/enrollments") retrofit2.Call<Enrollment> enrollParticipant(@Path(value="studyId") String studyId, @Body Enrollment enrollment)
studyId
- Study identifier (required)enrollment
- Enrollment information for this user (required)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/{appId}/participants/{userId}/data") retrofit2.Call<ForwardCursorStringList> getAllDataForAdminWorker(@Path(value="appId") String appId, @Path(value="userId") String userId, @Query(value="offsetKey") String offsetKey, @Query(value="pageSize") Integer pageSize)
appId
- App ID (required)userId
- User ID (required)offsetKey
- next page start key for pagination (optional)pageSize
- maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/{appId}/participants/{userId}/data/{identifier}") retrofit2.Call<ParticipantData> getDataByIdentifierForAdminWorker(@Path(value="appId") String appId, @Path(value="userId") String userId, @Path(value="identifier") String identifier)
appId
- App ID (required)userId
- User ID (required)identifier
- identifier (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="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="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") @GET(value="v3/participants/{userId}/sms/recent") retrofit2.Call<SmsMessage> getMostRecentSmsMessage(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @GET(value="v1/permissions/{entityType}/{entityId}") retrofit2.Call<PermissionDetailResourceList> getPermissionsForEntity(@Path(value="entityType") String entityType, @Path(value="entityId") String entityId)
entityType
- The type of entity that a permission record is addressing. (required)entityId
- The ID of the entity that a permission record grants access to. (required)@Headers(value="Content-Type:application/json") @GET(value="v1/permissions/{userId}") retrofit2.Call<PermissionDetailResourceList> getPermissionsForUser(@Path(value="userId") String userId)
userId
- User ID (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/scheduleplans/{schedulePlanGuid}") retrofit2.Call<SchedulePlan> getSchedulePlan(@Path(value="schedulePlanGuid") String schedulePlanGuid)
schedulePlanGuid
- Schedule plan GUID (required)@Headers(value="Content-Type:application/json") @GET(value="v3/schedulerstatus") retrofit2.Call<DateTimeHolder> getSchedulerStatus()
@Headers(value="Content-Type:application/json") @GET(value="v5/studies") retrofit2.Call<StudyList> getStudies(@Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize, @Query(value="includeDeleted") Boolean includeDeleted)
offsetBy
- next page start offset for pagination (optional, default to 0)pageSize
- maximum number of records in each returned page (optional, default to 50)includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="v5/studies/{studyId}") retrofit2.Call<Study> getStudy(@Path(value="studyId") String studyId)
studyId
- Study identifier (required)@Headers(value="Content-Type:application/json") @GET(value="v3/uploads/{uploadId}") retrofit2.Call<Upload> getUploadById(@Path(value="uploadId") String uploadId)
uploadId
- Upload ID (required)@Headers(value="Content-Type:application/json") @GET(value="v3/uploads/recordId:{recordId}") retrofit2.Call<Upload> getUploadByRecordId(@Path(value="recordId") String recordId)
recordId
- Health data record ID (required)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/self/uploads") retrofit2.Call<UploadList> getUploads(@Query(value="startTime") DateTime startTime, @Query(value="endTime") DateTime endTime, @Query(value="pageSize") Integer pageSize, @Query(value="offsetKey") String offsetKey)
startTime
- (required)endTime
- (required)pageSize
- maximum number of records in each returned page (optional, default to 50)offsetKey
- next page start key for pagination (optional)@Headers(value="Content-Type:application/json") @GET(value="v1/apps/self") retrofit2.Call<App> getUsersApp()
@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self/exporter3") retrofit2.Call<Exporter3Configuration> initExporter3()
@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/exporter3") retrofit2.Call<Exporter3Configuration> initExporter3ForStudy(@Path(value="studyId") String studyId)
studyId
- Study identifier (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/organizations/{orgId}/members/{userId}") retrofit2.Call<Message> removeMember(@Path(value="orgId") String orgId, @Path(value="userId") String userId)
orgId
- Organization ID (required)userId
- User ID (required)@Headers(value="Content-Type:application/json") @DELETE(value="v5/studies/{studyId}/sponsors/{orgId}") retrofit2.Call<Message> removeStudySponsor(@Path(value="studyId") String studyId, @Path(value="orgId") String orgId)
studyId
- Study identifier (required)orgId
- Organization ID (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/organizations/{orgId}/studies/{studyId}") retrofit2.Call<Message> removeStudySponsorship(@Path(value="orgId") String orgId, @Path(value="studyId") String studyId)
orgId
- Organization ID (required)studyId
- Study identifier (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/{appId}/participants/{userId}/data/{identifier}") retrofit2.Call<Message> saveDataForAdminWorker(@Path(value="appId") String appId, @Path(value="userId") String userId, @Path(value="identifier") String identifier, @Body ParticipantData participantData)
appId
- App ID (required)userId
- User ID (required)identifier
- identifier (required)participantData
- (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="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="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)@Headers(value="Content-Type:application/json") @POST(value="v3/topics/{guid}/sendNotification") retrofit2.Call<Message> sendNotificationToTopic(@Path(value="guid") String guid, @Body NotificationMessage notificationMessage)
guid
- A guid (required)notificationMessage
- (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self/exporter3/notifications/study/subscribe") retrofit2.Call<ExporterSubscriptionResult> subscribeToCreateStudyNotifications(@Body ExporterSubscriptionRequest exporterSubscriptionRequest)
exporterSubscriptionRequest
- Subscription request attributes. (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self/exporter3/notifications/export/subscribe") retrofit2.Call<ExporterSubscriptionResult> subscribeToExportNotificationsForApp(@Body ExporterSubscriptionRequest exporterSubscriptionRequest)
exporterSubscriptionRequest
- Subscription request attributes. (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies/{studyId}/exporter3/notifications/export/subscribe") retrofit2.Call<ExporterSubscriptionResult> subscribeToExportNotificationsForStudy(@Path(value="studyId") String studyId, @Body ExporterSubscriptionRequest exporterSubscriptionRequest)
studyId
- Study identifier (required)exporterSubscriptionRequest
- Subscription request attributes. (required)@Headers(value="Content-Type:application/json") @POST(value="v1/organizations/{orgId}") retrofit2.Call<Organization> updateOrganization(@Path(value="orgId") String orgId, @Body Organization organization)
orgId
- Organization ID (required)organization
- (required)@Headers(value="Content-Type:application/json") @POST(value="v1/permissions/{guid}") retrofit2.Call<PermissionDetail> updatePermission(@Path(value="guid") String guid, @Body Permission permission)
guid
- A guid (required)permission
- (required)@Headers(value="Content-Type:application/json") @POST(value="v1/apps/self") retrofit2.Call<VersionHolder> updateUsersApp(@Body App app)
app
- (required)Copyright © 2023 Sage Bionetworks. All rights reserved.