public interface ForStudyDesignersApi
| Modifier and Type | Method and Description |
|---|---|
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<VersionHolder> |
createStudy(Study study)
Create a new study
|
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<AssessmentConfig> |
customizeAssessmentConfig(String guid,
Object customizationUpdate)
Submit updates to the config that conform to the allowed customizations for the assessment.
|
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> |
deleteDemographicsValidationConfig(String studyId,
String categoryName)
Delete a DemographicValuesValidationConfig
Delete an existing DemographicValuesValidationConfig which is used to configure demographics validation.
|
retrofit2.Call<Message> |
deleteStudy(String studyId,
Boolean physical)
Delete a study.
|
retrofit2.Call<Message> |
deleteStudyParticipantReport(String studyId,
String userId,
String identifier)
Delete all records for a report for one member of the study.
|
retrofit2.Call<Message> |
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> |
deleteStudyParticipantReportRecord(String studyId,
String userId,
String identifier,
DateTime date)
Delete one record for a report for one member of the study.
|
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<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<DemographicValuesValidationConfig> |
getDemographicsValidationConfig(String studyId,
String categoryName)
Fetch a DemographicValuesValidationConfig
Fetch an existing DemographicValuesValidationConfig which is used to configure demographics validation.
|
retrofit2.Call<ExternalIdentifierList> |
getExternalIdsForStudy(String studyId,
Integer offsetBy,
Integer pageSize,
String idFilter)
Get external IDs for a study
|
retrofit2.Call<Assessment> |
getLatestAssessmentRevision(String identifier)
Get the latest version of an assessment.
|
retrofit2.Call<Schedule2> |
getScheduleForStudy(String studyId)
Get the schedule for this study.
|
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<ForwardCursorReportDataList> |
getStudyParticipantReport(String studyId,
String userId,
String identifier,
DateTime startTime,
DateTime endTime,
String offsetKey,
Integer pageSize)
Get a series of report records for a specific date and time range (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<ReportIndex> |
getStudyParticipantReportIndex(String studyId,
String identifier)
Get a single report index with some additional metadata about the report series.
|
retrofit2.Call<ReportIndexList> |
getStudyParticipantReportIndices(String studyId)
Get the indices (identifiers) of all the reports available for participants in the given study.
|
retrofit2.Call<AccountSummaryList> |
getStudyParticipants(String studyId,
AccountSummarySearch accountSummarySearch)
Search for account summaries of study participants.
|
retrofit2.Call<Timeline> |
getTimelineForStudy(String studyId)
Get the timeline associated to this study through its schedule.
|
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<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> |
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<DemographicValuesValidationConfig> |
saveDemographicsValidationConfig(String studyId,
String categoryName,
DemographicValuesValidationConfig demographicValuesValidationConfig)
Save a DemographicValuesValidationConfig
Save a DemographicValuesValidationConfig to configure demographics validation.
|
retrofit2.Call<Schedule2> |
saveScheduleForStudy(String studyId,
Schedule2 schedule)
Create or update a schedule associated with a study.
|
retrofit2.Call<Message> |
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<ExporterSubscriptionResult> |
subscribeToExportNotificationsForStudy(String studyId,
ExporterSubscriptionRequest exporterSubscriptionRequest)
Subscribe to be notified when health data is exported to the study-specific Synapse project.
|
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<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<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
|
@Headers(value="Content-Type:application/json") @POST(value="v1/assessments") retrofit2.Call<Assessment> createAssessment(@Body Assessment assessment)
assessment - (required)@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)
assessmentId - The identifier for a stream of assessment revisions (required)externalResource - Assessment resource (required)@Headers(value="Content-Type:application/json")
@POST(value="v1/assessments/{guid}/revisions")
retrofit2.Call<Assessment> createAssessmentRevision(@Path(value="guid")
String guid,
@Body
Assessment assessment)
guid - A guid (required)assessment - (required)@Headers(value="Content-Type:application/json") @POST(value="v5/studies") retrofit2.Call<VersionHolder> createStudy(@Body Study study)
study - New study (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/logo")
retrofit2.Call<FileRevision> createStudyLogo(@Path(value="studyId")
String studyId,
@Body
FileRevision fileRevision)
studyId - Study identifier (required)fileRevision - New file revision (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants")
retrofit2.Call<IdentifierHolder> createStudyParticipant(@Path(value="studyId")
String studyId,
@Body
SignUp signUp)
studyId - Study identifier (required)signUp - Sign up (required)@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)
guid - A guid (required)customizationUpdate - (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v1/assessments/{guid}")
retrofit2.Call<Message> deleteAssessment(@Path(value="guid")
String guid,
@Query(value="physical")
Boolean physical)
guid - A guid (required)physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json")
@DELETE(value="v1/assessments/identifier:{assessmentId}/resources/{guid}")
retrofit2.Call<Message> deleteAssessmentResource(@Path(value="assessmentId")
String assessmentId,
@Path(value="guid")
String guid,
@Query(value="physical")
Boolean physical)
assessmentId - The identifier for a stream of assessment revisions (required)guid - A guid (required)physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}/participants/demographics/validation/{categoryName}")
retrofit2.Call<Message> deleteDemographicsValidationConfig(@Path(value="studyId")
String studyId,
@Path(value="categoryName")
String categoryName)
studyId - Study identifier (required)categoryName - Name of a demographics category. (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}")
retrofit2.Call<Message> deleteStudy(@Path(value="studyId")
String studyId,
@Query(value="physical")
Boolean physical)
studyId - Study identifier (required)physical - Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}/participants/{userId}/reports/{identifier}")
retrofit2.Call<Message> deleteStudyParticipantReport(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier)
studyId - Study identifier (required)userId - User ID (required)identifier - identifier (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}/participants/reports/{identifier}")
retrofit2.Call<Message> deleteStudyParticipantReportIndex(@Path(value="studyId")
String studyId,
@Path(value="identifier")
String identifier)
studyId - Study identifier (required)identifier - identifier (required)@Headers(value="Content-Type:application/json")
@DELETE(value="v5/studies/{studyId}/participants/{userId}/reports/{identifier}/{date}")
retrofit2.Call<Message> deleteStudyParticipantReportRecord(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier,
@Path(value="date")
DateTime date)
studyId - Study identifier (required)userId - User ID (required)identifier - identifier (required)date - The date and time of the record to delete (required)@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)
studyId - Study identifier (required)createdOn - Created on timestamp (ISO 8601) (required)@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)
studyId - Study identifier (required)adherenceThreshold - The percentage cutoff to use to determine totals of compliant and noncompliant participants. (optional)@Headers(value="Content-Type:application/json")
@GET(value="v1/assessments/{guid}")
retrofit2.Call<Assessment> getAssessmentByGUID(@Path(value="guid")
String guid)
guid - A guid (required)@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)
identifier - identifier (required)revision - Revision number (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/assessments/{guid}/config")
retrofit2.Call<AssessmentConfig> getAssessmentConfig(@Path(value="guid")
String guid)
guid - A guid (required)@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)
assessmentId - The identifier for a stream of assessment revisions (required)guid - A guid (required)@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)
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)@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)
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)@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)
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)@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)
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)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/demographics/validation/{categoryName}")
retrofit2.Call<DemographicValuesValidationConfig> getDemographicsValidationConfig(@Path(value="studyId")
String studyId,
@Path(value="categoryName")
String categoryName)
studyId - Study identifier (required)categoryName - Name of a demographics category. (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/externalids")
retrofit2.Call<ExternalIdentifierList> getExternalIdsForStudy(@Path(value="studyId")
String studyId,
@Query(value="offsetBy")
Integer offsetBy,
@Query(value="pageSize")
Integer pageSize,
@Query(value="idFilter")
String idFilter)
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)idFilter - (optional)@Headers(value="Content-Type:application/json")
@GET(value="v1/assessments/identifier:{identifier}")
retrofit2.Call<Assessment> getLatestAssessmentRevision(@Path(value="identifier")
String identifier)
identifier - identifier (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/schedule")
retrofit2.Call<Schedule2> getScheduleForStudy(@Path(value="studyId")
String studyId)
studyId - Study identifier (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}")
retrofit2.Call<Study> getStudy(@Path(value="studyId")
String studyId)
studyId - Study identifier (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/{userId}/adherence/study")
retrofit2.Call<StudyAdherenceReport> getStudyParticipantAdherenceReport(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId)
studyId - Study identifier (required)userId - User ID (required)@Headers(value="Content-Type:application/json")
@GET(value="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)
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)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/{userId}/reports/{identifier}")
retrofit2.Call<ForwardCursorReportDataList> getStudyParticipantReport(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier,
@Query(value="startTime")
DateTime startTime,
@Query(value="endTime")
DateTime endTime,
@Query(value="offsetKey")
String offsetKey,
@Query(value="pageSize")
Integer pageSize)
studyId - Study identifier (required)userId - User ID (required)identifier - identifier (required)startTime - (required)endTime - (required)offsetKey - next page start key for pagination (optional)pageSize - maximum number of records in each returned page (optional, default to 50)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/reports/{identifier}")
retrofit2.Call<ReportIndex> getStudyParticipantReportIndex(@Path(value="studyId")
String studyId,
@Path(value="identifier")
String identifier)
studyId - Study identifier (required)identifier - identifier (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/participants/reports")
retrofit2.Call<ReportIndexList> getStudyParticipantReportIndices(@Path(value="studyId")
String studyId)
studyId - Study identifier (required)@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)
studyId - Study identifier (required)accountSummarySearch - Account summary search parameters (required)@Headers(value="Content-Type:application/json")
@GET(value="v5/studies/{studyId}/timeline")
retrofit2.Call<Timeline> getTimelineForStudy(@Path(value="studyId")
String studyId)
studyId - Study identifier (required)@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)
studyId - Study identifier (required)userId - User ID (required)@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)
studyId - Study identifier (required)adherenceReportSearch - Search parameters for weekly adherence report (required)@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)
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)@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)
assessmentId - The identifier for a stream of assessment revisions (required)externalResourceGUIDs - List of external resource GUIDs (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/exporter3")
retrofit2.Call<Exporter3Configuration> initExporter3ForStudy(@Path(value="studyId")
String studyId)
studyId - Study identifier (required)@Headers(value="Content-Type:application/json")
@POST(value="v1/assessments/{guid}/publish")
retrofit2.Call<Assessment> publishAssessment(@Path(value="guid")
String guid,
@Query(value="newIdentifier")
String newIdentifier)
guid - A guid (required)newIdentifier - Upon publishing this assessment, you can provide a new identifier for the assessment. (optional)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/demographics/validation/{categoryName}")
retrofit2.Call<DemographicValuesValidationConfig> saveDemographicsValidationConfig(@Path(value="studyId")
String studyId,
@Path(value="categoryName")
String categoryName,
@Body
DemographicValuesValidationConfig demographicValuesValidationConfig)
studyId - Study identifier (required)categoryName - Name of a demographics category. (required)demographicValuesValidationConfig - (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/schedule")
retrofit2.Call<Schedule2> saveScheduleForStudy(@Path(value="studyId")
String studyId,
@Body
Schedule2 schedule)
studyId - Study identifier (required)schedule - (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/participants/{userId}/reports/{identifier}")
retrofit2.Call<Message> saveStudyParticipantReportRecord(@Path(value="studyId")
String studyId,
@Path(value="userId")
String userId,
@Path(value="identifier")
String identifier,
@Body
ReportData reportData)
studyId - Study identifier (required)userId - User ID (required)identifier - identifier (required)reportData - (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}/exporter3/notifications/export/subscribe")
retrofit2.Call<ExporterSubscriptionResult> subscribeToExportNotificationsForStudy(@Path(value="studyId")
String studyId,
@Body
ExporterSubscriptionRequest exporterSubscriptionRequest)
studyId - Study identifier (required)exporterSubscriptionRequest - Subscription request attributes. (required)@Headers(value="Content-Type:application/json")
@POST(value="v1/assessments/{guid}")
retrofit2.Call<Assessment> updateAssessment(@Path(value="guid")
String guid,
@Body
Assessment assessment)
guid - A guid (required)assessment - Updated assessment (required)@Headers(value="Content-Type:application/json")
@POST(value="v1/assessments/{guid}/config")
retrofit2.Call<AssessmentConfig> updateAssessmentConfig(@Path(value="guid")
String guid,
@Body
AssessmentConfig assessmentConfig)
guid - A guid (required)assessmentConfig - (required)@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)
assessmentId - The identifier for a stream of assessment revisions (required)guid - A guid (required)externalResource - Assessment resource (required)@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)
studyId - Study identifier (required)userId - User ID (required)enrollment - Updated enrollment (required)@Headers(value="Content-Type:application/json")
@POST(value="v5/studies/{studyId}")
retrofit2.Call<VersionHolder> updateStudy(@Path(value="studyId")
String studyId,
@Body
Study study)
studyId - Study identifier (required)study - Updated study (required)@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)
studyId - Study identifier (required)userId - User ID (required)adherenceRecordUpdates - One ore more adherence records (required)Copyright © 2023 Sage Bionetworks. All rights reserved.