ForDevelopersApi (REST Client 0.25.18 API)

```
public interface ForDevelopersApi
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`retrofit2.Call<StudyConsent>`	`addNewDefaultConsentRevision()` Deprecated.
`retrofit2.Call<Message>`	`addParticipantReportRecordV4(String userId, String identifier, ReportData reportData)` Add a participant report record The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.
`retrofit2.Call<Message>`	`addStudyReportRecord(String identifier, ReportData reportData)` Add a record to a study report Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.
`retrofit2.Call<Message>`	`createActivityEventForParticipant(String userId, CustomActivityEventRequest customActivityEventRequest)` Deprecated.
`retrofit2.Call<GuidVersionHolder>`	`createAppConfig(AppConfig appConfig)` Create a new app config Create a new app configuration object.
`retrofit2.Call<VersionHolder>`	`createAppConfigElement(AppConfigElement appConfigElement)` Create a new app config element Create a new app configuration element.
`retrofit2.Call<Assessment>`	`createAssessment(Assessment assessment)` Create a new assessment.
`retrofit2.Call<ExternalResource>`	`createAssessmentResource(String assessmentId, ExternalResource externalResource)` Create a new external resource link documenting an assessment
`retrofit2.Call<Assessment>`	`createAssessmentRevision(String guid, Assessment assessment)` Create a new revision of an assessment.
`retrofit2.Call<CompoundActivityDefinition>`	`createCompoundActivityDefinition(CompoundActivityDefinition compoundActivityDefinition)` Deprecated.
`retrofit2.Call<Message>`	`createConsent(String subpopulationGuid, StudyConsent studyConsent)` Add a new study consent version to this subpopulation
`retrofit2.Call<GuidVersionHolder>`	`createFile(FileMetadata fileMetadata)` Create a new file resource Create a new file resource (this is just the metadata, and will need to be followed by the creation and upload of a FileRevision object).
`retrofit2.Call<FileRevision>`	`createFileRevision(String guid, FileRevision fileRevision)` Create a new file resource revision.
`retrofit2.Call<SharedModuleMetadata>`	`createMetadata(SharedModuleMetadata sharedModuleMetadata)` Deprecated.
`retrofit2.Call<GuidHolder>`	`createNotificationTopic(NotificationTopic notificationTopic)` Create a notification topic Create a notification topic.
`retrofit2.Call<HealthDataDocumentation>`	`createOrUpdateHealthDataDocumentation(HealthDataDocumentation healthDataDocumentation)` Create or update health data documentation.
`retrofit2.Call<UploadSchema>`	`createOrUpdateUploadSchema(UploadSchema uploadSchema)` Deprecated.
`retrofit2.Call<IdentifierHolder>`	`createParticipant(SignUp signUp)` Create a new study participant (user) If the caller is a developer account, then the participant record will automatically be created as a test user (marked with the “test_user” data group).
`retrofit2.Call<GuidVersionHolder>`	`createSchedulePlan(SchedulePlan schedulePlan)` Deprecated.
`retrofit2.Call<FileRevision>`	`createStudyLogo(String studyId, FileRevision fileRevision)` Create a new study logo handle for uploading a study logo.
`retrofit2.Call<IdentifierHolder>`	`createStudyParticipant(String studyId, SignUp signUp)` Create a new study participant who will be enrolled (but not consented) in this study.
`retrofit2.Call<GuidVersionHolder>`	`createSubpopulation(Subpopulation subpopulation)` Create a new subpopulation
`retrofit2.Call<GuidCreatedOnVersionHolder>`	`createSurvey(Survey survey)` Deprecated.
`retrofit2.Call<Message>`	`createSynapseProjectTeam(List<String> string)` Create new Synapse project and team Create a new Synapse project and team for the provided Synapse user, and grant permissions to the Bridge exporter to export Bridge data into that app.
`retrofit2.Call<GuidVersionHolder>`	`createTemplate(Template template)` Create a new template Create a new template.
`retrofit2.Call<CreatedOnHolder>`	`createTemplateRevision(String guid, TemplateRevision templateRevision)` Create a new revision of a template
`retrofit2.Call<UploadSchema>`	`createUploadSchema(UploadSchema uploadSchema)` Deprecated.
`retrofit2.Call<AssessmentConfig>`	`customizeAssessmentConfig(String guid, Object customizationUpdate)` Submit updates to the config that conform to the allowed customizations for the assessment.
`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>`	`deleteAllParticipantReportRecords(String userId, String identifier)` Delete a participant report (all records)
`retrofit2.Call<Message>`	`deleteAllRevisionsOfUploadSchema(String schemaId, Boolean physical)` Deprecated.
`retrofit2.Call<Message>`	`deleteAllStudyReportRecords(String identifier)` Delete a study report (all records)
`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>`	`deleteCompoundActivityDefinition(String taskId)` Deprecated.
`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>`	`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>`	`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>`	`deleteParticipantReportRecord(String userId, String identifier, LocalDate date)` Delete a record for a specific day of a participant report
`retrofit2.Call<Message>`	`deleteSchedulePlan(String schedulePlanGuid, Boolean physical)` Deprecated.
`retrofit2.Call<Message>`	`deleteStudy(String studyId, Boolean physical)` Delete a study.
`retrofit2.Call<Message>`	`deleteStudyReportRecord(String identifier, LocalDate date)` Delete a record for a specific day of a study report
`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>`	`finishFileRevision(String guid, DateTime createdOn)` Indicate to the server that a file revision upload has been completed.
`retrofit2.Call<Study>`	`finishStudyLogoUpload(String studyId, DateTime createdOn)` Confirm with the Bridge server that the logo has been uploaded to S3.
`retrofit2.Call<AdherenceStatistics>`	`getAdherenceStatistics(String studyId, Integer adherenceThreshold)` Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.
`retrofit2.Call<AppConfigElementList>`	`getAllAppConfigElementRevisions(String id, Boolean includeDeleted)` Get all revisions for an app config element Get all revisions for an app config element.
`retrofit2.Call<CompoundActivityDefinitionList>`	`getAllCompoundActivityDefinitions()` Deprecated.
`retrofit2.Call<StudyConsentList>`	`getAllConsents(String subpopulationGuid)` Get a list of all consents for this subpopulation
`retrofit2.Call<StudyConsentList>`	`getAllDefaultConsentRevisions()` Deprecated.
`retrofit2.Call<HealthDataDocumentationList>`	`getAllHealthDataDocumentationForParentId(String parentId, String offsetKey, Integer pageSize)` Get all health data documentation by parentId.
`retrofit2.Call<UploadSchemaList>`	`getAllRevisionsOfUploadSchema(String schemaId, Boolean includeDeleted)` Deprecated.
`retrofit2.Call<SurveyList>`	`getAllVersionsOfSurvey(String surveyGuid, Boolean includeDeleted)` Deprecated.
`retrofit2.Call<AppConfig>`	`getAppConfig(String guid)` Get an app config Get an configuration object for this app.
`retrofit2.Call<AppConfigElement>`	`getAppConfigElement(String id, Long revision)` Get an app config element Get an app configuration element for this app.
`retrofit2.Call<AppConfigList>`	`getAppConfigs(Boolean includeDeleted)` Get a list of the app's configurations Get all the configuration objects for this app.
`retrofit2.Call<EmailVerificationStatus>`	`getAppEmailStatus()` SES email verification status Consents will be emailed from the support email address you provide.
`retrofit2.Call<CmsPublicKey>`	`getAppPublicCsmKey()` Get the public key CMS block for this app
`retrofit2.Call<Assessment>`	`getAssessmentByGUID(String guid)` Get a specific assessment revision.
`retrofit2.Call<Assessment>`	`getAssessmentById(String identifier, Long revision)` Get an assessment revision by identifier and revision number.
`retrofit2.Call<AssessmentConfig>`	`getAssessmentConfig(String guid)` Get the JSON config for this assessment.
`retrofit2.Call<ExternalResource>`	`getAssessmentResource(String assessmentId, String guid)` Get an assessment external resource description
`retrofit2.Call<PagedExternalResourceList>`	`getAssessmentResources(String assessmentId, Integer offsetBy, Integer pageSize, List<String> category, Integer minRevision, Integer maxRevision, Boolean includeDeleted)` Get the external resource links documenting an assessment
`retrofit2.Call<AssessmentList>`	`getAssessmentRevisionsByGUID(String guid, Integer offsetBy, Integer pageSize, Boolean includeDeleted)` Get the revisions of an assessment with a specific identifier.
`retrofit2.Call<AssessmentList>`	`getAssessmentRevisionsById(String identifier, Integer offsetBy, Integer pageSize, Boolean includeDeleted)` Get the revisions for an assessment by its identifier.
`retrofit2.Call<AssessmentList>`	`getAssessments(Integer offsetBy, Integer pageSize, List<String> tag, Boolean includeDeleted)` Get assessments in the app context.
`retrofit2.Call<CompoundActivityDefinition>`	`getCompoundActivityDefinition(String taskId)` Deprecated.
`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>`	`getDefaultConsentRevision(DateTime createdOn)` Deprecated.
`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<EnrollmentDetailList>`	`getEnrollmentsForUser(String userId)` Get enrollment records for this user
`retrofit2.Call<FileMetadata>`	`getFile(String guid)` Get a file resource Get a file resource for this app.
`retrofit2.Call<FileRevision>`	`getFileRevision(String guid, DateTime createdOn)` Get a single file revision of a file.
`retrofit2.Call<FileRevisionList>`	`getFileRevisions(String guid, Integer offsetBy, Integer pageSize)` Get the revision history of a file resource Get the paginated revision history of a file resource.
`retrofit2.Call<FileMetadataList>`	`getFiles(Integer offsetBy, Integer pageSize, Boolean includeDeleted)` Get a list of static files Get all the files of a specific type for this app.
`retrofit2.Call<HealthDataDocumentation>`	`getHealthDataDocumentationForId(String identifier)` Get a health data documentation with the given identifier This endpoint can be called by researchers and developers to get a specific documentation by identifier.
`retrofit2.Call<Assessment>`	`getLatestAssessmentRevision(String identifier)` Get the latest version of an assessment.
`retrofit2.Call<SharedModuleMetadata>`	`getMetadataByIdAndVersion(String moduleId, Integer moduleVersion)` Deprecated.
`retrofit2.Call<SharedModuleMetadata>`	`getMetadataByIdLatestVersion(String moduleId)` Deprecated.
`retrofit2.Call<AppConfigElement>`	`getMostRecentAppConfigElement(String id)` Get most recent app config element Get most recently app config element.
`retrofit2.Call<AppConfigElementList>`	`getMostRecentAppConfigElements(Boolean includeDeleted)` Get a list of the most recent revision of each configuration element in the app Get a list of the app configuration elements in the app, returning the highest revision number for each element in the app.
`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>`	`getMostRecentDefaultConsentRevision()` Deprecated.
`retrofit2.Call<SurveyList>`	`getMostRecentSurveys(Boolean includeDeleted)` Deprecated.
`retrofit2.Call<Survey>`	`getMostRecentSurveyVersion(String surveyGuid)` Deprecated.
`retrofit2.Call<UploadSchema>`	`getMostRecentUploadSchema(String schemaId)` Deprecated.
`retrofit2.Call<UploadSchemaList>`	`getMostRecentUploadSchemas(Boolean includeDeleted)` Deprecated.
`retrofit2.Call<NotificationTopic>`	`getNotificationTopic(String guid)` Get a notification topic
`retrofit2.Call<NotificationTopicList>`	`getNotificationTopics(Boolean includeDeleted)` Get all the notification topics in this app Return all the topics defined for this app.
`retrofit2.Call<StudyConsent>`	`getPublishedConsent(String subpopulationGuid)` Get the published consent revision Get the published revision of this subpopulation consent.
`retrofit2.Call<StudyConsent>`	`getPublishedDefaultConsentRevision()` Deprecated.
`retrofit2.Call<SurveyList>`	`getPublishedSurveys(Boolean includeDeleted)` Deprecated.
`retrofit2.Call<Survey>`	`getPublishedSurveyVersion(String surveyGuid)` Deprecated.
`retrofit2.Call<Schedule2>`	`getScheduleForStudy(String studyId)` Get the schedule for this study.
`retrofit2.Call<SchedulePlan>`	`getSchedulePlan(String schedulePlanGuid)` Deprecated.
`retrofit2.Call<SchedulePlanList>`	`getSchedulePlans(Boolean includeDeleted)` Deprecated.
`retrofit2.Call<OrganizationList>`	`getSponsors(String studyId, Integer offsetBy, Integer pageSize)` Get the sponsors of this study.
`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<StudyAdherenceReport>`	`getStudyParticipantAdherenceReport(String studyId, String userId)` Get a detailed report on a participant’s full schedule of activities.
`retrofit2.Call<EventStreamAdherenceReport>`	`getStudyParticipantEventStreamAdherenceReport(String studyId, String userId, DateTime datetime, Boolean activeOnly)` Get a detailed report on a participant’s adherence to the entire study protocol’s schedule.
`retrofit2.Call<AccountSummaryList>`	`getStudyParticipants(String studyId, AccountSummarySearch accountSummarySearch)` Search for account summaries of study participants.
`retrofit2.Call<ReportIndex>`	`getStudyReportIndex(String identifier)` Get a report index Get the index (or metadata) for a set of report records.
`retrofit2.Call<Subpopulation>`	`getSubpopulation(String subpopulationGuid)` Get a subpopulation
`retrofit2.Call<SubpopulationList>`	`getSubpopulations(Boolean includeDeleted)` Get all subpopulations in this app.
`retrofit2.Call<Survey>`	`getSurvey(String surveyGuid, DateTime createdOn)` Deprecated.
`retrofit2.Call<Template>`	`getTemplate(String guid)` Get a template Get a template for this app.
`retrofit2.Call<TemplateRevision>`	`getTemplateRevision(String guid, DateTime createdOn)` Get a single template document revision
`retrofit2.Call<TemplateRevisionList>`	`getTemplateRevisions(String guid, Integer offsetBy, Integer pageSize)` Get the template document revisions
`retrofit2.Call<TemplateList>`	`getTemplates(String type, Integer offsetBy, Integer pageSize, Boolean includeDeleted)` Get a list of templates of a specific type Get all the templates of a specific type for this app.
`retrofit2.Call<Timeline>`	`getTimelineForStudy(String studyId)` Get the timeline associated to this study through its schedule.
`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<UploadSchema>`	`getUploadSchema(String schemaId, Long revision)` Deprecated.
`retrofit2.Call<App>`	`getUsersApp()` Get an app Get the app of the currently signed in user account.
`retrofit2.Call<WeeklyAdherenceReport>`	`getWeeklyAdherenceReport(String studyId, String userId)` Get a detailed report on a participant’s current week of scheduled activities.
`retrofit2.Call<WeeklyAdherenceReportList>`	`getWeeklyAdherenceReports(String studyId, AdherenceReportSearch adherenceReportSearch)` Get the adherence for all study participants in their current week of the study.
`retrofit2.Call<SharedModuleImportStatus>`	`importModuleByIdAndVersion(String moduleId, Integer moduleVersion)` Deprecated.
`retrofit2.Call<SharedModuleImportStatus>`	`importModuleByIdLatestPublishedVersion(String moduleId)` Deprecated.
`retrofit2.Call<Assessment>`	`importSharedAssessment(String guid, String ownerId, String newIdentifier)` Import an assessment revision into the local app context.
`retrofit2.Call<ExternalResourceList>`	`importSharedAssessmentResource(String assessmentId, List<String> externalResourceGUIDs)` Copy these shared resources to your app context The shared assessment these resources relate to must have been imported at least one time to the local app context before the resources can be imported.
`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<Assessment>`	`publishAssessment(String guid, String newIdentifier)` Publish an assessment revision in the shared library.
`retrofit2.Call<ExternalResourceList>`	`publishAssessmentResource(String assessmentId, List<String> externalResourceGUIDs)` Copy these resources to the shared assessments library.
`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.
`retrofit2.Call<GuidCreatedOnVersionHolder>`	`publishSurvey(String surveyGuid, DateTime createdOn, Boolean newSchemaRev)` Deprecated.
`retrofit2.Call<Message>`	`publishTemplateRevision(String guid, DateTime createdOn)` Set a specific template revision as the version to use when the template is selected
`retrofit2.Call<SharedModuleMetadataList>`	`queryAllMetadata(Boolean mostrecent, Boolean published, String name, String notes, String tags, Boolean includeDeleted)` Deprecated.
`retrofit2.Call<SharedModuleMetadataList>`	`queryMetadataById(String moduleId, Boolean mostrecent, Boolean published, String name, String notes, String tags, Boolean includeDeleted)` Deprecated.
`retrofit2.Call<Message>`	`resendVerifyEmail(String type)` Resends the verification email for the app's email.
`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<Schedule2>`	`saveScheduleForStudy(String studyId, Schedule2 schedule)` Create or update a schedule associated with a study.
`retrofit2.Call<AccountSummaryList>`	`searchAccountSummaries(AccountSummarySearch accountSummarySearch)` Search for account summaries (participants) For developers, this API only returns test accounts (accounts marked with the “test_user” data group).
`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<GuidVersionHolder>`	`updateAppConfig(String guid, AppConfig appConfig)` Update an existing app config Update an existing app configuration.
`retrofit2.Call<VersionHolder>`	`updateAppConfigElement(String id, Long revision, AppConfigElement appConfigElement)` Update an existing app config element Update an existing app configuration element.
`retrofit2.Call<Assessment>`	`updateAssessment(String guid, Assessment assessment)` Update an assessment revision.
`retrofit2.Call<AssessmentConfig>`	`updateAssessmentConfig(String guid, AssessmentConfig assessmentConfig)` Update the JSON config for this assessment.
`retrofit2.Call<ExternalResource>`	`updateAssessmentResource(String assessmentId, String guid, ExternalResource externalResource)` Update an external resource link documenting an assessment
`retrofit2.Call<CompoundActivityDefinition>`	`updateCompoundActivityDefinition(String taskId, CompoundActivityDefinition compoundActivityDefinition)` Deprecated.
`retrofit2.Call<Message>`	`updateEnrollment(String studyId, String userId, Enrollment enrollment)` Update a participant's enrollment record for a study Developers and Study Designers can only update test accounts.
`retrofit2.Call<GuidVersionHolder>`	`updateFile(String guid, FileMetadata file)` Update an existing file resource Update an existing file resource.
`retrofit2.Call<SharedModuleMetadata>`	`updateMetadata(String moduleId, Integer moduleVersion, SharedModuleMetadata sharedModuleMetadata)` Deprecated.
`retrofit2.Call<GuidHolder>`	`updateNotificationTopic(String guid, NotificationTopic notificationTopic)` Update a notification topic
`retrofit2.Call<GuidVersionHolder>`	`updateSchedulePlan(String schedulePlanGuid, SchedulePlan schedulePlan)` Deprecated.
`retrofit2.Call<Assessment>`	`updateSharedAssessment(String guid, Assessment assessment)` Update an assessment revision.
`retrofit2.Call<ExternalResource>`	`updateSharedAssessmentResource(String assessmentId, String guid, ExternalResource externalResource)` Update an external resource link documenting a shared assessment
`retrofit2.Call<VersionHolder>`	`updateStudy(String studyId, Study study)` Update an existing study Update an existing study
`retrofit2.Call<Message>`	`updateStudyParticipantAdherenceRecords(String studyId, String userId, AdherenceRecordUpdates adherenceRecordUpdates)` Update one or more adherence records for a participant
`retrofit2.Call<Message>`	`updateStudyReportIndex(String identifier, ReportIndex reportIndex)` Update an existing study report index Update the index (or metadata) for a set of report records.
`retrofit2.Call<GuidVersionHolder>`	`updateSubpopulation(String subpopulationGuid, Subpopulation subpopulation)` Update an existing subpopulation
`retrofit2.Call<GuidCreatedOnVersionHolder>`	`updateSurvey(String surveyGuid, DateTime createdOn, Survey survey)` Deprecated.
`retrofit2.Call<GuidVersionHolder>`	`updateTemplate(String guid, Template template)` Update an existing template Update an existing template.
`retrofit2.Call<UploadSchema>`	`updateUploadSchema(String schemaId, Long revision, UploadSchema uploadSchema)` Deprecated.
`retrofit2.Call<VersionHolder>`	`updateUsersApp(App app)` Update an app Update the app of the currently signed in developer account.
`retrofit2.Call<Message>`	`verifyEmailForApp(String appId, String token, String type)` Verifies the app's email Verifies the app's email.
`retrofit2.Call<EmailVerificationStatus>`	`verifySenderEmail()` Trigger SES email verification process Amazon SES will attempt to verify that it can send email from your support email address.
`retrofit2.Call<GuidCreatedOnVersionHolder>`	`versionSurvey(String surveyGuid, DateTime createdOn)` Deprecated.

