Package | Description |
---|---|
org.sagebionetworks.bridge.rest.api |
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
ForOrgAdminsApi.addMember(String orgId,
String userId)
Add user as a member of the organization (this will return an error if the user is already assigned to another organization).
|
retrofit2.Call<Message> |
ForAdminsApi.addMember(String orgId,
String userId)
Add user as a member of the organization (this will return an error if the user is already assigned to another organization).
|
retrofit2.Call<Message> |
OrganizationsApi.addMember(String orgId,
String userId)
Add user as a member of the organization (this will return an error if the user is already assigned to another organization).
|
retrofit2.Call<Message> |
ParticipantReportsApi.addParticipantReportRecord(String identifier,
ReportDataForWorker reportData)
Add a participant report record
Endpoint for a worker to add a report record for a participant.
|
retrofit2.Call<Message> |
ForWorkersApi.addParticipantReportRecord(String identifier,
ReportDataForWorker reportData)
Add a participant report record
Endpoint for a worker to add a report record for a participant.
|
retrofit2.Call<Message> |
ForDevelopersApi.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> |
ParticipantReportsApi.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> |
ForWorkersApi.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> |
ForDevelopersApi.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> |
StudyReportsApi.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> |
ForWorkersApi.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> |
ForAdminsApi.addStudySponsor(String studyId,
String orgId)
Add this organization as a sponsor
|
retrofit2.Call<Message> |
OrganizationsApi.addStudySponsor(String studyId,
String orgId)
Add this organization as a sponsor
|
retrofit2.Call<Message> |
StudiesApi.addStudySponsor(String studyId,
String orgId)
Add this organization as a sponsor
|
retrofit2.Call<Message> |
ForAdminsApi.addStudySponsorship(String orgId,
String studyId)
Sponsor this study
|
retrofit2.Call<Message> |
OrganizationsApi.addStudySponsorship(String orgId,
String studyId)
Sponsor this study
|
retrofit2.Call<Message> |
ForSuperadminsApi.addTag(Tag tag)
Create a tag if it does not yet exist.
|
retrofit2.Call<Message> |
TagsApi.addTag(Tag tag)
Create a tag if it does not yet exist.
|
retrofit2.Call<Message> |
ForWorkersApi.backfillParticipantVersion(String appId,
String userId)
Backfills participant version.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.changeSharingScope(SharingScopeForm sharingScope)
Change the participant's sharing scope
|
retrofit2.Call<Message> |
ForDevelopersApi.createActivityEventForParticipant(String userId,
CustomActivityEventRequest customActivityEventRequest)
Deprecated.
|
retrofit2.Call<Message> |
ForResearchersApi.createActivityEventForParticipant(String userId,
CustomActivityEventRequest customActivityEventRequest)
Deprecated.
|
retrofit2.Call<Message> |
ActivityEventsApi.createActivityEventForParticipant(String userId,
CustomActivityEventRequest customActivityEventRequest)
Deprecated.
|
retrofit2.Call<Message> |
ForDevelopersApi.createConsent(String subpopulationGuid,
StudyConsent studyConsent)
Add a new study consent version to this subpopulation
|
retrofit2.Call<Message> |
StudyConsentsApi.createConsent(String subpopulationGuid,
StudyConsent studyConsent)
Add a new study consent version to this subpopulation
|
retrofit2.Call<Message> |
ForConsentedUsersApi.createCustomActivityEvent(CustomActivityEventRequest customActivityEventRequest)
Deprecated.
|
retrofit2.Call<Message> |
ActivityEventsApi.createCustomActivityEvent(CustomActivityEventRequest customActivityEventRequest)
Deprecated.
|
retrofit2.Call<Message> |
InternalApi.createSmsRegistration(String userId)
Create an SMS notification registration for the given user.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.createStudyActivityEvent(String studyId,
StudyActivityEventRequest studyActivityEventRequest,
Boolean showError,
Boolean updateBursts)
Create a new activity event for the caller in this study.
|
retrofit2.Call<Message> |
StudyActivityEventsApi.createStudyActivityEvent(String studyId,
StudyActivityEventRequest studyActivityEventRequest,
Boolean showError,
Boolean updateBursts)
Create a new activity event for the caller in this study.
|
retrofit2.Call<Message> |
StudiesApi.createStudyActivityEvent(String studyId,
StudyActivityEventRequest studyActivityEventRequest,
Boolean showError,
Boolean updateBursts)
Create a new activity event for the caller in this study.
|
retrofit2.Call<Message> |
ForResearchersApi.createStudyParticipantStudyActivityEvent(String studyId,
String userId,
StudyActivityEventRequest customActivityEventRequest,
Boolean showError,
Boolean updateBursts)
Create a new activity event for a participant in this study.
|
retrofit2.Call<Message> |
StudyParticipantsApi.createStudyParticipantStudyActivityEvent(String studyId,
String userId,
StudyActivityEventRequest customActivityEventRequest,
Boolean showError,
Boolean updateBursts)
Create a new activity event for a participant in this study.
|
retrofit2.Call<Message> |
StudyActivityEventsApi.createStudyParticipantStudyActivityEvent(String studyId,
String userId,
StudyActivityEventRequest customActivityEventRequest,
Boolean showError,
Boolean updateBursts)
Create a new activity event for a participant in this study.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.createStudyParticipantStudyActivityEvent(String studyId,
String userId,
StudyActivityEventRequest customActivityEventRequest,
Boolean showError,
Boolean updateBursts)
Create a new activity event for a participant in this study.
|
retrofit2.Call<Message> |
ForDevelopersApi.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<Message> |
AppsApi.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<Message> |
ForOrgAdminsApi.deleteAccount(String userId)
Delete an administrative account
|
retrofit2.Call<Message> |
AccountsApi.deleteAccount(String userId)
Delete an administrative account
|
retrofit2.Call<Message> |
ForResearchersApi.deleteAdherenceRecord(String studyId,
String userId,
String instanceGuid,
DateTime eventTimestamp,
DateTime startedOn)
Delete an adherence record
Delete an existing adherence record
|
retrofit2.Call<Message> |
StudyAdherenceApi.deleteAdherenceRecord(String studyId,
String userId,
String instanceGuid,
DateTime eventTimestamp,
DateTime startedOn)
Delete an adherence record
Delete an existing adherence record
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.deleteAdherenceRecord(String studyId,
String userId,
String instanceGuid,
DateTime eventTimestamp,
DateTime startedOn)
Delete an adherence record
Delete an existing adherence record
|
retrofit2.Call<Message> |
AlertsApi.deleteAlerts(String studyId,
AlertIdCollection alertIdCollection)
Deletes alerts given a list of their ids.
|
retrofit2.Call<Message> |
ForResearchersApi.deleteAlerts(String studyId,
AlertIdCollection alertIdCollection)
Deletes alerts given a list of their ids.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.deleteAlerts(String studyId,
AlertIdCollection alertIdCollection)
Deletes alerts given a list of their ids.
|
retrofit2.Call<Message> |
StudiesApi.deleteAlerts(String studyId,
AlertIdCollection alertIdCollection)
Deletes alerts given a list of their ids.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteAllAppConfigElementRevisions(String id,
Boolean physical)
Delete all revisions of an app config element
Delete all revisions of an app config element.
|
retrofit2.Call<Message> |
AppConfigsApi.deleteAllAppConfigElementRevisions(String id,
Boolean physical)
Delete all revisions of an app config element
Delete all revisions of an app config element.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteAllAppConfigElementRevisions(String id,
Boolean physical)
Delete all revisions of an app config element
Delete all revisions of an app config element.
|
retrofit2.Call<Message> |
HealthDataDocumentationApi.deleteAllHealthDataDocumentationForParentId(String parentId)
Delete all documentation associated with given parentId
|
retrofit2.Call<Message> |
ForAdminsApi.deleteAllHealthDataDocumentationForParentId(String parentId)
Delete all documentation associated with given parentId
|
retrofit2.Call<Message> |
ForAdminsApi.deleteAllParticipantDataForAdmin(String appId,
String userId)
Delete all participant data
Endpoint for admin to delete all participant data for the given participant.
|
retrofit2.Call<Message> |
ParticipantDataApi.deleteAllParticipantDataForAdmin(String appId,
String userId)
Delete all participant data
Endpoint for admin to delete all participant data for the given participant.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteAllParticipantReportRecords(String userId,
String identifier)
Delete a participant report (all records)
|
retrofit2.Call<Message> |
ParticipantReportsApi.deleteAllParticipantReportRecords(String userId,
String identifier)
Delete a participant report (all records)
|
retrofit2.Call<Message> |
ForWorkersApi.deleteAllParticipantReportRecords(String userId,
String identifier)
Delete a participant report (all records)
|
retrofit2.Call<Message> |
InternalApi.deleteAllParticipantVersionsForUser(String userId)
Delete all participant versions for the given user.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteAllRevisionsOfUploadSchema(String schemaId,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
UploadSchemasApi.deleteAllRevisionsOfUploadSchema(String schemaId,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteAllRevisionsOfUploadSchema(String schemaId,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteAllStudyReportRecords(String identifier)
Delete a study report (all records)
|
retrofit2.Call<Message> |
StudyReportsApi.deleteAllStudyReportRecords(String identifier)
Delete a study report (all records)
|
retrofit2.Call<Message> |
ForWorkersApi.deleteAllStudyReportRecords(String identifier)
Delete a study report (all records)
|
retrofit2.Call<Message> |
ForSuperadminsApi.deleteApp(String appId,
Boolean physical)
Delete a app
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteAppConfig(String guid,
Boolean physical)
Delete an app config
Delete an existing configuration object.
|
retrofit2.Call<Message> |
AppConfigsApi.deleteAppConfig(String guid,
Boolean physical)
Delete an app config
Delete an existing configuration object.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteAppConfig(String guid,
Boolean physical)
Delete an app config
Delete an existing configuration object.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteAppConfigElement(String id,
Long revision,
Boolean physical)
Delete an app config element
Delete an existing configuration element.
|
retrofit2.Call<Message> |
AppConfigsApi.deleteAppConfigElement(String id,
Long revision,
Boolean physical)
Delete an app config element
Delete an existing configuration element.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteAppConfigElement(String id,
Long revision,
Boolean physical)
Delete an app config element
Delete an existing configuration element.
|
retrofit2.Call<Message> |
AssessmentsApi.deleteAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
ForStudyDesignersApi.deleteAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
AssessmentsApi.deleteAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting an assessment
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting an assessment
|
retrofit2.Call<Message> |
ForStudyDesignersApi.deleteAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting an assessment
|
retrofit2.Call<Message> |
ForAdminsApi.deleteAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting an assessment
|
retrofit2.Call<Message> |
ForSuperadminsApi.deleteCacheKeys(String cacheKey)
Get all the non-session Redis keys
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteCompoundActivityDefinition(String taskId)
Deprecated.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.deleteCustomActivityEvent(String eventId)
Deprecated.
|
retrofit2.Call<Message> |
ActivityEventsApi.deleteCustomActivityEvent(String eventId)
Deprecated.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.deleteDataByIdentifier(String identifier)
delete a participant data record
|
retrofit2.Call<Message> |
ParticipantDataApi.deleteDataByIdentifier(String identifier)
delete a participant data record
|
retrofit2.Call<Message> |
ForAdminsApi.deleteDataForAdmin(String appId,
String userId,
String identifier)
Delete a participant data
Endpoint for admin to delete a participnt data.
|
retrofit2.Call<Message> |
ParticipantDataApi.deleteDataForAdmin(String appId,
String userId,
String identifier)
Delete a participant data
Endpoint for admin to delete a participnt data.
|
retrofit2.Call<Message> |
DemographicsApi.deleteDemographic(String studyId,
String userId,
String demographicId)
Deletes a specific demographic (single category) for a particular user
Deletes a specific demographic (single category) for a particular user (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
ForResearchersApi.deleteDemographic(String studyId,
String userId,
String demographicId)
Deletes a specific demographic (single category) for a particular user
Deletes a specific demographic (single category) for a particular user (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
StudyParticipantsApi.deleteDemographic(String studyId,
String userId,
String demographicId)
Deletes a specific demographic (single category) for a particular user
Deletes a specific demographic (single category) for a particular user (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.deleteDemographic(String studyId,
String userId,
String demographicId)
Deletes a specific demographic (single category) for a particular user
Deletes a specific demographic (single category) for a particular user (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
DemographicsApi.deleteDemographicAppLevel(String userId,
String demographicId)
Deletes a specific demographic (single category) for a particular user
Deletes a specific demographic (single category) for a particular user (app-level, done by app admin)
|
retrofit2.Call<Message> |
ForAdminsApi.deleteDemographicAppLevel(String userId,
String demographicId)
Deletes a specific demographic (single category) for a particular user
Deletes a specific demographic (single category) for a particular user (app-level, done by app admin)
|
retrofit2.Call<Message> |
DemographicsApi.deleteDemographicsValidationConfig(String studyId,
String categoryName)
Delete a DemographicValuesValidationConfig
Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteDemographicsValidationConfig(String studyId,
String categoryName)
Delete a DemographicValuesValidationConfig
Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation.
|
retrofit2.Call<Message> |
ForStudyDesignersApi.deleteDemographicsValidationConfig(String studyId,
String categoryName)
Delete a DemographicValuesValidationConfig
Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation.
|
retrofit2.Call<Message> |
StudyParticipantsApi.deleteDemographicsValidationConfig(String studyId,
String categoryName)
Delete a DemographicValuesValidationConfig
Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation.
|
retrofit2.Call<Message> |
DemographicsApi.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> |
ForDevelopersApi.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> |
ForAdminsApi.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> |
DemographicsApi.deleteDemographicUser(String studyId,
String userId)
Deletes all of a user's demographics
Deletes all of a user's demographics (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
ForResearchersApi.deleteDemographicUser(String studyId,
String userId)
Deletes all of a user's demographics
Deletes all of a user's demographics (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
StudyParticipantsApi.deleteDemographicUser(String studyId,
String userId)
Deletes all of a user's demographics
Deletes all of a user's demographics (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.deleteDemographicUser(String studyId,
String userId)
Deletes all of a user's demographics
Deletes all of a user's demographics (study-level, done by researcher or study coordinator)
|
retrofit2.Call<Message> |
DemographicsApi.deleteDemographicUserAppLevel(String userId)
Deletes all of a user's demographics
Deletes all of a user's demographics (app-level, done by app admin)
|
retrofit2.Call<Message> |
ForAdminsApi.deleteDemographicUserAppLevel(String userId)
Deletes all of a user's demographics
Deletes all of a user's demographics (app-level, done by app admin)
|
retrofit2.Call<Message> |
ForAdminsApi.deleteExternalId(String externalId)
Deprecated.
|
retrofit2.Call<Message> |
StudiesApi.deleteExternalId(String externalId)
Deprecated.
|
retrofit2.Call<Message> |
ForDevelopersApi.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> |
HostedFilesApi.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> |
ForAdminsApi.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> |
HealthDataDocumentationApi.deleteHealthDataDocumentationForIdentifier(String identifier)
Delete a health data documentation with the given identifier.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteHealthDataDocumentationForIdentifier(String identifier)
Delete a health data documentation with the given identifier.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteMetadataByIdAllVersions(String moduleId,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteMetadataByIdAllVersions(String moduleId,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteMetadataByIdAndVersion(String moduleId,
Integer moduleVersion,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteMetadataByIdAndVersion(String moduleId,
Integer moduleVersion,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.deleteNotificationRegistration(String guid)
Delete a push notification registration
Delete a registration record.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteNotificationTopic(String guid,
Boolean physical)
Delete a notification topic
|
retrofit2.Call<Message> |
NotificationsApi.deleteNotificationTopic(String guid,
Boolean physical)
Delete a notification topic
|
retrofit2.Call<Message> |
ForAdminsApi.deleteNotificationTopic(String guid,
Boolean physical)
Delete a notification topic
|
retrofit2.Call<Message> |
ForAdminsApi.deleteOrganization(String orgId)
Delete an organization.
|
retrofit2.Call<Message> |
OrganizationsApi.deleteOrganization(String orgId)
Delete an organization.
|
retrofit2.Call<Message> |
ForResearchersApi.deleteParticipant(String userId)
Delete a study participant if the record has the `test_user` data group, or the account has not been used by the participant (the participant has never signed in to Bridge using the account) and it is only enrolled in one study.
|
retrofit2.Call<Message> |
ParticipantsApi.deleteParticipant(String userId)
Delete a study participant if the record has the `test_user` data group, or the account has not been used by the participant (the participant has never signed in to Bridge using the account) and it is only enrolled in one study.
|
retrofit2.Call<Message> |
ForResearchersApi.deleteParticipantActivities(String userId)
Deprecated.
|
retrofit2.Call<Message> |
ParticipantsApi.deleteParticipantActivities(String userId)
Deprecated.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.deleteParticipantFile(String fileId)
Delete a participant file
Delete a participant file
|
retrofit2.Call<Message> |
ParticipantFilesApi.deleteParticipantFile(String fileId)
Delete a participant file
Delete a participant file
|
retrofit2.Call<Message> |
ForAdminsApi.deleteParticipantReportIndex(String identifier)
Delete a participant report index
Delete a participant report index.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteParticipantReportRecord(String userId,
String identifier,
LocalDate date)
Delete a record for a specific day of a participant report
|
retrofit2.Call<Message> |
ParticipantReportsApi.deleteParticipantReportRecord(String userId,
String identifier,
LocalDate date)
Delete a record for a specific day of a participant report
|
retrofit2.Call<Message> |
ForWorkersApi.deleteParticipantReportRecord(String userId,
String identifier,
LocalDate date)
Delete a record for a specific day of a participant report
|
retrofit2.Call<Message> |
PermissionsApi.deletePermission(String guid)
Delete a permission record, removing a user's access to an entity.
|
retrofit2.Call<Message> |
ForAdminsApi.deletePermission(String guid)
Delete a permission record, removing a user's access to an entity.
|
retrofit2.Call<Message> |
ForSuperadminsApi.deleteRecordsEx3ForUser(String appId,
String userId)
Deletes all health data records from the Exporter 3 implementation for the given user.
|
retrofit2.Call<Message> |
InternalApi.deleteRecordsEx3ForUser(String appId,
String userId)
Deletes all health data records from the Exporter 3 implementation for the given user.
|
retrofit2.Call<Message> |
SchedulesV2Api.deleteSchedule(String guid)
Delete a schedule.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteSchedule(String guid)
Delete a schedule.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteSchedulePlan(String schedulePlanGuid,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
SchedulesV1Api.deleteSchedulePlan(String schedulePlanGuid,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteSchedulePlan(String schedulePlanGuid,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForSuperadminsApi.deleteSchedulerConfig(String scheduleId)
Delete a scheduler config
|
retrofit2.Call<Message> |
ForSuperadminsApi.deleteSharedAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
SharedAssessmentsApi.deleteSharedAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
ForSuperadminsApi.deleteSharedAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting a shared assessment
|
retrofit2.Call<Message> |
SharedAssessmentsApi.deleteSharedAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting a shared assessment
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteStudy(String studyId,
Boolean physical)
Delete a study.
|
retrofit2.Call<Message> |
ForStudyDesignersApi.deleteStudy(String studyId,
Boolean physical)
Delete a study.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteStudy(String studyId,
Boolean physical)
Delete a study.
|
retrofit2.Call<Message> |
StudiesApi.deleteStudy(String studyId,
Boolean physical)
Delete a study.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.deleteStudyActivityEvent(String studyId,
String eventId,
Boolean showError)
Delete an activity event (for the caller) if it is mutable.
|
retrofit2.Call<Message> |
StudyActivityEventsApi.deleteStudyActivityEvent(String studyId,
String eventId,
Boolean showError)
Delete an activity event (for the caller) if it is mutable.
|
retrofit2.Call<Message> |
StudiesApi.deleteStudyActivityEvent(String studyId,
String eventId,
Boolean showError)
Delete an activity event (for the caller) if it is mutable.
|
retrofit2.Call<Message> |
ForResearchersApi.deleteStudyParticipant(String studyId,
String userId)
Delete a study participant if the record has the `test_user` data group, or the account has not been used by the participant (the participant has never signed in to Bridge using the account) and it is only enrolled in one study.
|
retrofit2.Call<Message> |
StudyParticipantsApi.deleteStudyParticipant(String studyId,
String userId)
Delete a study participant if the record has the `test_user` data group, or the account has not been used by the participant (the participant has never signed in to Bridge using the account) and it is only enrolled in one study.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.deleteStudyParticipant(String studyId,
String userId)
Delete a study participant if the record has the `test_user` data group, or the account has not been used by the participant (the participant has never signed in to Bridge using the account) and it is only enrolled in one study.
|
retrofit2.Call<Message> |
ForStudyDesignersApi.deleteStudyParticipantReport(String studyId,
String userId,
String identifier)
Delete all records for a report for one member of the study.
|
retrofit2.Call<Message> |
StudyParticipantsApi.deleteStudyParticipantReport(String studyId,
String userId,
String identifier)
Delete all records for a report for one member of the study.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.deleteStudyParticipantReport(String studyId,
String userId,
String identifier)
Delete all records for a report for one member of the study.
|
retrofit2.Call<Message> |
ForStudyDesignersApi.deleteStudyParticipantReportIndex(String studyId,
String identifier)
Delete a single report index (note that deleting an index in effect makes all report records under that identifier less accessible...the reports are not deleted, but they are not listed in the indices, either).
|
retrofit2.Call<Message> |
StudyParticipantsApi.deleteStudyParticipantReportIndex(String studyId,
String identifier)
Delete a single report index (note that deleting an index in effect makes all report records under that identifier less accessible...the reports are not deleted, but they are not listed in the indices, either).
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.deleteStudyParticipantReportIndex(String studyId,
String identifier)
Delete a single report index (note that deleting an index in effect makes all report records under that identifier less accessible...the reports are not deleted, but they are not listed in the indices, either).
|
retrofit2.Call<Message> |
ForStudyDesignersApi.deleteStudyParticipantReportRecord(String studyId,
String userId,
String identifier,
DateTime date)
Delete one record for a report for one member of the study.
|
retrofit2.Call<Message> |
StudyParticipantsApi.deleteStudyParticipantReportRecord(String studyId,
String userId,
String identifier,
DateTime date)
Delete one record for a report for one member of the study.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.deleteStudyParticipantReportRecord(String studyId,
String userId,
String identifier,
DateTime date)
Delete one record for a report for one member of the study.
|
retrofit2.Call<Message> |
ForResearchersApi.deleteStudyParticipantStudyActivityEvent(String studyId,
String userId,
String eventId,
Boolean showError)
Delete activity event for a study participant if it is mutable.
|
retrofit2.Call<Message> |
StudyParticipantsApi.deleteStudyParticipantStudyActivityEvent(String studyId,
String userId,
String eventId,
Boolean showError)
Delete activity event for a study participant if it is mutable.
|
retrofit2.Call<Message> |
StudyActivityEventsApi.deleteStudyParticipantStudyActivityEvent(String studyId,
String userId,
String eventId,
Boolean showError)
Delete activity event for a study participant if it is mutable.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.deleteStudyParticipantStudyActivityEvent(String studyId,
String userId,
String eventId,
Boolean showError)
Delete activity event for a study participant if it is mutable.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteStudyReportRecord(String identifier,
LocalDate date)
Delete a record for a specific day of a study report
|
retrofit2.Call<Message> |
StudyReportsApi.deleteStudyReportRecord(String identifier,
LocalDate date)
Delete a record for a specific day of a study report
|
retrofit2.Call<Message> |
ForWorkersApi.deleteStudyReportRecord(String identifier,
LocalDate date)
Delete a record for a specific day of a study report
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteSubpopulation(String subpopulationGuid,
Boolean physical)
Delete a subpopulation
Delete a subpopulation unless it is a default subpopulation, which cannot be deleted.
|
retrofit2.Call<Message> |
SubpopulationsApi.deleteSubpopulation(String subpopulationGuid,
Boolean physical)
Delete a subpopulation
Delete a subpopulation unless it is a default subpopulation, which cannot be deleted.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteSubpopulation(String subpopulationGuid,
Boolean physical)
Delete a subpopulation
Delete a subpopulation unless it is a default subpopulation, which cannot be deleted.
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteSurvey(String surveyGuid,
DateTime createdOn,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
SurveysApi.deleteSurvey(String surveyGuid,
DateTime createdOn,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteSurvey(String surveyGuid,
DateTime createdOn,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForSuperadminsApi.deleteTag(String tagValue)
Delete a tag
|
retrofit2.Call<Message> |
TagsApi.deleteTag(String tagValue)
Delete a tag
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteTemplate(String guid,
Boolean physical)
Delete template (and all revisions)
Delete an existing template (and all its revisions).
|
retrofit2.Call<Message> |
TemplatesApi.deleteTemplate(String guid,
Boolean physical)
Delete template (and all revisions)
Delete an existing template (and all its revisions).
|
retrofit2.Call<Message> |
ForAdminsApi.deleteTemplate(String guid,
Boolean physical)
Delete template (and all revisions)
Delete an existing template (and all its revisions).
|
retrofit2.Call<Message> |
ForDevelopersApi.deleteUploadSchema(String schemaId,
Long revision,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
UploadSchemasApi.deleteUploadSchema(String schemaId,
Long revision,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteUploadSchema(String schemaId,
Long revision,
Boolean physical)
Deprecated.
|
retrofit2.Call<Message> |
ForAdminsApi.deleteUser(String userId)
Delete a user
This is a heavyweight operation; it is better to disable a user account when possible.
|
retrofit2.Call<Message> |
ForDevelopersApi.finishFileRevision(String guid,
DateTime createdOn)
Indicate to the server that a file revision upload has been completed.
|
retrofit2.Call<Message> |
HostedFilesApi.finishFileRevision(String guid,
DateTime createdOn)
Indicate to the server that a file revision upload has been completed.
|
retrofit2.Call<Message> |
AlertsApi.markAlertsRead(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as read.
|
retrofit2.Call<Message> |
ForResearchersApi.markAlertsRead(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as read.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.markAlertsRead(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as read.
|
retrofit2.Call<Message> |
StudiesApi.markAlertsRead(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as read.
|
retrofit2.Call<Message> |
AlertsApi.markAlertsUnread(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as unread.
|
retrofit2.Call<Message> |
ForResearchersApi.markAlertsUnread(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as unread.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.markAlertsUnread(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as unread.
|
retrofit2.Call<Message> |
StudiesApi.markAlertsUnread(String studyId,
AlertIdCollection alertIdCollection)
Mark alerts as unread.
|
retrofit2.Call<Message> |
ForDevelopersApi.publishConsent(String subpopulationGuid,
DateTime createdOn)
Publish a specific consent revision
Publish a specific revision of this subpopulation consent by its creation timestamp.
|
retrofit2.Call<Message> |
StudyConsentsApi.publishConsent(String subpopulationGuid,
DateTime createdOn)
Publish a specific consent revision
Publish a specific revision of this subpopulation consent by its creation timestamp.
|
retrofit2.Call<Message> |
ForDevelopersApi.publishTemplateRevision(String guid,
DateTime createdOn)
Set a specific template revision as the version to use when the template is selected
|
retrofit2.Call<Message> |
TemplatesApi.publishTemplateRevision(String guid,
DateTime createdOn)
Set a specific template revision as the version to use when the template is selected
|
retrofit2.Call<Message> |
ForOrgAdminsApi.removeMember(String orgId,
String userId)
Remove a member from this organization (the user will no longer belong to any organization).
|
retrofit2.Call<Message> |
ForAdminsApi.removeMember(String orgId,
String userId)
Remove a member from this organization (the user will no longer belong to any organization).
|
retrofit2.Call<Message> |
OrganizationsApi.removeMember(String orgId,
String userId)
Remove a member from this organization (the user will no longer belong to any organization).
|
retrofit2.Call<Message> |
ForAdminsApi.removeStudySponsor(String studyId,
String orgId)
Remove this organization as a sponsor
|
retrofit2.Call<Message> |
StudiesApi.removeStudySponsor(String studyId,
String orgId)
Remove this organization as a sponsor
|
retrofit2.Call<Message> |
ForAdminsApi.removeStudySponsorship(String orgId,
String studyId)
Stop sponsoring this study
|
retrofit2.Call<Message> |
OrganizationsApi.removeStudySponsorship(String orgId,
String studyId)
Stop sponsoring this study
|
retrofit2.Call<Message> |
ForOrgAdminsApi.requestAccountResetPassword(String userId)
Send a password reset email or SMS message to the organization member.
|
retrofit2.Call<Message> |
AccountsApi.requestAccountResetPassword(String userId)
Send a password reset email or SMS message to the organization member.
|
retrofit2.Call<Message> |
AuthenticationApi.requestEmailSignIn(EmailSignInRequest emailSignInRequest)
Does not require authentication.
|
retrofit2.Call<Message> |
ForResearchersApi.requestParticipantRoster(ParticipantRosterRequest participantRosterRequest)
Request a roster of participants within an app, and optionally within a study if a studyId is provided.
|
retrofit2.Call<Message> |
ParticipantsApi.requestParticipantRoster(ParticipantRosterRequest participantRosterRequest)
Request a roster of participants within an app, and optionally within a study if a studyId is provided.
|
retrofit2.Call<Message> |
AuthenticationApi.requestPhoneSignIn(PhoneSignInRequest phoneSignInRequest)
Does not require authentication.
|
retrofit2.Call<Message> |
AuthenticationApi.requestResetPassword(SignIn signIn)
Does not require authentication.
|
retrofit2.Call<Message> |
StudyParticipantsApi.requestStudyParticipantRoster(String studyId,
ParticipantRosterRequest participantRosterRequest)
Request a roster of participants for a specific study.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.requestStudyParticipantRoster(String studyId,
ParticipantRosterRequest participantRosterRequest)
Request a roster of participants for a specific study.
|
retrofit2.Call<Message> |
ForOrgAdminsApi.resendAccountEmailVerification(String userId)
Resent an email verification email to the the organization member.
|
retrofit2.Call<Message> |
AccountsApi.resendAccountEmailVerification(String userId)
Resent an email verification email to the the organization member.
|
retrofit2.Call<Message> |
ForOrgAdminsApi.resendAccountPhoneVerification(String userId)
Resent an SMS verification message to the the organization member.
|
retrofit2.Call<Message> |
AccountsApi.resendAccountPhoneVerification(String userId)
Resent an SMS verification message to the the organization member.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.resendConsentAgreement(String subpopulationGuid)
Email or SMS the consent agreement to the participant
Although this method is to \"resend\" a consent agreement, if you have the automatic delivery of a signed consent disabled, this may be the method through which a user requests the consent for the first time, should they wish to retrieve a signed copy.
|
retrofit2.Call<Message> |
ConsentsApi.resendConsentAgreement(String subpopulationGuid)
Email or SMS the consent agreement to the participant
Although this method is to \"resend\" a consent agreement, if you have the automatic delivery of a signed consent disabled, this may be the method through which a user requests the consent for the first time, should they wish to retrieve a signed copy.
|
retrofit2.Call<Message> |
AuthenticationApi.resendEmailVerification(Identifier identifier)
Resend an email to the provided email address asking the address holder to verify their address.
|
retrofit2.Call<Message> |
ForResearchersApi.resendParticipantConsentAgreement(String userId,
String subpopulationGuid)
Re-send the consent agreement for this subpopulation
When called, re-sends a signed consent agreement document to the participant's email address.
|
retrofit2.Call<Message> |
ParticipantsApi.resendParticipantConsentAgreement(String userId,
String subpopulationGuid)
Re-send the consent agreement for this subpopulation
When called, re-sends a signed consent agreement document to the participant's email address.
|
retrofit2.Call<Message> |
AuthenticationApi.resendPhoneVerification(Identifier identifier)
Resend an SMS message to the provided phone number asking the recipient to verify their phone number.
|
retrofit2.Call<Message> |
ForResearchersApi.resendStudyParticipantConsentAgreement(String studyId,
String userId,
String guid)
Re-send the consent agreement for this study
When called, re-sends a signed consent agreement document to the participant’s email address.
|
retrofit2.Call<Message> |
StudyParticipantsApi.resendStudyParticipantConsentAgreement(String studyId,
String userId,
String guid)
Re-send the consent agreement for this study
When called, re-sends a signed consent agreement document to the participant’s email address.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.resendStudyParticipantConsentAgreement(String studyId,
String userId,
String guid)
Re-send the consent agreement for this study
When called, re-sends a signed consent agreement document to the participant’s email address.
|
retrofit2.Call<Message> |
ForDevelopersApi.resendVerifyEmail(String type)
Resends the verification email for the app's email.
|
retrofit2.Call<Message> |
AppsApi.resendVerifyEmail(String type)
Resends the verification email for the app's email.
|
retrofit2.Call<Message> |
AuthenticationApi.resetPassword(PasswordReset passwordReset)
This API will not normally be called directly by a client.
|
retrofit2.Call<Message> |
ForWorkersApi.saveDataForAdminWorker(String appId,
String userId,
String identifier,
ParticipantData participantData)
Save a participant data
Endpoint for worker or admin to save a participant data.
|
retrofit2.Call<Message> |
ForAdminsApi.saveDataForAdminWorker(String appId,
String userId,
String identifier,
ParticipantData participantData)
Save a participant data
Endpoint for worker or admin to save a participant data.
|
retrofit2.Call<Message> |
ParticipantDataApi.saveDataForAdminWorker(String appId,
String userId,
String identifier,
ParticipantData participantData)
Save a participant data
Endpoint for worker or admin to save a participant data.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.saveDataForSelf(String identifier,
ParticipantData participantData)
Save a participant data record
Save a participant record.
|
retrofit2.Call<Message> |
ParticipantDataApi.saveDataForSelf(String identifier,
ParticipantData participantData)
Save a participant data record
Save a participant record.
|
retrofit2.Call<Message> |
ParticipantReportsApi.saveParticipantReportRecordsV4(String identifier,
ReportData reportData)
Save a participant report record
Save a report record.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.saveParticipantReportRecordsV4(String identifier,
ReportData reportData)
Save a participant report record
Save a report record.
|
retrofit2.Call<Message> |
ForWorkersApi.saveReport(String appId,
String identifier,
ReportData reportData)
save report for a study
Save a report for a specified study with arbitrary report id given by wokers into bridgePF.
|
retrofit2.Call<Message> |
ForStudyDesignersApi.saveStudyParticipantReportRecord(String studyId,
String userId,
String identifier,
ReportData reportData)
Add a participant report for a single date and time (this API uses dates and times and not just dates; use a standard time of day portion like “T00:00:00.000Z” if a time portion is unnecessary, being sure to create and retrieve records with the same set time).
|
retrofit2.Call<Message> |
StudyParticipantsApi.saveStudyParticipantReportRecord(String studyId,
String userId,
String identifier,
ReportData reportData)
Add a participant report for a single date and time (this API uses dates and times and not just dates; use a standard time of day portion like “T00:00:00.000Z” if a time portion is unnecessary, being sure to create and retrieve records with the same set time).
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.saveStudyParticipantReportRecord(String studyId,
String userId,
String identifier,
ReportData reportData)
Add a participant report for a single date and time (this API uses dates and times and not just dates; use a standard time of day portion like “T00:00:00.000Z” if a time portion is unnecessary, being sure to create and retrieve records with the same set time).
|
retrofit2.Call<Message> |
StudyParticipantsApi.saveUsersStudyParticipantReportRecord(String studyId,
String identifier,
ReportData reportData)
Add a participant report for a single date and time for the caller (this API uses dates and times and not just dates; use a standard time of day portion like “T00:00:00.000Z” if a time portion is unnecessary, being sure to create and retrieve records with the same set time).
|
retrofit2.Call<Message> |
ForConsentedUsersApi.saveUsersStudyParticipantReportRecord(String studyId,
String identifier,
ReportData reportData)
Add a participant report for a single date and time for the caller (this API uses dates and times and not just dates; use a standard time of day portion like “T00:00:00.000Z” if a time portion is unnecessary, being sure to create and retrieve records with the same set time).
|
retrofit2.Call<Message> |
ForConsentedUsersApi.sendDataToUser(DateRange dateRange)
Make user's data available for download via email or an SMS message
Asynchronously request the uploaded data for this user, in a given time range (inclusive).
|
retrofit2.Call<Message> |
ForWorkersApi.sendExportNotifications(ExportToAppNotification exportToAppNotification)
Called by the Worker to send export notifications.
|
retrofit2.Call<Message> |
ForResearchersApi.sendInstallLinkMessage(String userId)
Send a message (SMS or email) to a participant explaining how to download and install the app
When called, sends either an SMS message or an email message (depending on whether the account has a verified email address or phone number.
|
retrofit2.Call<Message> |
ParticipantsApi.sendInstallLinkMessage(String userId)
Send a message (SMS or email) to a participant explaining how to download and install the app
When called, sends either an SMS message or an email message (depending on whether the account has a verified email address or phone number.
|
retrofit2.Call<Message> |
ForResearchersApi.sendNotificationToParticipant(String userId,
NotificationMessage notificationMessage)
Send a push notification to a single participant
Send a push notification to an individual participant (assuming they have registered for push notifications).
|
retrofit2.Call<Message> |
ParticipantsApi.sendNotificationToParticipant(String userId,
NotificationMessage notificationMessage)
Send a push notification to a single participant
Send a push notification to an individual participant (assuming they have registered for push notifications).
|
retrofit2.Call<Message> |
NotificationsApi.sendNotificationToParticipant(String userId,
NotificationMessage notificationMessage)
Send a push notification to a single participant
Send a push notification to an individual participant (assuming they have registered for push notifications).
|
retrofit2.Call<Message> |
NotificationsApi.sendNotificationToTopic(String guid,
NotificationMessage notificationMessage)
Send a push notification to all topic subscribers
|
retrofit2.Call<Message> |
ForAdminsApi.sendNotificationToTopic(String guid,
NotificationMessage notificationMessage)
Send a push notification to all topic subscribers
|
retrofit2.Call<Message> |
ForResearchersApi.sendParticipantEmailVerification(String userId)
Resend an email verification email to this user
When called, resends the email to the user's email account, which contains a link they must click on to verify they control that email address.
|
retrofit2.Call<Message> |
ParticipantsApi.sendParticipantEmailVerification(String userId)
Resend an email verification email to this user
When called, resends the email to the user's email account, which contains a link they must click on to verify they control that email address.
|
retrofit2.Call<Message> |
ForResearchersApi.sendParticipantPhoneVerification(String userId)
Resend a phone verification to this user
When called, resends the SMS message to the user's email account, which contains a code they must enter into your application to call and verify this phone number.
|
retrofit2.Call<Message> |
ParticipantsApi.sendParticipantPhoneVerification(String userId)
Resend a phone verification to this user
When called, resends the SMS message to the user's email account, which contains a code they must enter into your application to call and verify this phone number.
|
retrofit2.Call<Message> |
ForResearchersApi.sendParticipantResetPassword(String userId)
Trigger a request to reset password for this user
When called, a reset password message will be sent to either the email address or the phone number for this account (preferencing the email address).
|
retrofit2.Call<Message> |
ParticipantsApi.sendParticipantResetPassword(String userId)
Trigger a request to reset password for this user
When called, a reset password message will be sent to either the email address or the phone number for this account (preferencing the email address).
|
retrofit2.Call<Message> |
ForWorkersApi.sendSmsMessageToParticipantForApp(String appId,
String userId,
SmsTemplate smsTemplate)
Send an SMS message to a single participant
Send an SMS message to an individual participant (assuming they have a verified phone number).
|
retrofit2.Call<Message> |
ForResearchersApi.sendStudyParticipantEmailVerification(String studyId,
String userId)
Resend an email verification email to this user
When called, resends the email to the user's email account, which contains a link they must click on to verify they control that email address.
|
retrofit2.Call<Message> |
StudyParticipantsApi.sendStudyParticipantEmailVerification(String studyId,
String userId)
Resend an email verification email to this user
When called, resends the email to the user's email account, which contains a link they must click on to verify they control that email address.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.sendStudyParticipantEmailVerification(String studyId,
String userId)
Resend an email verification email to this user
When called, resends the email to the user's email account, which contains a link they must click on to verify they control that email address.
|
retrofit2.Call<Message> |
StudyParticipantsApi.sendStudyParticipantInstallLinkMessage(String studyId,
String userId)
Send a message (SMS or email) to a participant explaining how to download and install the app
When called, sends either an SMS message or an email message (depending on whether the account has a verified email address or phone number.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.sendStudyParticipantInstallLinkMessage(String studyId,
String userId)
Send a message (SMS or email) to a participant explaining how to download and install the app
When called, sends either an SMS message or an email message (depending on whether the account has a verified email address or phone number.
|
retrofit2.Call<Message> |
ForResearchersApi.sendStudyParticipantNotification(String studyId,
String userId,
NotificationMessage notificationMessage)
Send a push notification to a single participant
Send a push notification to an individual participant (assuming they have registered for push notifications).
|
retrofit2.Call<Message> |
StudyParticipantsApi.sendStudyParticipantNotification(String studyId,
String userId,
NotificationMessage notificationMessage)
Send a push notification to a single participant
Send a push notification to an individual participant (assuming they have registered for push notifications).
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.sendStudyParticipantNotification(String studyId,
String userId,
NotificationMessage notificationMessage)
Send a push notification to a single participant
Send a push notification to an individual participant (assuming they have registered for push notifications).
|
retrofit2.Call<Message> |
ForResearchersApi.sendStudyParticipantPhoneVerification(String studyId,
String userId)
Resend a phone verification to this user
When called, resends the SMS message to the user’s email account, which contains a code they must enter into your application to call and verify this phone number.
|
retrofit2.Call<Message> |
StudyParticipantsApi.sendStudyParticipantPhoneVerification(String studyId,
String userId)
Resend a phone verification to this user
When called, resends the SMS message to the user’s email account, which contains a code they must enter into your application to call and verify this phone number.
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.sendStudyParticipantPhoneVerification(String studyId,
String userId)
Resend a phone verification to this user
When called, resends the SMS message to the user’s email account, which contains a code they must enter into your application to call and verify this phone number.
|
retrofit2.Call<Message> |
ForResearchersApi.sendStudyParticipantResetPassword(String studyId,
String userId)
Trigger a request to reset password for this user
When called, a reset password message will be sent to either the email address or the phone number for this account (with a preference for the email address).
|
retrofit2.Call<Message> |
StudyParticipantsApi.sendStudyParticipantResetPassword(String studyId,
String userId)
Trigger a request to reset password for this user
When called, a reset password message will be sent to either the email address or the phone number for this account (with a preference for the email address).
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.sendStudyParticipantResetPassword(String studyId,
String userId)
Trigger a request to reset password for this user
When called, a reset password message will be sent to either the email address or the phone number for this account (with a preference for the email address).
|
retrofit2.Call<Message> |
AuthenticationApi.signOut()
Delete the user's session on the server.
|
retrofit2.Call<Message> |
ForOrgAdminsApi.signOutAccount(String userId,
Boolean deleteReauthToken)
Sign the account out and delete their server session
|
retrofit2.Call<Message> |
AccountsApi.signOutAccount(String userId,
Boolean deleteReauthToken)
Sign the account out and delete their server session
|
retrofit2.Call<Message> |
ForResearchersApi.signOutParticipant(String userId,
Boolean deleteReauthToken)
Sign the user out and delete their server session
This endpoint can be called by researchers, and by other administrators for their own account.
|
retrofit2.Call<Message> |
ParticipantsApi.signOutParticipant(String userId,
Boolean deleteReauthToken)
Sign the user out and delete their server session
This endpoint can be called by researchers, and by other administrators for their own account.
|
retrofit2.Call<Message> |
ForResearchersApi.signOutStudyParticipant(String studyId,
String userId,
Boolean deleteReauthToken)
Sign the participant out and delete their server session
|
retrofit2.Call<Message> |
StudyParticipantsApi.signOutStudyParticipant(String studyId,
String userId,
Boolean deleteReauthToken)
Sign the participant out and delete their server session
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.signOutStudyParticipant(String studyId,
String userId,
Boolean deleteReauthToken)
Sign the participant out and delete their server session
|
retrofit2.Call<Message> |
AuthenticationApi.signUp(SignUp signUp)
If an app uses email addresses to identify account holders, the user will normally be sent an email with a link to verify his or her email address before the account will be activated.
|
retrofit2.Call<Message> |
ConsentsApi.submitIntentToParticipate(IntentToParticipate intentToParticipate)
Send a consent signature to Bridge before the user has signed up to the server.
|
retrofit2.Call<Message> |
PublicApi.submitIntentToParticipate(IntentToParticipate intentToParticipate)
Send a consent signature to Bridge before the user has signed up to the server.
|
retrofit2.Call<Message> |
IntentToParticipateApi.submitIntentToParticipate(IntentToParticipate intentToParticipate)
Send a consent signature to Bridge before the user has signed up to the server.
|
retrofit2.Call<Message> |
ForOrgAdminsApi.updateAccount(String userId,
Account account)
Update an administrative account
|
retrofit2.Call<Message> |
AccountsApi.updateAccount(String userId,
Account account)
Update an administrative account
|
retrofit2.Call<Message> |
AccountsApi.updateAccountForSelf(Account account)
Update the caller’s account (for admin accounts only).
|
retrofit2.Call<Message> |
StudyAdherenceApi.updateAdherenceRecords(String studyId,
AdherenceRecordUpdates adherenceRecordUpdates)
Create or update one or more adherence records.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.updateAdherenceRecords(String studyId,
AdherenceRecordUpdates adherenceRecordUpdates)
Create or update one or more adherence records.
|
retrofit2.Call<Message> |
ForDevelopersApi.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<Message> |
ForResearchersApi.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<Message> |
ForStudyDesignersApi.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<Message> |
StudyParticipantsApi.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<Message> |
ForStudyCoordinatorsApi.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<Message> |
StudiesApi.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<Message> |
ForResearchersApi.updateParticipant(String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
This endpoint can be called by researchers, and by other administrators for their own account account.
|
retrofit2.Call<Message> |
ParticipantsApi.updateParticipant(String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
This endpoint can be called by researchers, and by other administrators for their own account account.
|
retrofit2.Call<Message> |
ForSuperadminsApi.updateParticipantRequestInfo(String userId,
RequestInfo requestInfo)
Superadmin API to update a participant's request info.
|
retrofit2.Call<Message> |
RecordExportStatusesApi.updateRecordExportStatuses(RecordExportStatusRequest recordExportStatusRequest)
Updates the status of an export job
Updates the status of an export job on the health data records included in that job.
|
retrofit2.Call<Message> |
ForWorkersApi.updateRecordExportStatuses(RecordExportStatusRequest recordExportStatusRequest)
Updates the status of an export job
Updates the status of an export job on the health data records included in that job.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.updateScheduledActivities(List<ScheduledActivity> scheduledActivity)
Deprecated.
|
retrofit2.Call<Message> |
ActivitiesApi.updateScheduledActivities(List<ScheduledActivity> scheduledActivity)
Deprecated.
|
retrofit2.Call<Message> |
ForResearchersApi.updateStudyParticipant(String studyId,
String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
|
retrofit2.Call<Message> |
StudyParticipantsApi.updateStudyParticipant(String studyId,
String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.updateStudyParticipant(String studyId,
String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
|
retrofit2.Call<Message> |
ForDevelopersApi.updateStudyParticipantAdherenceRecords(String studyId,
String userId,
AdherenceRecordUpdates adherenceRecordUpdates)
Update one or more adherence records for a participant
|
retrofit2.Call<Message> |
ForResearchersApi.updateStudyParticipantAdherenceRecords(String studyId,
String userId,
AdherenceRecordUpdates adherenceRecordUpdates)
Update one or more adherence records for a participant
|
retrofit2.Call<Message> |
StudyAdherenceApi.updateStudyParticipantAdherenceRecords(String studyId,
String userId,
AdherenceRecordUpdates adherenceRecordUpdates)
Update one or more adherence records for a participant
|
retrofit2.Call<Message> |
ForStudyDesignersApi.updateStudyParticipantAdherenceRecords(String studyId,
String userId,
AdherenceRecordUpdates adherenceRecordUpdates)
Update one or more adherence records for a participant
|
retrofit2.Call<Message> |
StudyParticipantsApi.updateStudyParticipantAdherenceRecords(String studyId,
String userId,
AdherenceRecordUpdates adherenceRecordUpdates)
Update one or more adherence records for a participant
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.updateStudyParticipantAdherenceRecords(String studyId,
String userId,
AdherenceRecordUpdates adherenceRecordUpdates)
Update one or more adherence records for a participant
|
retrofit2.Call<Message> |
ForDevelopersApi.updateStudyReportIndex(String identifier,
ReportIndex reportIndex)
Update an existing study report index
Update the index (or metadata) for a set of report records.
|
retrofit2.Call<Message> |
StudyReportsApi.updateStudyReportIndex(String identifier,
ReportIndex reportIndex)
Update an existing study report index
Update the index (or metadata) for a set of report records.
|
retrofit2.Call<Message> |
AuthenticationApi.verifyEmail(Verification verification)
An email will be sent to the user with a link that when opened, will confirm the validity of this email address.
|
retrofit2.Call<Message> |
ForDevelopersApi.verifyEmailForApp(String appId,
String token,
String type)
Verifies the app's email
Verifies the app's email.
|
retrofit2.Call<Message> |
AppsApi.verifyEmailForApp(String appId,
String token,
String type)
Verifies the app's email
Verifies the app's email.
|
retrofit2.Call<Message> |
AuthenticationApi.verifyPhone(Verification verification)
Using the sptoken extracted from a link in an SMS message, or entered by the user as seen in an SMS message, call this method to confirm the validity of the phone number.
|
retrofit2.Call<Message> |
ForConsentedUsersApi.withdrawFromApp(Withdrawal withdrawal)
Withdraw user from all studies in app
Withdraw the user entirely from all studies in this app.
|
retrofit2.Call<Message> |
ConsentsApi.withdrawFromApp(Withdrawal withdrawal)
Withdraw user from all studies in app
Withdraw the user entirely from all studies in this app.
|
retrofit2.Call<Message> |
ForResearchersApi.withdrawParticipantFromApp(String userId,
Withdrawal withdrawal)
Withdraw the participant from all studies in this app
Withdraw the user entirely from all studies in this app.
|
retrofit2.Call<Message> |
ConsentsApi.withdrawParticipantFromApp(String userId,
Withdrawal withdrawal)
Withdraw the participant from all studies in this app
Withdraw the user entirely from all studies in this app.
|
retrofit2.Call<Message> |
ParticipantsApi.withdrawParticipantFromApp(String userId,
Withdrawal withdrawal)
Withdraw the participant from all studies in this app
Withdraw the user entirely from all studies in this app.
|
retrofit2.Call<Message> |
ForResearchersApi.withdrawParticipantFromSubpopulation(String userId,
String subpopulationGuid,
Withdrawal withdrawal)
Withdraw the participant from the specified subpopulation
This endpoint will withdraw the user from consent to participate in one subpopulation of the app.
|
retrofit2.Call<Message> |
ConsentsApi.withdrawParticipantFromSubpopulation(String userId,
String subpopulationGuid,
Withdrawal withdrawal)
Withdraw the participant from the specified subpopulation
This endpoint will withdraw the user from consent to participate in one subpopulation of the app.
|
retrofit2.Call<Message> |
ParticipantsApi.withdrawParticipantFromSubpopulation(String userId,
String subpopulationGuid,
Withdrawal withdrawal)
Withdraw the participant from the specified subpopulation
This endpoint will withdraw the user from consent to participate in one subpopulation of the app.
|
Copyright © 2023 Sage Bionetworks. All rights reserved.