Method Detail

addNewDefaultConsentRevision

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/consents")
retrofit2.Call<StudyConsent> addNewDefaultConsentRevision()

Deprecated.

Add new consent revision to the app's default subpopulation

Returns:: Call<StudyConsent>

addParticipantReportRecordV4

@Headers(value="Content-Type:application/json")
 @POST(value="v4/participants/{userId}/reports/{identifier}")
retrofit2.Call<Message> addParticipantReportRecordV4(@Path(value="userId")
                                                                                                                                                                   String userId,
                                                                                                                                                                   @Path(value="identifier")
                                                                                                                                                                   String identifier,
                                                                                                                                                                   @Body
                                                                                                                                                                   ReportData reportData)

Add a participant report record The report can be accessed if the participant is requesting their own report, or the caller is a researcher, worker, or admin, or the caller is a study coordinator for a study that includes the participant.

Parameters:: userId - User ID (required); identifier - identifier (required); reportData - (required)
Returns:: Call<Message>

addStudyReportRecord

@Headers(value="Content-Type:application/json")
 @POST(value="v4/reports/{identifier}")
retrofit2.Call<Message> addStudyReportRecord(@Path(value="identifier")
                                                                                                                                     String identifier,
                                                                                                                                     @Body
                                                                                                                                     ReportData reportData)

Add a record to a study report Any member of an organization sponsoring a study, or any app-scoped administrative user, can access a study report.

Parameters:: identifier - identifier (required); reportData - Report data (required)
Returns:: Call<Message>

createActivityEventForParticipant

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/{userId}/activityevents")
retrofit2.Call<Message> createActivityEventForParticipant(@Path(value="userId")
                                                                                                                                                                               String userId,
                                                                                                                                                                               @Body
                                                                                                                                                                               CustomActivityEventRequest customActivityEventRequest)

Deprecated.

Create a custom event for a participant This endpoint can be called by researchers in order to create an activity event for a participant. This is an event name and a timestamp for the event. A 201 is returned whether the event updates or not, to support concurrent and out-of-order POSTs from the client.

Parameters:: userId - (required); customActivityEventRequest - (required)
Returns:: Call<Message>

createAppConfig

@Headers(value="Content-Type:application/json")
 @POST(value="v3/appconfigs")
retrofit2.Call<GuidVersionHolder> createAppConfig(@Body
                                                                                                                                AppConfig appConfig)

Create a new app config Create a new app configuration object. If you submit an existing app configuration to this endpoint, it will be copied.

Parameters:: appConfig - New app configuration (required)
Returns:: Call<GuidVersionHolder>

createAppConfigElement

@Headers(value="Content-Type:application/json")
 @POST(value="v3/appconfigs/elements")
retrofit2.Call<VersionHolder> createAppConfigElement(@Body
                                                                                                                                            AppConfigElement appConfigElement)

Create a new app config element Create a new app configuration element. If you submit an existing app configuration element to this endpoint, it will be copied.

Parameters:: appConfigElement - New app configuration element (required)
Returns:: Call<VersionHolder>

createAssessment
```
@Headers(value="Content-Type:application/json")
 @POST(value="v1/assessments")
retrofit2.Call<Assessment> createAssessment(@Body
                                                                                                                           Assessment assessment)
```
Create a new assessment. This assessment must have a unique identifier in the app context (if the identifier is not unique, call the `createAssessmentRevision` API to create a new revision of an existing assessment). The assessment must specify one of the caller’s organizational IDs; this organization owns the new assessment and only members of that organization can update the assessment further.

Parameters:

assessment - (required)

Returns:

Call<Assessment>

createAssessmentResource

@Headers(value="Content-Type:application/json")
 @POST(value="v1/assessments/identifier:{assessmentId}/resources")
retrofit2.Call<ExternalResource> createAssessmentResource(@Path(value="assessmentId")
                                                                                                                                                                             String assessmentId,
                                                                                                                                                                             @Body
                                                                                                                                                                             ExternalResource externalResource)

Create a new external resource link documenting an assessment

Parameters:: assessmentId - The identifier for a stream of assessment revisions (required); externalResource - Assessment resource (required)
Returns:: Call<ExternalResource>

createAssessmentRevision

@Headers(value="Content-Type:application/json")
 @POST(value="v1/assessments/{guid}/revisions")
retrofit2.Call<Assessment> createAssessmentRevision(@Path(value="guid")
                                                                                                                                                    String guid,
                                                                                                                                                    @Body
                                                                                                                                                    Assessment assessment)

Create a new revision of an assessment. The identifier of the assessment must already exist (and the revision number of this assessment must be unique). This operation returns the new assessment revision.

Parameters:: guid - A guid (required); assessment - (required)
Returns:: Call<Assessment>

createCompoundActivityDefinition

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/compoundactivitydefinitions")
retrofit2.Call<CompoundActivityDefinition> createCompoundActivityDefinition(@Body
                                                                                                                                                                                        CompoundActivityDefinition compoundActivityDefinition)

Deprecated.

Create a compound activity definition

Parameters:: compoundActivityDefinition - (required)
Returns:: Call<CompoundActivityDefinition>

createConsent

@Headers(value="Content-Type:application/json")
 @POST(value="v3/subpopulations/{subpopulationGuid}/consents")
retrofit2.Call<Message> createConsent(@Path(value="subpopulationGuid")
                                                                                                                                                     String subpopulationGuid,
                                                                                                                                                     @Body
                                                                                                                                                     StudyConsent studyConsent)

Add a new study consent version to this subpopulation

Parameters:: subpopulationGuid - Subpopulation GUID (required); studyConsent - Study consent (required)
Returns:: Call<Message>

createFile

@Headers(value="Content-Type:application/json")
 @POST(value="v3/files")
retrofit2.Call<GuidVersionHolder> createFile(@Body
                                                                                                                      FileMetadata fileMetadata)

Create a new file resource Create a new file resource (this is just the metadata, and will need to be followed by the creation and upload of a FileRevision object).

Parameters:: fileMetadata - New file (required)
Returns:: Call<GuidVersionHolder>

createFileRevision

@Headers(value="Content-Type:application/json")
 @POST(value="v3/files/{guid}/revisions")
retrofit2.Call<FileRevision> createFileRevision(@Path(value="guid")
                                                                                                                                          String guid,
                                                                                                                                          @Body
                                                                                                                                          FileRevision fileRevision)

Create a new file resource revision. Create a new file resource revision. The record returned contains the `uploadURL` field, where the resource must be PUT using an HTTP library with the following two headers: - **Content-Type** The mime type of the resource that was posted to this endpoint; - **Content-Disposition** A content disposition header with the value of `attachment; filename=\"name\"` where the name is the name included in the revision object posted to this endpoint. This upload URL expires in 10 minutes. When this upload has been completed, the client should then call the `finishFileRevision` API (these steps are also encapsulated in the `RestUtils.uploadHostedFileToS3` method).

Parameters:: guid - A guid (required); fileRevision - New file revision (required)
Returns:: Call<FileRevision>

createMetadata

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/sharedmodules/metadata")
retrofit2.Call<SharedModuleMetadata> createMetadata(@Body
                                                                                                                                                           SharedModuleMetadata sharedModuleMetadata)

Deprecated.

Creates the specified module metadata.

Parameters:: sharedModuleMetadata - (required)
Returns:: Call<SharedModuleMetadata>

createNotificationTopic

@Headers(value="Content-Type:application/json")
 @POST(value="v3/topics")
retrofit2.Call<GuidHolder> createNotificationTopic(@Body
                                                                                                                             NotificationTopic notificationTopic)

Create a notification topic Create a notification topic. No participant is initially subscribed to a topic when it is created; users must be given the means to subscribe to a topic in the application.

Parameters:: notificationTopic - (required)
Returns:: Call<GuidHolder>

createOrUpdateHealthDataDocumentation

@Headers(value="Content-Type:application/json")
 @POST(value="v3/healthdatadocumentation")
retrofit2.Call<HealthDataDocumentation> createOrUpdateHealthDataDocumentation(@Body
                                                                                                                                                                         HealthDataDocumentation healthDataDocumentation)

Create or update health data documentation.

Parameters:: healthDataDocumentation - Health data documentation submitted by the user (required)
Returns:: Call<HealthDataDocumentation>

createOrUpdateUploadSchema

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/uploadschemas")
retrofit2.Call<UploadSchema> createOrUpdateUploadSchema(@Body
                                                                                                                                                      UploadSchema uploadSchema)

Deprecated.

Create or update an upload schema

Parameters:: uploadSchema - (required)
Returns:: Call<UploadSchema>

createParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants")
retrofit2.Call<IdentifierHolder> createParticipant(@Body
                                                                                                                                   SignUp signUp)

Create a new study participant (user) If the caller is a developer account, then the participant record will automatically be created as a test user (marked with the “test_user” data group).

Parameters:: signUp - Sign up (required)
Returns:: Call<IdentifierHolder>

createSchedulePlan

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/scheduleplans")
retrofit2.Call<GuidVersionHolder> createSchedulePlan(@Body
                                                                                                                                                   SchedulePlan schedulePlan)

Deprecated.

Create a schedule plan

Parameters:: schedulePlan - (required)
Returns:: Call<GuidVersionHolder>

createStudyLogo
```
@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/logo")
retrofit2.Call<FileRevision> createStudyLogo(@Path(value="studyId")
                                                                                                                                       String studyId,
                                                                                                                                       @Body
                                                                                                                                       FileRevision fileRevision)
```
Create a new study logo handle for uploading a study logo. Create a new logo revision. The record returned contains the `uploadURL` field, where the logo must be PUT using an HTTP library with the following two headers: - **Content-Type** The mime type of the resource that was posted to this endpoint; - **Content-Disposition** A content disposition header with the value of `inline`. This upload URL expires in 10 minutes. When this upload has been completed, the client should then call the `finishLogoUpload` API (these steps are also encapsulated in the `RestUtils.uploadStudyLogoToS3` method). The `createdOn` value from the FileRevision object returned by this request should be used to call this finish method. Thereafter, an URL to download the logo will be available in the study’s `studyLogoUrl` field. A new logo can be uploaded by repeating this process.

Parameters:

studyId - Study identifier (required)

fileRevision - New file revision (required)

Returns:

Call<FileRevision>

createStudyParticipant

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants")
retrofit2.Call<IdentifierHolder> createStudyParticipant(@Path(value="studyId")
                                                                                                                                                          String studyId,
                                                                                                                                                          @Body
                                                                                                                                                          SignUp signUp)

Create a new study participant who will be enrolled (but not consented) in this study. If the caller is a developer or study designer account, then the participant record will automatically be created as a test user (marked with the “test_user” data group).

Parameters:: studyId - Study identifier (required); signUp - Sign up (required)
Returns:: Call<IdentifierHolder>

createSubpopulation

@Headers(value="Content-Type:application/json")
 @POST(value="v3/subpopulations")
retrofit2.Call<GuidVersionHolder> createSubpopulation(@Body
                                                                                                                                        Subpopulation subpopulation)

Create a new subpopulation

Parameters:: subpopulation - New subpopulation (required)
Returns:: Call<GuidVersionHolder>

createSurvey

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/surveys")
retrofit2.Call<GuidCreatedOnVersionHolder> createSurvey(@Body
                                                                                                                                                Survey survey)

Deprecated.

Create a new survey

Parameters:: survey - (required)
Returns:: Call<GuidCreatedOnVersionHolder>

createSynapseProjectTeam
```
@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/self/synapseProject")
retrofit2.Call<Message> createSynapseProjectTeam(@Body
                                                                                                                                             List<String> string)
```
Create new Synapse project and team Create a new Synapse project and team for the provided Synapse user, and grant permissions to the Bridge exporter to export Bridge data into that app. This call also grants admin permissions to the specified Synapse user for that project and team. You will need to create a Synapse user first, and provide that user's ID to this endpoint call.

Parameters:

string - (required)

Returns:

Call<Message>

createTemplate

@Headers(value="Content-Type:application/json")
 @POST(value="v3/templates")
retrofit2.Call<GuidVersionHolder> createTemplate(@Body
                                                                                                                              Template template)

Create a new template Create a new template.

Parameters:: template - New template (required)
Returns:: Call<GuidVersionHolder>

createTemplateRevision

@Headers(value="Content-Type:application/json")
 @POST(value="v3/templates/{guid}/revisions")
retrofit2.Call<CreatedOnHolder> createTemplateRevision(@Path(value="guid")
                                                                                                                                                     String guid,
                                                                                                                                                     @Body
                                                                                                                                                     TemplateRevision templateRevision)

Create a new revision of a template

Parameters:: guid - A guid (required); templateRevision - (required)
Returns:: Call<CreatedOnHolder>

createUploadSchema

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v4/uploadschemas")
retrofit2.Call<UploadSchema> createUploadSchema(@Body
                                                                                                                                              UploadSchema uploadSchema)

Deprecated.

Create an upload schema

Parameters:: uploadSchema - (required)
Returns:: Call<UploadSchema>

customizeAssessmentConfig

@Headers(value="Content-Type:application/json")
 @POST(value="v1/assessments/{guid}/config/customize")
retrofit2.Call<AssessmentConfig> customizeAssessmentConfig(@Path(value="guid")
                                                                                                                                                                  String guid,
                                                                                                                                                                  @Body
                                                                                                                                                                  Object customizationUpdate)

Submit updates to the config that conform to the allowed customizations for the assessment. Submit updates to the config that conform to the allowed customizations for the assessment. The object submitted to the server should be of the type `Map<String, Map<String, JsonNode>>`, where the first map associates a node identifier in the configuration to a map, and the second map associates one or more named properties of the node to a JsonNode update. This value can be of any type representable in JSON, since the server will persist it as part of the JSON configuration without type conversion (the update should still follow the schema of the configuration, or the client will not be able to interpret your configuration change).

Parameters:: guid - A guid (required); customizationUpdate - (required)
Returns:: Call<AssessmentConfig>

deleteAllAppConfigElementRevisions

@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)

Delete all revisions of an app config element Delete all revisions of an app config element.

Parameters:: id - An identifier (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteAllParticipantReportRecords

@Headers(value="Content-Type:application/json")
 @DELETE(value="v4/participants/{userId}/reports/{identifier}")
retrofit2.Call<Message> deleteAllParticipantReportRecords(@Path(value="userId")
                                                                                                                                                                          String userId,
                                                                                                                                                                          @Path(value="identifier")
                                                                                                                                                                          String identifier)

Delete a participant report (all records)

Parameters:: userId - User ID (required); identifier - identifier (required)
Returns:: Call<Message>

deleteAllRevisionsOfUploadSchema

@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)

Deprecated.

Delete all revisions of an upload schema

Parameters:: schemaId - Upload schema ID (required); physical - Physically delete the upload schema (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteAllStudyReportRecords

@Headers(value="Content-Type:application/json")
 @DELETE(value="v4/reports/{identifier}")
retrofit2.Call<Message> deleteAllStudyReportRecords(@Path(value="identifier")
                                                                                                                                              String identifier)

Delete a study report (all records)

Parameters:: identifier - identifier (required)
Returns:: Call<Message>

deleteAppConfig

@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)

Delete an app config Delete an existing configuration object.

Parameters:: guid - A guid (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteAppConfigElement

@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)

Delete an app config element Delete an existing configuration element.

Parameters:: 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)
Returns:: Call<Message>

deleteAssessment

@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)

Delete an assessment revision. A GUID uniquely identifies a specific assessment revision. Only developers who are members of the organization that owns the assessment may logically delete it, though a study admin may physically delete an assessment regardless of ownership.

Parameters:: guid - A guid (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteAssessmentResource

@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)

Delete an external resource link documenting an assessment

Parameters:: 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)
Returns:: Call<Message>

deleteCompoundActivityDefinition

@Deprecated
 @Headers(value="Content-Type:application/json")
 @DELETE(value="v3/compoundactivitydefinitions/{taskId}")
retrofit2.Call<Message> deleteCompoundActivityDefinition(@Path(value="taskId")
                                                                                                                                                                                String taskId)

Deprecated.

Delete a compound activity definition

Parameters:: taskId - Task ID (required)
Returns:: Call<Message>

deleteDemographicsValidationConfig

@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)

Delete a DemographicValuesValidationConfig Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation.

Parameters:: studyId - Study identifier (required); categoryName - Name of a demographics category. (required)
Returns:: Call<Message>

deleteDemographicsValidationConfigAppLevel

@Headers(value="Content-Type:application/json")
 @DELETE(value="v3/participants/demographics/validation/{categoryName}")
retrofit2.Call<Message> deleteDemographicsValidationConfigAppLevel(@Path(value="categoryName")
                                                                                                                                                                                            String categoryName)

Delete a DemographicValuesValidationConfig at the app level Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation for app-level demographics.

Parameters:: categoryName - Name of a demographics category. (required)
Returns:: Call<Message>

deleteFile

@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)

Delete file resource (and all revisions) Delete an existing file resource (and all its revisions, if the delete is physical).

Parameters:: guid - A guid (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteMetadataByIdAllVersions

@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)

Deprecated.

Deletes all metadata for module versions with the given ID.

Parameters:: moduleId - Unique ID of the module. (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteMetadataByIdAndVersion

@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)

Deprecated.

Deletes metadata for the specified module ID and version.

Parameters:: 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)
Returns:: Call<Message>

deleteNotificationTopic

@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)

Delete a notification topic

Parameters:: guid - A guid (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteParticipantReportRecord

@Headers(value="Content-Type:application/json")
 @DELETE(value="v3/participants/{userId}/reports/{identifier}/{date}")
retrofit2.Call<Message> deleteParticipantReportRecord(@Path(value="userId")
                                                                                                                                                                             String userId,
                                                                                                                                                                             @Path(value="identifier")
                                                                                                                                                                             String identifier,
                                                                                                                                                                             @Path(value="date")
                                                                                                                                                                             LocalDate date)

Delete a record for a specific day of a participant report

Parameters:: userId - User ID (required); identifier - identifier (required); date - Date of records (required)
Returns:: Call<Message>

deleteSchedulePlan

@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)

Deprecated.

Get a schedule plan

Parameters:: schedulePlanGuid - Schedule plan GUID (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteStudy

@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)

Delete a study. Developers and study designers can logically or physically delete a study if it is in the “legacy,” “design,” “completed,” or “withdrawn” phases. Admins can logically or physically delete a study at any lifecycle phase. All study participants are unassociated with the study (not withdrawn), so this should only be done on a study that has not yet been used, or that is completed with no further need to identify study participants. Delete an existing study

Parameters:: studyId - Study identifier (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteStudyReportRecord

@Headers(value="Content-Type:application/json")
 @DELETE(value="v3/reports/{identifier}/{date}")
retrofit2.Call<Message> deleteStudyReportRecord(@Path(value="identifier")
                                                                                                                                                 String identifier,
                                                                                                                                                 @Path(value="date")
                                                                                                                                                 LocalDate date)

Delete a record for a specific day of a study report

Parameters:: identifier - identifier (required); date - Date of records (required)
Returns:: Call<Message>

deleteSubpopulation

@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)

Delete a subpopulation Delete a subpopulation unless it is a default subpopulation, which cannot be deleted. If this is a

Parameters:: subpopulationGuid - Subpopulation GUID (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteSurvey

@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)

Deprecated.

Delete a survey version

Parameters:: 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)
Returns:: Call<Message>

deleteTemplate

@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)

Delete template (and all revisions) Delete an existing template (and all its revisions).

Parameters:: guid - A guid (required); physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)
Returns:: Call<Message>

deleteUploadSchema

@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)

Deprecated.

Delete the specific revision of an upload schema

Parameters:: 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)
Returns:: Call<Message>

finishFileRevision

@Headers(value="Content-Type:application/json")
 @POST(value="v3/files/{guid}/revisions/{createdOn}")
retrofit2.Call<Message> finishFileRevision(@Path(value="guid")
                                                                                                                                                 String guid,
                                                                                                                                                 @Path(value="createdOn")
                                                                                                                                                 DateTime createdOn)

Indicate to the server that a file revision upload has been completed. Indicate to the server that a file revision upload has been completed. If this call is made and the S3 file is found, the revision record is moved from the `pending` to the `available` state (and the upload URL is removed from the record). If the S3 record is *not* on the server, then this call will return a 404 and the `FileRevision` record will be deleted.

Parameters:: guid - A guid (required); createdOn - Created on timestamp (ISO 8601) (required)
Returns:: Call<Message>

finishStudyLogoUpload

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/logo/{createdOn}")
retrofit2.Call<Study> finishStudyLogoUpload(@Path(value="studyId")
                                                                                                                                                  String studyId,
                                                                                                                                                  @Path(value="createdOn")
                                                                                                                                                  DateTime createdOn)

Confirm with the Bridge server that the logo has been uploaded to S3. After calling `createStudyLogo`, and uploading the logo to S3, a client must call this method to confirm that the file has been uploaded. An URL to the logo to download it will not be available in the study’s `studyLogoUrl` field until this method is called (the server does not validate that the file has in fact been uploaded to S3).

Parameters:: studyId - Study identifier (required); createdOn - Created on timestamp (ISO 8601) (required)
Returns:: Call<Study>

getAdherenceStatistics

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/adherence/stats")
retrofit2.Call<AdherenceStatistics> getAdherenceStatistics(@Path(value="studyId")
                                                                                                                                                               String studyId,
                                                                                                                                                               @Query(value="adherenceThreshold")
                                                                                                                                                               Integer adherenceThreshold)

Get summary stats of the adherence situation for all participants who are active in the study during the current week of the study.

Parameters:: studyId - Study identifier (required); adherenceThreshold - The percentage cutoff to use to determine totals of compliant and noncompliant participants. (optional)
Returns:: Call<AdherenceStatistics>

getAllAppConfigElementRevisions

@Headers(value="Content-Type:application/json")
 @GET(value="v3/appconfigs/elements/{id}")
retrofit2.Call<AppConfigElementList> getAllAppConfigElementRevisions(@Path(value="id")
                                                                                                                                                                String id,
                                                                                                                                                                @Query(value="includeDeleted")
                                                                                                                                                                Boolean includeDeleted)

Get all revisions for an app config element Get all revisions for an app config element.

Parameters:: id - An identifier (required); includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<AppConfigElementList>

getAllCompoundActivityDefinitions

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/compoundactivitydefinitions")
retrofit2.Call<CompoundActivityDefinitionList> getAllCompoundActivityDefinitions()

Deprecated.

List all compound activity definitions in the app

Returns:: Call<CompoundActivityDefinitionList>

getAllConsents

@Headers(value="Content-Type:application/json")
 @GET(value="v3/subpopulations/{subpopulationGuid}/consents")
retrofit2.Call<StudyConsentList> getAllConsents(@Path(value="subpopulationGuid")
                                                                                                                                                              String subpopulationGuid)

Get a list of all consents for this subpopulation

Parameters:: subpopulationGuid - Subpopulation GUID (required)
Returns:: Call<StudyConsentList>

getAllDefaultConsentRevisions

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/consents")
retrofit2.Call<StudyConsentList> getAllDefaultConsentRevisions()

Deprecated.

Get all revisions of the consent in a app's default subpopulation

Returns:: Call<StudyConsentList>

getAllHealthDataDocumentationForParentId

@Headers(value="Content-Type:application/json")
 @GET(value="v3/healthdatadocumentation")
retrofit2.Call<HealthDataDocumentationList> getAllHealthDataDocumentationForParentId(@Query(value="parentId")
                                                                                                                                                                               String parentId,
                                                                                                                                                                               @Query(value="offsetKey")
                                                                                                                                                                               String offsetKey,
                                                                                                                                                                               @Query(value="pageSize")
                                                                                                                                                                               Integer pageSize)

Get all health data documentation by parentId. Gets a list of health data documentation for the given parentId.

Parameters:: parentId - The id used in place of appId, and in the future, studyId. (optional); offsetKey - next page start key for pagination (optional); pageSize - maximum number of records in each returned page (optional, default to 50)
Returns:: Call<HealthDataDocumentationList>

getAllRevisionsOfUploadSchema

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/uploadschemas/{schemaId}")
retrofit2.Call<UploadSchemaList> getAllRevisionsOfUploadSchema(@Path(value="schemaId")
                                                                                                                                                                       String schemaId,
                                                                                                                                                                       @Query(value="includeDeleted")
                                                                                                                                                                       Boolean includeDeleted)

Deprecated.

Get all revisions of an upload schema

Parameters:: schemaId - Upload schema ID (required); includeDeleted - Should deleted upload schemas be returned in results? (optional, default to false)
Returns:: Call<UploadSchemaList>

getAllVersionsOfSurvey

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/surveys/{surveyGuid}/revisions")
retrofit2.Call<SurveyList> getAllVersionsOfSurvey(@Path(value="surveyGuid")
                                                                                                                                                                String surveyGuid,
                                                                                                                                                                @Query(value="includeDeleted")
                                                                                                                                                                Boolean includeDeleted)

Deprecated.

Get all revisions of a survey

Parameters:: surveyGuid - Survey GUID (required); includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<SurveyList>

getAppConfig

@Headers(value="Content-Type:application/json")
 @GET(value="v3/appconfigs/{guid}")
retrofit2.Call<AppConfig> getAppConfig(@Path(value="guid")
                                                                                                                           String guid)

Get an app config Get an configuration object for this app.

Parameters:: guid - A guid (required)
Returns:: Call<AppConfig>

getAppConfigElement

@Headers(value="Content-Type:application/json")
 @GET(value="v3/appconfigs/elements/{id}/revisions/{revision}")
retrofit2.Call<AppConfigElement> getAppConfigElement(@Path(value="id")
                                                                                                                                                                     String id,
                                                                                                                                                                     @Path(value="revision")
                                                                                                                                                                     Long revision)

Get an app config element Get an app configuration element for this app.

Parameters:: id - An identifier (required); revision - Revision number (required)
Returns:: Call<AppConfigElement>

getAppConfigs

@Headers(value="Content-Type:application/json")
 @GET(value="v3/appconfigs")
retrofit2.Call<AppConfigList> getAppConfigs(@Query(value="includeDeleted")
                                                                                                                         Boolean includeDeleted)

Get a list of the app's configurations Get all the configuration objects for this app.

Parameters:: includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<AppConfigList>

getAppEmailStatus
```
@Headers(value="Content-Type:application/json")
 @GET(value="v1/apps/self/emailStatus")
retrofit2.Call<EmailVerificationStatus> getAppEmailStatus()
```
SES email verification status Consents will be emailed from the support email address you provide. Amazon SES will ask the holder of that address to confirm this is OK.

Returns:

Call<EmailVerificationStatus>

getAppPublicCsmKey

@Headers(value="Content-Type:application/json")
 @GET(value="v1/apps/self/publicKey")
retrofit2.Call<CmsPublicKey> getAppPublicCsmKey()

Get the public key CMS block for this app

Returns:: Call<CmsPublicKey>

getAssessmentByGUID

@Headers(value="Content-Type:application/json")
 @GET(value="v1/assessments/{guid}")
retrofit2.Call<Assessment> getAssessmentByGUID(@Path(value="guid")
                                                                                                                                    String guid)

Get a specific assessment revision. A GUID uniquely identifies a specific assessment revision.

Parameters:: guid - A guid (required)
Returns:: Call<Assessment>

getAssessmentById

@Headers(value="Content-Type:application/json")
 @GET(value="v1/assessments/identifier:{identifier}/revisions/{revision}")
retrofit2.Call<Assessment> getAssessmentById(@Path(value="identifier")
                                                                                                                                                                        String identifier,
                                                                                                                                                                        @Path(value="revision")
                                                                                                                                                                        Long revision)

Get an assessment revision by identifier and revision number.

Parameters:: identifier - identifier (required); revision - Revision number (required)
Returns:: Call<Assessment>

getAssessmentConfig

@Headers(value="Content-Type:application/json")
 @GET(value="v1/assessments/{guid}/config")
retrofit2.Call<AssessmentConfig> getAssessmentConfig(@Path(value="guid")
                                                                                                                                                 String guid)

Get the JSON config for this assessment.

Parameters:: guid - A guid (required)
Returns:: Call<AssessmentConfig>

getAssessmentResource

@Headers(value="Content-Type:application/json")
 @GET(value="v1/assessments/identifier:{assessmentId}/resources/{guid}")
retrofit2.Call<ExternalResource> getAssessmentResource(@Path(value="assessmentId")
                                                                                                                                                                                String assessmentId,
                                                                                                                                                                                @Path(value="guid")
                                                                                                                                                                                String guid)

Get an assessment external resource description

Parameters:: assessmentId - The identifier for a stream of assessment revisions (required); guid - A guid (required)
Returns:: Call<ExternalResource>

getAssessmentResources

@Headers(value="Content-Type:application/json")
 @GET(value="v1/assessments/identifier:{assessmentId}/resources")
retrofit2.Call<PagedExternalResourceList> getAssessmentResources(@Path(value="assessmentId")
                                                                                                                                                                                   String assessmentId,
                                                                                                                                                                                   @Query(value="offsetBy")
                                                                                                                                                                                   Integer offsetBy,
                                                                                                                                                                                   @Query(value="pageSize")
                                                                                                                                                                                   Integer pageSize,
                                                                                                                                                                                   @Query(value="category")
                                                                                                                                                                                   List<String> category,
                                                                                                                                                                                   @Query(value="minRevision")
                                                                                                                                                                                   Integer minRevision,
                                                                                                                                                                                   @Query(value="maxRevision")
                                                                                                                                                                                   Integer maxRevision,
                                                                                                                                                                                   @Query(value="includeDeleted")
                                                                                                                                                                                   Boolean includeDeleted)

Get the external resource links documenting an assessment

Parameters:: assessmentId - The identifier for a stream of assessment revisions (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); category - One or more category values. Searches specifying more than one category will return a resource if it matches *any* of the categories given (it does not need to match all of them). (optional); minRevision - If this parameter is set, only resoures with a `createdAtRevision` value >= minRevision will be returned from the API (if the parameter is left null, all resources will be considered to match). (optional); maxRevision - If this parameter is set, only resources with a `createdAtRevision` value <= maxRevision will be returned from the API (if the parameter is left null, all resources will be considered to match). (optional); includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<PagedExternalResourceList>

getAssessmentRevisionsByGUID

@Headers(value="Content-Type:application/json")
 @GET(value="v1/assessments/{guid}/revisions")
retrofit2.Call<AssessmentList> getAssessmentRevisionsByGUID(@Path(value="guid")
                                                                                                                                                           String guid,
                                                                                                                                                           @Query(value="offsetBy")
                                                                                                                                                           Integer offsetBy,
                                                                                                                                                           @Query(value="pageSize")
                                                                                                                                                           Integer pageSize,
                                                                                                                                                           @Query(value="includeDeleted")
                                                                                                                                                           Boolean includeDeleted)

Get the revisions of an assessment with a specific identifier. Records are paged and returned with the highest revision number first.

Parameters:: guid - A guid (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); includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<AssessmentList>

getAssessmentRevisionsById

@Headers(value="Content-Type:application/json")
 @GET(value="v1/assessments/identifier:{identifier}/revisions")
retrofit2.Call<AssessmentList> getAssessmentRevisionsById(@Path(value="identifier")
                                                                                                                                                                          String identifier,
                                                                                                                                                                          @Query(value="offsetBy")
                                                                                                                                                                          Integer offsetBy,
                                                                                                                                                                          @Query(value="pageSize")
                                                                                                                                                                          Integer pageSize,
                                                                                                                                                                          @Query(value="includeDeleted")
                                                                                                                                                                          Boolean includeDeleted)

Get the revisions for an assessment by its identifier. These revisions are paged and ordered from highest to lowest revision number.

Parameters:: identifier - 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); includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<AssessmentList>

getAssessments

@Headers(value="Content-Type:application/json")
 @GET(value="v1/assessments")
retrofit2.Call<AssessmentList> getAssessments(@Query(value="offsetBy")
                                                                                                                            Integer offsetBy,
                                                                                                                            @Query(value="pageSize")
                                                                                                                            Integer pageSize,
                                                                                                                            @Query(value="tag")
                                                                                                                            List<String> tag,
                                                                                                                            @Query(value="includeDeleted")
                                                                                                                            Boolean includeDeleted)

Get assessments in the app context. This is a paged API that can be filtered by the categories and tags assigned to assessments. The most recent (highest) revision of each assessment is returned in the API.

Parameters:: offsetBy - next page start offset for pagination (optional, default to 0); pageSize - maximum number of records in each returned page (optional, default to 50); tag - One or more tags. Every resource that has at least one of the tags will be returned (resources do not need to match all tags). (optional); includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<AssessmentList>

getCompoundActivityDefinition

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/compoundactivitydefinitions/{taskId}")
retrofit2.Call<CompoundActivityDefinition> getCompoundActivityDefinition(@Path(value="taskId")
                                                                                                                                                                                             String taskId)

Deprecated.

Get a compound activity definition by ID

Parameters:: taskId - Task ID (required)
Returns:: Call<CompoundActivityDefinition>

getConsent

@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)

Get a specific consent revision Get a specific revision of this subpopulation consent by its creation timestamp.

Parameters:: subpopulationGuid - Subpopulation GUID (required); createdOn - creation timestamp of the revision (required)
Returns:: Call<StudyConsent>

getDefaultConsentRevision

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/consents/{createdOn}")
retrofit2.Call<StudyConsent> getDefaultConsentRevision(@Path(value="createdOn")
                                                                                                                                                           DateTime createdOn)

Deprecated.

Get specific revision of a app's default subpopulation

Parameters:: createdOn - Created on timestamp (ISO 8601) (required)
Returns:: Call<StudyConsent>

getDemographicsValidationConfig

@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)

Fetch a DemographicValuesValidationConfig Fetch an existing DemographicValuesValidationConfig which is used to configure demographics validation.

Parameters:: studyId - Study identifier (required); categoryName - Name of a demographics category. (required)
Returns:: Call<DemographicValuesValidationConfig>

getDemographicsValidationConfigAppLevel

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/demographics/validation/{categoryName}")
retrofit2.Call<DemographicValuesValidationConfig> getDemographicsValidationConfigAppLevel(@Path(value="categoryName")
                                                                                                                                                                                                                String categoryName)

Fetch a DemographicValuesValidationConfig at the app level Fetch an existing DemographicValuesValidationConfig which is used to configure demographics validation for app-level demographics.

Parameters:: categoryName - Name of a demographics category. (required)
Returns:: Call<DemographicValuesValidationConfig>

getEnrollmentsForUser

@Headers(value="Content-Type:application/json")
 @GET(value="v3/participants/{userId}/enrollments")
retrofit2.Call<EnrollmentDetailList> getEnrollmentsForUser(@Path(value="userId")
                                                                                                                                                               String userId)

Get enrollment records for this user

Parameters:: userId - User ID (required)
Returns:: Call<EnrollmentDetailList>

getFile

@Headers(value="Content-Type:application/json")
 @GET(value="v3/files/{guid}")
retrofit2.Call<FileMetadata> getFile(@Path(value="guid")
                                                                                                                    String guid)

Get a file resource Get a file resource for this app.

Parameters:: guid - A guid (required)
Returns:: Call<FileMetadata>

getFileRevision

@Headers(value="Content-Type:application/json")
 @GET(value="v3/files/{guid}/revisions/{createdOn}")
retrofit2.Call<FileRevision> getFileRevision(@Path(value="guid")
                                                                                                                                                  String guid,
                                                                                                                                                  @Path(value="createdOn")
                                                                                                                                                  DateTime createdOn)

Get a single file revision of a file.

Parameters:: guid - A guid (required); createdOn - Created on timestamp (ISO 8601) (required)
Returns:: Call<FileRevision>

getFileRevisions

@Headers(value="Content-Type:application/json")
 @GET(value="v3/files/{guid}/revisions")
retrofit2.Call<FileRevisionList> getFileRevisions(@Path(value="guid")
                                                                                                                                           String guid,
                                                                                                                                           @Query(value="offsetBy")
                                                                                                                                           Integer offsetBy,
                                                                                                                                           @Query(value="pageSize")
                                                                                                                                           Integer pageSize)

Get the revision history of a file resource Get the paginated revision history of a file resource.

Parameters:: guid - A guid (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)
Returns:: Call<FileRevisionList>

getFiles

@Headers(value="Content-Type:application/json")
 @GET(value="v3/files")
retrofit2.Call<FileMetadataList> getFiles(@Query(value="offsetBy")
                                                                                                                  Integer offsetBy,
                                                                                                                  @Query(value="pageSize")
                                                                                                                  Integer pageSize,
                                                                                                                  @Query(value="includeDeleted")
                                                                                                                  Boolean includeDeleted)

Get a list of static files Get all the files of a specific type for this app.

Parameters:: 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)
Returns:: Call<FileMetadataList>

getHealthDataDocumentationForId

@Headers(value="Content-Type:application/json")
 @GET(value="v3/healthdatadocumentation/{identifier}")
retrofit2.Call<HealthDataDocumentation> getHealthDataDocumentationForId(@Path(value="identifier")
                                                                                                                                                                               String identifier)

Get a health data documentation with the given identifier This endpoint can be called by researchers and developers to get a specific documentation by identifier.

Parameters:: identifier - identifier (required)
Returns:: Call<HealthDataDocumentation>

getLatestAssessmentRevision

@Headers(value="Content-Type:application/json")
 @GET(value="v1/assessments/identifier:{identifier}")
retrofit2.Call<Assessment> getLatestAssessmentRevision(@Path(value="identifier")
                                                                                                                                                             String identifier)

Get the latest version of an assessment. This revision is one with the “latest” (highest) revision number, using the assessment’s identifier.

Parameters:: identifier - identifier (required)
Returns:: Call<Assessment>

getMetadataByIdAndVersion

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/sharedmodules/metadata/{moduleId}/versions/{moduleVersion}")
retrofit2.Call<SharedModuleMetadata> getMetadataByIdAndVersion(@Path(value="moduleId")
                                                                                                                                                                                                         String moduleId,
                                                                                                                                                                                                         @Path(value="moduleVersion")
                                                                                                                                                                                                         Integer moduleVersion)

Deprecated.

Gets metadata for the specified version of the specified module.

Parameters:: moduleId - Unique ID of the module. (required); moduleVersion - Module version. (required)
Returns:: Call<SharedModuleMetadata>

getMetadataByIdLatestVersion

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/sharedmodules/metadata/{moduleId}")
retrofit2.Call<SharedModuleMetadata> getMetadataByIdLatestVersion(@Path(value="moduleId")
                                                                                                                                                                                   String moduleId)

Deprecated.

Gets metadata for the latest version of the specified module.

Parameters:: moduleId - Unique ID of the module. (required)
Returns:: Call<SharedModuleMetadata>

getMostRecentAppConfigElement

@Headers(value="Content-Type:application/json")
 @GET(value="v3/appconfigs/elements/{id}/recent")
retrofit2.Call<AppConfigElement> getMostRecentAppConfigElement(@Path(value="id")
                                                                                                                                                                 String id)

Get most recent app config element Get most recently app config element.

Parameters:: id - An identifier (required)
Returns:: Call<AppConfigElement>

getMostRecentAppConfigElements

@Headers(value="Content-Type:application/json")
 @GET(value="v3/appconfigs/elements")
retrofit2.Call<AppConfigElementList> getMostRecentAppConfigElements(@Query(value="includeDeleted")
                                                                                                                                                          Boolean includeDeleted)

Get a list of the most recent revision of each configuration element in the app Get a list of the app configuration elements in the app, returning the highest revision number for each element in the app. This revision may or may not be published.

Parameters:: includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<AppConfigElementList>

getMostRecentConsent

@Headers(value="Content-Type:application/json")
 @GET(value="v3/subpopulations/{subpopulationGuid}/consents/recent")
retrofit2.Call<StudyConsent> getMostRecentConsent(@Path(value="subpopulationGuid")
                                                                                                                                                                       String subpopulationGuid)

Get the most recently created consent revision Get the most recently created revision of this subpopulation consent. This is not necessarily the published version of the consent.

Parameters:: subpopulationGuid - Subpopulation GUID (required)
Returns:: Call<StudyConsent>

getMostRecentDefaultConsentRevision

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/consents/recent")
retrofit2.Call<StudyConsent> getMostRecentDefaultConsentRevision()

Deprecated.

Get most recent revision of a app's default subpopulation

Returns:: Call<StudyConsent>

getMostRecentSurveyVersion

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/surveys/{surveyGuid}/revisions/recent")
retrofit2.Call<Survey> getMostRecentSurveyVersion(@Path(value="surveyGuid")
                                                                                                                                                                       String surveyGuid)

Deprecated.

Get most recent revision of a survey

Parameters:: surveyGuid - Survey GUID (required)
Returns:: Call<Survey>

getMostRecentSurveys

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/surveys")
retrofit2.Call<SurveyList> getMostRecentSurveys(@Query(value="includeDeleted")
                                                                                                                                       Boolean includeDeleted)

Deprecated.

Get most recent version of each survey

Parameters:: includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<SurveyList>

getMostRecentUploadSchema

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/uploadschemas/{schemaId}/recent")
retrofit2.Call<UploadSchema> getMostRecentUploadSchema(@Path(value="schemaId")
                                                                                                                                                                      String schemaId)

Deprecated.

Get the most recent revision of an upload schema

Parameters:: schemaId - Upload schema ID (required)
Returns:: Call<UploadSchema>

getMostRecentUploadSchemas

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/uploadschemas")
retrofit2.Call<UploadSchemaList> getMostRecentUploadSchemas(@Query(value="includeDeleted")
                                                                                                                                                         Boolean includeDeleted)

Deprecated.

Get most recent revision of all upload schemas

Parameters:: includeDeleted - Should deleted upload schemas be returned in results? (optional, default to false)
Returns:: Call<UploadSchemaList>

getNotificationTopic

@Headers(value="Content-Type:application/json")
 @GET(value="v3/topics/{guid}")
retrofit2.Call<NotificationTopic> getNotificationTopic(@Path(value="guid")
                                                                                                                                       String guid)

Get a notification topic

Parameters:: guid - A guid (required)
Returns:: Call<NotificationTopic>

getNotificationTopics

@Headers(value="Content-Type:application/json")
 @GET(value="v3/topics")
retrofit2.Call<NotificationTopicList> getNotificationTopics(@Query(value="includeDeleted")
                                                                                                                                     Boolean includeDeleted)

Get all the notification topics in this app Return all the topics defined for this app. Participants can be subscribed to topics if they register for notifications. Researchers can then send push notifications to those users through the user of a topic.

Parameters:: includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<NotificationTopicList>

getPublishedConsent

@Headers(value="Content-Type:application/json")
 @GET(value="v3/subpopulations/{subpopulationGuid}/consents/published")
retrofit2.Call<StudyConsent> getPublishedConsent(@Path(value="subpopulationGuid")
                                                                                                                                                                         String subpopulationGuid)

Get the published consent revision Get the published revision of this subpopulation consent. This is not necessarily the most recent version of the consent.

Parameters:: subpopulationGuid - Subpopulation GUID (required)
Returns:: Call<StudyConsent>

getPublishedDefaultConsentRevision

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/consents/published")
retrofit2.Call<StudyConsent> getPublishedDefaultConsentRevision()

Deprecated.

Get most recently published revision of a app's default subpopulation

Returns:: Call<StudyConsent>

getPublishedSurveyVersion

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/surveys/{surveyGuid}/revisions/published")
retrofit2.Call<Survey> getPublishedSurveyVersion(@Path(value="surveyGuid")
                                                                                                                                                                         String surveyGuid)

Deprecated.

Get most recently published revision of a survey

Parameters:: surveyGuid - Survey GUID (required)
Returns:: Call<Survey>

getPublishedSurveys

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/surveys/published")
retrofit2.Call<SurveyList> getPublishedSurveys(@Query(value="includeDeleted")
                                                                                                                                                Boolean includeDeleted)

Deprecated.

Get the most recently published version of each survey

Parameters:: includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<SurveyList>

getScheduleForStudy

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/schedule")
retrofit2.Call<Schedule2> getScheduleForStudy(@Path(value="studyId")
                                                                                                                                           String studyId)

Get the schedule for this study.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Schedule2>

getSchedulePlan

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/scheduleplans/{schedulePlanGuid}")
retrofit2.Call<SchedulePlan> getSchedulePlan(@Path(value="schedulePlanGuid")
                                                                                                                                                             String schedulePlanGuid)

Deprecated.

Get a schedule plan

Parameters:: schedulePlanGuid - Schedule plan GUID (required)
Returns:: Call<SchedulePlan>

getSchedulePlans

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/scheduleplans")
retrofit2.Call<SchedulePlanList> getSchedulePlans(@Query(value="includeDeleted")
                                                                                                                                               Boolean includeDeleted)

Deprecated.

Get schedule plans

Parameters:: includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<SchedulePlanList>

getSponsors

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/sponsors")
retrofit2.Call<OrganizationList> getSponsors(@Path(value="studyId")
                                                                                                                                          String studyId,
                                                                                                                                          @Query(value="offsetBy")
                                                                                                                                          Integer offsetBy,
                                                                                                                                          @Query(value="pageSize")
                                                                                                                                          Integer pageSize)

Get the sponsors of this study.

Parameters:: 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)
Returns:: Call<OrganizationList>

getStudies

@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)

Get a list of the studies in this app

Parameters:: 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)
Returns:: Call<StudyList>

getStudy

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}")
retrofit2.Call<Study> getStudy(@Path(value="studyId")
                                                                                                                   String studyId)

Get a study Get a study for this app.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Study>

getStudyParticipantAdherenceReport

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/adherence/study")
retrofit2.Call<StudyAdherenceReport> getStudyParticipantAdherenceReport(@Path(value="studyId")
                                                                                                                                                                                                  String studyId,
                                                                                                                                                                                                  @Path(value="userId")
                                                                                                                                                                                                  String userId)

Get a detailed report on a participant’s full schedule of activities.

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<StudyAdherenceReport>

getStudyParticipantEventStreamAdherenceReport

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/adherence/eventstream")
retrofit2.Call<EventStreamAdherenceReport> getStudyParticipantEventStreamAdherenceReport(@Path(value="studyId")
                                                                                                                                                                                                                         String studyId,
                                                                                                                                                                                                                         @Path(value="userId")
                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                         @Query(value="datetime")
                                                                                                                                                                                                                         DateTime datetime,
                                                                                                                                                                                                                         @Query(value="activeOnly")
                                                                                                                                                                                                                         Boolean activeOnly)

Get a detailed report on a participant’s adherence to the entire study protocol’s schedule.

Parameters:: studyId - Study identifier (required); userId - User ID (required); datetime - The timestamp to use as “now” for the calculation of adherence. This timestamp will be adjusted to the participant’s `clientTimeZone` value if this value has been persisted for the participant. (optional, default to The date and time on the server at the time of the request); activeOnly - Only return records that are currently actionable by the participant (optional, default to false)
Returns:: Call<EventStreamAdherenceReport>

getStudyParticipants

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/search")
retrofit2.Call<AccountSummaryList> getStudyParticipants(@Path(value="studyId")
                                                                                                                                                                 String studyId,
                                                                                                                                                                 @Body
                                                                                                                                                                 AccountSummarySearch accountSummarySearch)

Search for account summaries of study participants. For developers and study designers, this API only returns test accounts (accounts marked with the “test_user” data group).

Parameters:: studyId - Study identifier (required); accountSummarySearch - Account summary search parameters (required)
Returns:: Call<AccountSummaryList>

getStudyReportIndex

@Headers(value="Content-Type:application/json")
 @GET(value="v3/reports/{identifier}/index")
retrofit2.Call<ReportIndex> getStudyReportIndex(@Path(value="identifier")
                                                                                                                                             String identifier)

Get a report index Get the index (or metadata) for a set of report records. The caller must be authenticated to retrieve indices.

Parameters:: identifier - identifier (required)
Returns:: Call<ReportIndex>

getSubpopulation

@Headers(value="Content-Type:application/json")
 @GET(value="v3/subpopulations/{subpopulationGuid}")
retrofit2.Call<Subpopulation> getSubpopulation(@Path(value="subpopulationGuid")
                                                                                                                                                    String subpopulationGuid)

Get a subpopulation

Parameters:: subpopulationGuid - Subpopulation GUID (required)
Returns:: Call<Subpopulation>

getSubpopulations

@Headers(value="Content-Type:application/json")
 @GET(value="v3/subpopulations")
retrofit2.Call<SubpopulationList> getSubpopulations(@Query(value="includeDeleted")
                                                                                                                                     Boolean includeDeleted)

Get all subpopulations in this app. This is temporarily accessible to study coordinators until we build v2 of our consent system.

Parameters:: includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<SubpopulationList>

getSurvey

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/surveys/{surveyGuid}/revisions/{createdOn}")
retrofit2.Call<Survey> getSurvey(@Path(value="surveyGuid")
                                                                                                                                                           String surveyGuid,
                                                                                                                                                           @Path(value="createdOn")
                                                                                                                                                           DateTime createdOn)

Deprecated.

Get a survey revision

Parameters:: surveyGuid - Survey GUID (required); createdOn - Created on timestamp (ISO 8601) (required)
Returns:: Call<Survey>

getTemplate

@Headers(value="Content-Type:application/json")
 @GET(value="v3/templates/{guid}")
retrofit2.Call<Template> getTemplate(@Path(value="guid")
                                                                                                                        String guid)

Get a template Get a template for this app.

Parameters:: guid - A guid (required)
Returns:: Call<Template>

getTemplateRevision

@Headers(value="Content-Type:application/json")
 @GET(value="v3/templates/{guid}/revisions/{createdOn}")
retrofit2.Call<TemplateRevision> getTemplateRevision(@Path(value="guid")
                                                                                                                                                              String guid,
                                                                                                                                                              @Path(value="createdOn")
                                                                                                                                                              DateTime createdOn)

Get a single template document revision

Parameters:: guid - A guid (required); createdOn - Created on timestamp (ISO 8601) (required)
Returns:: Call<TemplateRevision>

getTemplateRevisions

@Headers(value="Content-Type:application/json")
 @GET(value="v3/templates/{guid}/revisions")
retrofit2.Call<TemplateRevisionList> getTemplateRevisions(@Path(value="guid")
                                                                                                                                                       String guid,
                                                                                                                                                       @Query(value="offsetBy")
                                                                                                                                                       Integer offsetBy,
                                                                                                                                                       @Query(value="pageSize")
                                                                                                                                                       Integer pageSize)

Get the template document revisions

Parameters:: guid - A guid (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)
Returns:: Call<TemplateRevisionList>

getTemplates

@Headers(value="Content-Type:application/json")
 @GET(value="v3/templates")
retrofit2.Call<TemplateList> getTemplates(@Query(value="type")
                                                                                                                      String type,
                                                                                                                      @Query(value="offsetBy")
                                                                                                                      Integer offsetBy,
                                                                                                                      @Query(value="pageSize")
                                                                                                                      Integer pageSize,
                                                                                                                      @Query(value="includeDeleted")
                                                                                                                      Boolean includeDeleted)

Get a list of templates of a specific type Get all the templates of a specific type for this app.

Parameters:: type - (optional); 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)
Returns:: Call<TemplateList>

getTimelineForStudy

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/timeline")
retrofit2.Call<Timeline> getTimelineForStudy(@Path(value="studyId")
                                                                                                                                          String studyId)

Get the timeline associated to this study through its schedule.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Timeline>

getUploadByRecordId

@Headers(value="Content-Type:application/json")
 @GET(value="v3/uploads/recordId:{recordId}")
retrofit2.Call<Upload> getUploadByRecordId(@Path(value="recordId")
                                                                                                                                         String recordId)

Get an upload record by the health data record ID A superadmin or worker can retrieve any upload in any app. An Admin can retrieve any upload in their own app. A developer can retrieve an upload generated from their own account in an app.

Parameters:: recordId - Health data record ID (required)
Returns:: Call<Upload>

getUploadSchema

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/uploadschemas/{schemaId}/revisions/{revision}")
retrofit2.Call<UploadSchema> getUploadSchema(@Path(value="schemaId")
                                                                                                                                                                          String schemaId,
                                                                                                                                                                          @Path(value="revision")
                                                                                                                                                                          Long revision)

Deprecated.

Get the specific revision of an upload schema

Parameters:: schemaId - Upload schema ID (required); revision - Revision number (required)
Returns:: Call<UploadSchema>

getUsersApp

@Headers(value="Content-Type:application/json")
 @GET(value="v1/apps/self")
retrofit2.Call<App> getUsersApp()

Get an app Get the app of the currently signed in user account.

Returns:: Call<App>

getWeeklyAdherenceReport

@Headers(value="Content-Type:application/json")
 @GET(value="v5/studies/{studyId}/participants/{userId}/adherence/weekly")
retrofit2.Call<WeeklyAdherenceReport> getWeeklyAdherenceReport(@Path(value="studyId")
                                                                                                                                                                                          String studyId,
                                                                                                                                                                                          @Path(value="userId")
                                                                                                                                                                                          String userId)

Get a detailed report on a participant’s current week of scheduled activities.

Parameters:: studyId - Study identifier (required); userId - User ID (required)
Returns:: Call<WeeklyAdherenceReport>

getWeeklyAdherenceReports

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/adherence/weekly")
retrofit2.Call<WeeklyAdherenceReportList> getWeeklyAdherenceReports(@Path(value="studyId")
                                                                                                                                                                          String studyId,
                                                                                                                                                                          @Body
                                                                                                                                                                          AdherenceReportSearch adherenceReportSearch)

Get the adherence for all study participants in their current week of the study.

Parameters:: studyId - Study identifier (required); adherenceReportSearch - Search parameters for weekly adherence report (required)
Returns:: Call<WeeklyAdherenceReportList>

importModuleByIdAndVersion

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/sharedmodules/{moduleId}/versions/{moduleVersion}/import")
retrofit2.Call<SharedModuleImportStatus> importModuleByIdAndVersion(@Path(value="moduleId")
                                                                                                                                                                                                             String moduleId,
                                                                                                                                                                                                             @Path(value="moduleVersion")
                                                                                                                                                                                                             Integer moduleVersion)

Deprecated.

Imports a specific module version into the current app.

Parameters:: moduleId - Unique ID of the module. (required); moduleVersion - Module version. (required)
Returns:: Call<SharedModuleImportStatus>

importModuleByIdLatestPublishedVersion

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/sharedmodules/{moduleId}/import")
retrofit2.Call<SharedModuleImportStatus> importModuleByIdLatestPublishedVersion(@Path(value="moduleId")
                                                                                                                                                                                                String moduleId)

Deprecated.

Imports the latest published version of a module into the current app.

Parameters:: moduleId - Unique ID of the module. (required)
Returns:: Call<SharedModuleImportStatus>

importSharedAssessment

@Headers(value="Content-Type:application/json")
 @POST(value="v1/sharedassessments/{guid}/import")
retrofit2.Call<Assessment> importSharedAssessment(@Path(value="guid")
                                                                                                                                                     String guid,
                                                                                                                                                     @Query(value="ownerId")
                                                                                                                                                     String ownerId,
                                                                                                                                                     @Query(value="newIdentifier")
                                                                                                                                                     String newIdentifier)

Import an assessment revision into the local app context. The assessment is copied into the local app context under the ownership of one of the caller’s organizations. If the identifier for the assessment does not currently exist in the app context, this assessment will be created at revision 1. Otherwise, it will be imported at the next highest revision number from the highest revision under that identifier. The method returns the *local* assessment that has been created by this import operation. This assessment is linked to the shared assessment and the configuration for the assessment cannot be updated without breaking the link (which might invalidate the scientific validation of the assessment). However, owners of the assessment can use the customization API to change some fields of the imported assessment configuration without breaking the link to the shared assessment.

Parameters:: guid - A guid (required); ownerId - The organizational ID the assessment should be imported under as the owning organization of the assessment (only members of that organization will be able to edit the assessment, though all users in an app context can see and schedule the assessment). (required); newIdentifier - Upon importing this assessment, you can provide a new identifier for the assessment. (optional)
Returns:: Call<Assessment>

importSharedAssessmentResource

@Headers(value="Content-Type:application/json")
 @POST(value="v1/sharedassessments/identifier:{assessmentId}/resources/import")
retrofit2.Call<ExternalResourceList> importSharedAssessmentResource(@Path(value="assessmentId")
                                                                                                                                                                                                    String assessmentId,
                                                                                                                                                                                                    @Body
                                                                                                                                                                                                    List<String> externalResourceGUIDs)

Copy these shared resources to your app context The shared assessment these resources relate to must have been imported at least one time to the local app context before the resources can be imported. If the resource has already been imported, it'll be updated with the local version. Note that the imported assessment has a link to the shared assessment and thus, you can refer to all the resource links of the shared assessment rather than importing them.

Parameters:: assessmentId - The identifier for a stream of assessment revisions (required); externalResourceGUIDs - List of external resource GUIDs (required)
Returns:: Call<ExternalResourceList>

initExporter3

@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/self/exporter3")
retrofit2.Call<Exporter3Configuration> initExporter3()

Initializes configs and Synapse resources for Exporter 3.0.

Returns:: Call<Exporter3Configuration>

initExporter3ForStudy

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/exporter3")
retrofit2.Call<Exporter3Configuration> initExporter3ForStudy(@Path(value="studyId")
                                                                                                                                                            String studyId)

Initializes configs and Synapse resources for Exporter 3.0.

Parameters:: studyId - Study identifier (required)
Returns:: Call<Exporter3Configuration>

publishAssessment
```
@Headers(value="Content-Type:application/json")
 @POST(value="v1/assessments/{guid}/publish")
retrofit2.Call<Assessment> publishAssessment(@Path(value="guid")
                                                                                                                                           String guid,
                                                                                                                                           @Query(value="newIdentifier")
                                                                                                                                           String newIdentifier)
```
Publish an assessment revision in the shared library. If the identifier for the assessment does not currently exist in the shared library, this assessment will be created at revision 1. Otherwise, it will be published at the next highest revision number from the highest revision under that identifier. The method returns the *local* assessment as it has been updated to reflect its derivation from the new shared assessment (it should be identical to an assessment that was imported from the shared assessment back into the local app context). Members of the organization that owns the assessment can continue to edit the assessment in the shared library, and can publish later revisions of the assessment, however its configuration is immutable and other organizations cannot publish assessments with the same identifier.

Parameters:

guid - A guid (required)

newIdentifier - Upon publishing this assessment, you can provide a new identifier for the assessment. (optional)

Returns:

Call<Assessment>

publishAssessmentResource

@Headers(value="Content-Type:application/json")
 @POST(value="v1/assessments/identifier:{assessmentId}/resources/publish")
retrofit2.Call<ExternalResourceList> publishAssessmentResource(@Path(value="assessmentId")
                                                                                                                                                                                          String assessmentId,
                                                                                                                                                                                          @Body
                                                                                                                                                                                          List<String> externalResourceGUIDs)

Copy these resources to the shared assessments library. The assessment these resources relate to must have been published at least one time to the shared library before the resources can be published. If the resource has already been published, it'll be updated with the local version.

Parameters:: assessmentId - The identifier for a stream of assessment revisions (required); externalResourceGUIDs - List of external resource GUIDs (required)
Returns:: Call<ExternalResourceList>

publishConsent

@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)

Publish a specific consent revision Publish a specific revision of this subpopulation consent by its creation timestamp. This version of the consent will be presented to users in order to participate in this subpopulation. If users have signed any other revision of this consent, the `signedMostRecentConsent` flag in the consent status record for this consent (in the user's session) will be false. However, the user is still considered to be consented and will not be shut out of performing operations with a 412 response.

Parameters:: subpopulationGuid - Subpopulation GUID (required); createdOn - creation timestamp of the revision (required)
Returns:: Call<Message>

publishSurvey

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/surveys/{surveyGuid}/revisions/{createdOn}/publish")
retrofit2.Call<GuidCreatedOnVersionHolder> publishSurvey(@Path(value="surveyGuid")
                                                                                                                                                                                            String surveyGuid,
                                                                                                                                                                                            @Path(value="createdOn")
                                                                                                                                                                                            DateTime createdOn,
                                                                                                                                                                                            @Query(value="newSchemaRev")
                                                                                                                                                                                            Boolean newSchemaRev)

Deprecated.

Publish a survey

Parameters:: surveyGuid - Survey GUID (required); createdOn - Created on timestamp (ISO 8601) (required); newSchemaRev - Should a new schema revision be created? (optional)
Returns:: Call<GuidCreatedOnVersionHolder>

publishTemplateRevision

@Headers(value="Content-Type:application/json")
 @POST(value="v3/templates/{guid}/revisions/{createdOn}/publish")
retrofit2.Call<Message> publishTemplateRevision(@Path(value="guid")
                                                                                                                                                                  String guid,
                                                                                                                                                                  @Path(value="createdOn")
                                                                                                                                                                  DateTime createdOn)

Set a specific template revision as the version to use when the template is selected

Parameters:: guid - A guid (required); createdOn - Created on timestamp (ISO 8601) (required)
Returns:: Call<Message>

queryAllMetadata

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/sharedmodules/metadata")
retrofit2.Call<SharedModuleMetadataList> queryAllMetadata(@Query(value="mostrecent")
                                                                                                                                                                Boolean mostrecent,
                                                                                                                                                                @Query(value="published")
                                                                                                                                                                Boolean published,
                                                                                                                                                                @Query(value="name")
                                                                                                                                                                String name,
                                                                                                                                                                @Query(value="notes")
                                                                                                                                                                String notes,
                                                                                                                                                                @Query(value="tags")
                                                                                                                                                                String tags,
                                                                                                                                                                @Query(value="includeDeleted")
                                                                                                                                                                Boolean includeDeleted)

Deprecated.

Queries module metadata using the set of given parameters.

Parameters:: mostrecent - True to get only the most recent versions. If combined with published=true, then this will return the most recent published versions. Cannot be combined with where. Defaults to true. (optional, default to true); published - Should the shared module record be published? (optional, default to false); name - String to match anywhere in the name field of the shared module record. (optional); notes - String to match anywhere in the notes field of the shared module record. (optional); tags - Comma-delimited list of tags. If specified, only query results that match one or more tags (not necessarily all tags) are returned. If not specified, returns all query results. (optional); includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<SharedModuleMetadataList>

queryMetadataById

@Deprecated
 @Headers(value="Content-Type:application/json")
 @GET(value="v3/sharedmodules/metadata/{moduleId}/versions")
retrofit2.Call<SharedModuleMetadataList> queryMetadataById(@Path(value="moduleId")
                                                                                                                                                                                     String moduleId,
                                                                                                                                                                                     @Query(value="mostrecent")
                                                                                                                                                                                     Boolean mostrecent,
                                                                                                                                                                                     @Query(value="published")
                                                                                                                                                                                     Boolean published,
                                                                                                                                                                                     @Query(value="name")
                                                                                                                                                                                     String name,
                                                                                                                                                                                     @Query(value="notes")
                                                                                                                                                                                     String notes,
                                                                                                                                                                                     @Query(value="tags")
                                                                                                                                                                                     String tags,
                                                                                                                                                                                     @Query(value="includeDeleted")
                                                                                                                                                                                     Boolean includeDeleted)

Deprecated.

Similar to queryAllMetadata, except this only queries on module versions of the specified ID.

Parameters:: moduleId - Unique ID of the module. (required); mostrecent - True to get only the most recent versions. If combined with published=true, then this will return the most recent published versions. Cannot be combined with where. Defaults to true. (optional, default to true); published - Should the shared module record be published? (optional, default to false); name - String to match anywhere in the name field of the shared module record. (optional); notes - String to match anywhere in the notes field of the shared module record. (optional); tags - Comma-delimited list of tags. If specified, only query results that match one or more tags (not necessarily all tags) are returned. If not specified, returns all query results. (optional); includeDeleted - Should deleted items be returned in results? (optional, default to false)
Returns:: Call<SharedModuleMetadataList>

resendVerifyEmail

@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/self/emails/resendVerify")
retrofit2.Call<Message> resendVerifyEmail(@Query(value="type")
                                                                                                                                           String type)

Resends the verification email for the app's email. Resends the verification email for the current app's email.

Parameters:: type - Type of email that should resend email verification. (required)
Returns:: Call<Message>

saveDemographicsValidationConfig

@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)

Save a DemographicValuesValidationConfig Save a DemographicValuesValidationConfig to configure demographics validation.

Parameters:: studyId - Study identifier (required); categoryName - Name of a demographics category. (required); demographicValuesValidationConfig - (required)
Returns:: Call<DemographicValuesValidationConfig>

saveDemographicsValidationConfigAppLevel

@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)

Save a DemographicValuesValidationConfig at the app level Save a DemographicValuesValidationConfig to configure demographics validation for app-level demographics.

Parameters:: categoryName - Name of a demographics category. (required); demographicValuesValidationConfig - (required)
Returns:: Call<DemographicValuesValidationConfig>

saveScheduleForStudy

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/schedule")
retrofit2.Call<Schedule2> saveScheduleForStudy(@Path(value="studyId")
                                                                                                                                             String studyId,
                                                                                                                                             @Body
                                                                                                                                             Schedule2 schedule)

Create or update a schedule associated with a study. This endpoint will return a status of 200 if the call is an update, or 201 if the schedule is being created for the first time.

Parameters:: studyId - Study identifier (required); schedule - (required)
Returns:: Call<Schedule2>

searchAccountSummaries

@Headers(value="Content-Type:application/json")
 @POST(value="v3/participants/search")
retrofit2.Call<AccountSummaryList> searchAccountSummaries(@Body
                                                                                                                                                 AccountSummarySearch accountSummarySearch)

Search for account summaries (participants) For developers, this API only returns test accounts (accounts marked with the “test_user” data group).

Parameters:: accountSummarySearch - Account summary search parameters (required)
Returns:: Call<AccountSummaryList>

subscribeToCreateStudyNotifications

@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/self/exporter3/notifications/study/subscribe")
retrofit2.Call<ExporterSubscriptionResult> subscribeToCreateStudyNotifications(@Body
                                                                                                                                                                                                    ExporterSubscriptionRequest exporterSubscriptionRequest)

Subscribe to be notified when a study is initialized for Exporter 3.0 in caller's app.

Parameters:: exporterSubscriptionRequest - Subscription request attributes. (required)
Returns:: Call<ExporterSubscriptionResult>

subscribeToExportNotificationsForApp

@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/self/exporter3/notifications/export/subscribe")
retrofit2.Call<ExporterSubscriptionResult> subscribeToExportNotificationsForApp(@Body
                                                                                                                                                                                                      ExporterSubscriptionRequest exporterSubscriptionRequest)

Subscribe to be notified when health data is exported to any Synapse projects in the app.

Parameters:: exporterSubscriptionRequest - Subscription request attributes. (required)
Returns:: Call<ExporterSubscriptionResult>

subscribeToExportNotificationsForStudy

@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)

Subscribe to be notified when health data is exported to the study-specific Synapse project.

Parameters:: studyId - Study identifier (required); exporterSubscriptionRequest - Subscription request attributes. (required)
Returns:: Call<ExporterSubscriptionResult>

updateAppConfig

@Headers(value="Content-Type:application/json")
 @POST(value="v3/appconfigs/{guid}")
retrofit2.Call<GuidVersionHolder> updateAppConfig(@Path(value="guid")
                                                                                                                                       String guid,
                                                                                                                                       @Body
                                                                                                                                       AppConfig appConfig)

Update an existing app config Update an existing app configuration.

Parameters:: guid - A guid (required); appConfig - Updated app configuration (required)
Returns:: Call<GuidVersionHolder>

updateAppConfigElement

@Headers(value="Content-Type:application/json")
 @POST(value="v3/appconfigs/elements/{id}/revisions/{revision}")
retrofit2.Call<VersionHolder> updateAppConfigElement(@Path(value="id")
                                                                                                                                                                      String id,
                                                                                                                                                                      @Path(value="revision")
                                                                                                                                                                      Long revision,
                                                                                                                                                                      @Body
                                                                                                                                                                      AppConfigElement appConfigElement)

Update an existing app config element Update an existing app configuration element.

Parameters:: id - An identifier (required); revision - Revision number (required); appConfigElement - Updated app configuration element (required)
Returns:: Call<VersionHolder>

updateAssessment

@Headers(value="Content-Type:application/json")
 @POST(value="v1/assessments/{guid}")
retrofit2.Call<Assessment> updateAssessment(@Path(value="guid")
                                                                                                                                  String guid,
                                                                                                                                  @Body
                                                                                                                                  Assessment assessment)

Update an assessment revision. A GUID uniquely identifies a specific assessment revision. Only members of the organization that own this assessment can update it. This operation returns the updated assessment revision.

Parameters:: guid - A guid (required); assessment - Updated assessment (required)
Returns:: Call<Assessment>

updateAssessmentConfig

@Headers(value="Content-Type:application/json")
 @POST(value="v1/assessments/{guid}/config")
retrofit2.Call<AssessmentConfig> updateAssessmentConfig(@Path(value="guid")
                                                                                                                                                     String guid,
                                                                                                                                                     @Body
                                                                                                                                                     AssessmentConfig assessmentConfig)

Update the JSON config for this assessment.

Parameters:: guid - A guid (required); assessmentConfig - (required)
Returns:: Call<AssessmentConfig>

updateAssessmentResource

@Headers(value="Content-Type:application/json")
 @POST(value="v1/assessments/identifier:{assessmentId}/resources/{guid}")
retrofit2.Call<ExternalResource> updateAssessmentResource(@Path(value="assessmentId")
                                                                                                                                                                                    String assessmentId,
                                                                                                                                                                                    @Path(value="guid")
                                                                                                                                                                                    String guid,
                                                                                                                                                                                    @Body
                                                                                                                                                                                    ExternalResource externalResource)

Update an external resource link documenting an assessment

Parameters:: assessmentId - The identifier for a stream of assessment revisions (required); guid - A guid (required); externalResource - Assessment resource (required)
Returns:: Call<ExternalResource>

updateCompoundActivityDefinition

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/compoundactivitydefinitions/{taskId}")
retrofit2.Call<CompoundActivityDefinition> updateCompoundActivityDefinition(@Path(value="taskId")
                                                                                                                                                                                                 String taskId,
                                                                                                                                                                                                 @Body
                                                                                                                                                                                                 CompoundActivityDefinition compoundActivityDefinition)

Deprecated.

Update a compound activity definition

Parameters:: taskId - Task ID (required); compoundActivityDefinition - (required)
Returns:: Call<CompoundActivityDefinition>

updateEnrollment

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/enrollments/{userId}")
retrofit2.Call<Message> updateEnrollment(@Path(value="studyId")
                                                                                                                                                   String studyId,
                                                                                                                                                   @Path(value="userId")
                                                                                                                                                   String userId,
                                                                                                                                                   @Body
                                                                                                                                                   Enrollment enrollment)

Update a participant's enrollment record for a study Developers and Study Designers can only update test accounts.

Parameters:: studyId - Study identifier (required); userId - User ID (required); enrollment - Updated enrollment (required)
Returns:: Call<Message>

updateFile

@Headers(value="Content-Type:application/json")
 @POST(value="v3/files/{guid}")
retrofit2.Call<GuidVersionHolder> updateFile(@Path(value="guid")
                                                                                                                             String guid,
                                                                                                                             @Body
                                                                                                                             FileMetadata file)

Update an existing file resource Update an existing file resource.

Parameters:: guid - A guid (required); file - Updated file (required)
Returns:: Call<GuidVersionHolder>

updateMetadata

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/sharedmodules/metadata/{moduleId}/versions/{moduleVersion}")
retrofit2.Call<SharedModuleMetadata> updateMetadata(@Path(value="moduleId")
                                                                                                                                                                                               String moduleId,
                                                                                                                                                                                               @Path(value="moduleVersion")
                                                                                                                                                                                               Integer moduleVersion,
                                                                                                                                                                                               @Body
                                                                                                                                                                                               SharedModuleMetadata sharedModuleMetadata)

Deprecated.

Updates metadata for the specified module version.

Parameters:: moduleId - Unique ID of the module. (required); moduleVersion - Module version. (required); sharedModuleMetadata - (required)
Returns:: Call<SharedModuleMetadata>

updateNotificationTopic

@Headers(value="Content-Type:application/json")
 @POST(value="v3/topics/{guid}")
retrofit2.Call<GuidHolder> updateNotificationTopic(@Path(value="guid")
                                                                                                                                    String guid,
                                                                                                                                    @Body
                                                                                                                                    NotificationTopic notificationTopic)

Update a notification topic

Parameters:: guid - A guid (required); notificationTopic - (required)
Returns:: Call<GuidHolder>

updateSchedulePlan

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/scheduleplans/{schedulePlanGuid}")
retrofit2.Call<GuidVersionHolder> updateSchedulePlan(@Path(value="schedulePlanGuid")
                                                                                                                                                                      String schedulePlanGuid,
                                                                                                                                                                      @Body
                                                                                                                                                                      SchedulePlan schedulePlan)

Deprecated.

Update a schedule plan

Parameters:: schedulePlanGuid - Schedule plan GUID (required); schedulePlan - (required)
Returns:: Call<GuidVersionHolder>

updateSharedAssessment

@Headers(value="Content-Type:application/json")
 @POST(value="v1/sharedassessments/{guid}")
retrofit2.Call<Assessment> updateSharedAssessment(@Path(value="guid")
                                                                                                                                              String guid,
                                                                                                                                              @Body
                                                                                                                                              Assessment assessment)

Update an assessment revision. A GUID uniquely identifies a specific assessment revision. Only members of the organization that owned the assessment when it was published into the shared library of assessments can update the assessment in the shared library.

Parameters:: guid - A guid (required); assessment - Updated assessment (required)
Returns:: Call<Assessment>

updateSharedAssessmentResource

@Headers(value="Content-Type:application/json")
 @POST(value="v1/sharedassessments/identifier:{assessmentId}/resources/{guid}")
retrofit2.Call<ExternalResource> updateSharedAssessmentResource(@Path(value="assessmentId")
                                                                                                                                                                                                String assessmentId,
                                                                                                                                                                                                @Path(value="guid")
                                                                                                                                                                                                String guid,
                                                                                                                                                                                                @Body
                                                                                                                                                                                                ExternalResource externalResource)

Update an external resource link documenting a shared assessment

Parameters:: assessmentId - The identifier for a stream of assessment revisions (required); guid - A guid (required); externalResource - Assessment resource (required)
Returns:: Call<ExternalResource>

updateStudy

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}")
retrofit2.Call<VersionHolder> updateStudy(@Path(value="studyId")
                                                                                                                               String studyId,
                                                                                                                               @Body
                                                                                                                               Study study)

Update an existing study Update an existing study

Parameters:: studyId - Study identifier (required); study - Updated study (required)
Returns:: Call<VersionHolder>

updateStudyParticipantAdherenceRecords

@Headers(value="Content-Type:application/json")
 @POST(value="v5/studies/{studyId}/participants/{userId}/adherence")
retrofit2.Call<Message> updateStudyParticipantAdherenceRecords(@Path(value="studyId")
                                                                                                                                                                                    String studyId,
                                                                                                                                                                                    @Path(value="userId")
                                                                                                                                                                                    String userId,
                                                                                                                                                                                    @Body
                                                                                                                                                                                    AdherenceRecordUpdates adherenceRecordUpdates)

Update one or more adherence records for a participant

Parameters:: studyId - Study identifier (required); userId - User ID (required); adherenceRecordUpdates - One ore more adherence records (required)
Returns:: Call<Message>

updateStudyReportIndex

@Headers(value="Content-Type:application/json")
 @POST(value="v3/reports/{identifier}/index")
retrofit2.Call<Message> updateStudyReportIndex(@Path(value="identifier")
                                                                                                                                             String identifier,
                                                                                                                                             @Body
                                                                                                                                             ReportIndex reportIndex)

Update an existing study report index Update the index (or metadata) for a set of report records. Any member of an organization sponsoring a study, or any app-scoped administrative user, can update a study index.

Parameters:: identifier - identifier (required); reportIndex - Report index (required)
Returns:: Call<Message>

updateSubpopulation

@Headers(value="Content-Type:application/json")
 @POST(value="v3/subpopulations/{subpopulationGuid}")
retrofit2.Call<GuidVersionHolder> updateSubpopulation(@Path(value="subpopulationGuid")
                                                                                                                                                            String subpopulationGuid,
                                                                                                                                                            @Body
                                                                                                                                                            Subpopulation subpopulation)

Update an existing subpopulation

Parameters:: subpopulationGuid - Subpopulation GUID (required); subpopulation - A subpopulation (required)
Returns:: Call<GuidVersionHolder>

updateSurvey

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/surveys/{surveyGuid}/revisions/{createdOn}")
retrofit2.Call<GuidCreatedOnVersionHolder> updateSurvey(@Path(value="surveyGuid")
                                                                                                                                                                                   String surveyGuid,
                                                                                                                                                                                   @Path(value="createdOn")
                                                                                                                                                                                   DateTime createdOn,
                                                                                                                                                                                   @Body
                                                                                                                                                                                   Survey survey)

Deprecated.

Update a non-published survey revision

Parameters:: surveyGuid - Survey GUID (required); createdOn - Created on timestamp (ISO 8601) (required); survey - Updated survey (required)
Returns:: Call<GuidCreatedOnVersionHolder>

updateTemplate

@Headers(value="Content-Type:application/json")
 @POST(value="v3/templates/{guid}")
retrofit2.Call<GuidVersionHolder> updateTemplate(@Path(value="guid")
                                                                                                                                     String guid,
                                                                                                                                     @Body
                                                                                                                                     Template template)

Update an existing template Update an existing template.

Parameters:: guid - A guid (required); template - Updated template (required)
Returns:: Call<GuidVersionHolder>

updateUploadSchema

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v4/uploadschemas/{schemaId}/revisions/{revision}")
retrofit2.Call<UploadSchema> updateUploadSchema(@Path(value="schemaId")
                                                                                                                                                                              String schemaId,
                                                                                                                                                                              @Path(value="revision")
                                                                                                                                                                              Long revision,
                                                                                                                                                                              @Body
                                                                                                                                                                              UploadSchema uploadSchema)

Deprecated.

Update an upload schema

Parameters:: schemaId - Upload schema ID (required); revision - Revision number (required); uploadSchema - (required)
Returns:: Call<UploadSchema>

updateUsersApp

@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/self")
retrofit2.Call<VersionHolder> updateUsersApp(@Body
                                                                                                                          App app)

Update an app Update the app of the currently signed in developer account. This API only works for Developers (administrators should use the ForAdminsApi.updateApp() API).

Parameters:: app - (required)
Returns:: Call<VersionHolder>

verifyEmailForApp

@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/{appId}/emails/verify")
retrofit2.Call<Message> verifyEmailForApp(@Path(value="appId")
                                                                                                                                        String appId,
                                                                                                                                        @Query(value="token")
                                                                                                                                        String token,
                                                                                                                                        @Query(value="type")
                                                                                                                                        String type)

Verifies the app's email Verifies the app's email. Since this comes in from an email with a token, you don't need to be authenticated. The token itself knows what app this is for.

Parameters:: appId - App ID (required); token - Email verification token (required); type - Type of email that should resend email verification. (required)
Returns:: Call<Message>

verifySenderEmail
```
@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/self/verifyEmail")
retrofit2.Call<EmailVerificationStatus> verifySenderEmail()
```
Trigger SES email verification process Amazon SES will attempt to verify that it can send email from your support email address. If that fails or expires, this API will trigger another request to verify.

Returns:

Call<EmailVerificationStatus>

versionSurvey

@Deprecated
 @Headers(value="Content-Type:application/json")
 @POST(value="v3/surveys/{surveyGuid}/revisions/{createdOn}/version")
retrofit2.Call<GuidCreatedOnVersionHolder> versionSurvey(@Path(value="surveyGuid")
                                                                                                                                                                                            String surveyGuid,
                                                                                                                                                                                            @Path(value="createdOn")
                                                                                                                                                                                            DateTime createdOn)

Deprecated.

Version a survey

Parameters:: surveyGuid - Survey GUID (required); createdOn - Created on timestamp (ISO 8601) (required)
Returns:: Call<GuidCreatedOnVersionHolder>

Interface ForDevelopersApi

Method Summary

Method Detail

addNewDefaultConsentRevision

addParticipantReportRecordV4

addStudyReportRecord

createActivityEventForParticipant

createAppConfig

createAppConfigElement

createAssessment

createAssessmentResource

createAssessmentRevision

createCompoundActivityDefinition

createConsent

createFile

createFileRevision

createMetadata

createNotificationTopic

createOrUpdateHealthDataDocumentation

createOrUpdateUploadSchema

createParticipant

createSchedulePlan

createStudyLogo

createStudyParticipant

createSubpopulation

createSurvey

createSynapseProjectTeam

createTemplate

createTemplateRevision

createUploadSchema

customizeAssessmentConfig

deleteAllAppConfigElementRevisions

deleteAllParticipantReportRecords

deleteAllRevisionsOfUploadSchema

deleteAllStudyReportRecords

deleteAppConfig

deleteAppConfigElement

deleteAssessment

deleteAssessmentResource

deleteCompoundActivityDefinition

deleteDemographicsValidationConfig

deleteDemographicsValidationConfigAppLevel

deleteFile

deleteMetadataByIdAllVersions

deleteMetadataByIdAndVersion

deleteNotificationTopic

deleteParticipantReportRecord

deleteSchedulePlan

deleteStudy

deleteStudyReportRecord

deleteSubpopulation

deleteSurvey

deleteTemplate

deleteUploadSchema

finishFileRevision

finishStudyLogoUpload

getAdherenceStatistics

getAllAppConfigElementRevisions

getAllCompoundActivityDefinitions

getAllConsents

getAllDefaultConsentRevisions

getAllHealthDataDocumentationForParentId

getAllRevisionsOfUploadSchema

getAllVersionsOfSurvey

getAppConfig

getAppConfigElement

getAppConfigs

getAppEmailStatus

getAppPublicCsmKey

getAssessmentByGUID

getAssessmentById

getAssessmentConfig

getAssessmentResource

getAssessmentResources

getAssessmentRevisionsByGUID

getAssessmentRevisionsById

getAssessments

getCompoundActivityDefinition

getConsent

getDefaultConsentRevision