public interface PublicApi
| Modifier and Type | Method and Description |
|---|---|
retrofit2.Call<AppList> |
getApps(Boolean summary)
Get all apps The summary must be true if this call is made without authentication.
|
retrofit2.Call<AppConfig> |
getConfigForApp(String appId)
Get the config for the current version of the app making the request.
|
retrofit2.Call<Assessment> |
getLatestSharedAssessmentRevision(String identifier)
Get an assessment revision with the greatest revision number, using the assessment's identifier.
|
retrofit2.Call<SharedModuleMetadata> |
getMetadataByIdAndVersion(String moduleId,
Integer moduleVersion)
Deprecated.
|
retrofit2.Call<SharedModuleMetadata> |
getMetadataByIdLatestVersion(String moduleId)
Deprecated.
|
retrofit2.Call<ReportDataList> |
getPublicStudyReportRecords(String appId,
String identifier,
LocalDate startDate,
LocalDate endDate)
Get public study report records
Get public study report records (no authentication is needed, but index for the report must be marked as public or the server will return 404 for the report).
|
retrofit2.Call<Assessment> |
getSharedAssessmentByGUID(String guid)
Get an assessment revision.
|
retrofit2.Call<AssessmentConfig> |
getSharedAssessmentConfig(String guid)
Get the configuration JSON for a shared assessment app context.
|
retrofit2.Call<ExternalResource> |
getSharedAssessmentResource(String assessmentId,
String guid)
Get a external resource link documenting a shared assessment
|
retrofit2.Call<PagedExternalResourceList> |
getSharedAssessmentResources(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> |
getSharedAssessmentRevisionsByGUID(String guid,
Integer offsetBy,
Integer pageSize,
Boolean includeDeleted)
Get all revisions of an assessment using the GUID of one of the revisions.
|
retrofit2.Call<AssessmentList> |
getSharedAssessmentRevisionsById(String identifier,
Integer offsetBy,
Integer pageSize,
Boolean includeDeleted)
Get all revisions of an assessment with a specific identifier.
|
retrofit2.Call<AssessmentList> |
getSharedAssessments(Integer offsetBy,
Integer pageSize,
List<String> tag,
Boolean includeDeleted)
Get assessments in the shared library.
|
retrofit2.Call<StudyInfo> |
getStudyInfo(String appId,
String studyId)
Get the information on a study that is useful for displaying, selecting, and signing into the study.
|
retrofit2.Call<Map<String,List<String>>> |
getTags()
Get all tags, grouped into lists under their namespace prefixes (if a tag is created without a namespace prefix, it will be listed in the \"default\" group here).
|
retrofit2.Call<SharedModuleMetadataList> |
queryAllMetadata(Boolean mostrecent,
Boolean published,
String name,
String notes,
String tags,
Boolean includeDeleted)
Deprecated.
|
retrofit2.Call<SharedModuleMetadataList> |
queryMetadataById(String moduleId,
Boolean mostrecent,
Boolean published,
String name,
String notes,
String tags,
Boolean includeDeleted)
Deprecated.
|
retrofit2.Call<Message> |
submitIntentToParticipate(IntentToParticipate intentToParticipate)
Send a consent signature to Bridge before the user has signed up to the server.
|
@Headers(value="Content-Type:application/json") @GET(value="v1/apps") retrofit2.Call<AppList> getApps(@Query(value="summary") Boolean summary)
summary - If true, anyone can call this endpoint and return a list of truncated app objects (name and ID only). Otherwise, caller must be an admin. (optional)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/appconfig")
retrofit2.Call<AppConfig> getConfigForApp(@Path(value="appId")
String appId)
appId - App ID (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/sharedassessments/identifier:{identifier}")
retrofit2.Call<Assessment> getLatestSharedAssessmentRevision(@Path(value="identifier")
String identifier)
identifier - identifier (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/sharedmodules/metadata/{moduleId}/versions/{moduleVersion}") retrofit2.Call<SharedModuleMetadata> getMetadataByIdAndVersion(@Path(value="moduleId") String moduleId, @Path(value="moduleVersion") Integer moduleVersion)
moduleId - Unique ID of the module. (required)moduleVersion - Module version. (required)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/sharedmodules/metadata/{moduleId}") retrofit2.Call<SharedModuleMetadata> getMetadataByIdLatestVersion(@Path(value="moduleId") String moduleId)
moduleId - Unique ID of the module. (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/apps/{appId}/reports/{identifier}")
retrofit2.Call<ReportDataList> getPublicStudyReportRecords(@Path(value="appId")
String appId,
@Path(value="identifier")
String identifier,
@Query(value="startDate")
LocalDate startDate,
@Query(value="endDate")
LocalDate endDate)
appId - App ID (required)identifier - identifier (required)startDate - The first day to include in reports that are returned (required)endDate - The last day to include in reports that are returned (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/sharedassessments/{guid}")
retrofit2.Call<Assessment> getSharedAssessmentByGUID(@Path(value="guid")
String guid)
guid - A guid (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/sharedassessments/{guid}/config")
retrofit2.Call<AssessmentConfig> getSharedAssessmentConfig(@Path(value="guid")
String guid)
guid - A guid (required)@Headers(value="Content-Type:application/json")
@GET(value="v1/sharedassessments/identifier:{assessmentId}/resources/{guid}")
retrofit2.Call<ExternalResource> getSharedAssessmentResource(@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/sharedassessments/identifier:{assessmentId}/resources")
retrofit2.Call<PagedExternalResourceList> getSharedAssessmentResources(@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/sharedassessments/{guid}/revisions")
retrofit2.Call<AssessmentList> getSharedAssessmentRevisionsByGUID(@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/sharedassessments/identifier:{identifier}/revisions")
retrofit2.Call<AssessmentList> getSharedAssessmentRevisionsById(@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/sharedassessments") retrofit2.Call<AssessmentList> getSharedAssessments(@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="v1/apps/{appId}/studies/{studyId}")
retrofit2.Call<StudyInfo> getStudyInfo(@Path(value="appId")
String appId,
@Path(value="studyId")
String studyId)
appId - App ID (required)studyId - Study identifier (required)@Headers(value="Content-Type:application/json") @GET(value="v1/tags") retrofit2.Call<Map<String,List<String>>> getTags()
@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/sharedmodules/metadata") retrofit2.Call<SharedModuleMetadataList> queryAllMetadata(@Query(value="mostrecent") Boolean mostrecent, @Query(value="published") Boolean published, @Query(value="name") String name, @Query(value="notes") String notes, @Query(value="tags") String tags, @Query(value="includeDeleted") Boolean includeDeleted)
mostrecent - True to get only the most recent versions. If combined with published=true, then this will return the most recent published versions. Cannot be combined with where. Defaults to true. (optional, default to true)published - Should the shared module record be published? (optional, default to false)name - String to match anywhere in the name field of the shared module record. (optional)notes - String to match anywhere in the notes field of the shared module record. (optional)tags - Comma-delimited list of tags. If specified, only query results that match one or more tags (not necessarily all tags) are returned. If not specified, returns all query results. (optional)includeDeleted - Should deleted items be returned in results? (optional, default to false)@Deprecated @Headers(value="Content-Type:application/json") @GET(value="v3/sharedmodules/metadata/{moduleId}/versions") retrofit2.Call<SharedModuleMetadataList> queryMetadataById(@Path(value="moduleId") String moduleId, @Query(value="mostrecent") Boolean mostrecent, @Query(value="published") Boolean published, @Query(value="name") String name, @Query(value="notes") String notes, @Query(value="tags") String tags, @Query(value="includeDeleted") Boolean includeDeleted)
moduleId - Unique ID of the module. (required)mostrecent - True to get only the most recent versions. If combined with published=true, then this will return the most recent published versions. Cannot be combined with where. Defaults to true. (optional, default to true)published - Should the shared module record be published? (optional, default to false)name - String to match anywhere in the name field of the shared module record. (optional)notes - String to match anywhere in the notes field of the shared module record. (optional)tags - Comma-delimited list of tags. If specified, only query results that match one or more tags (not necessarily all tags) are returned. If not specified, returns all query results. (optional)includeDeleted - Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @POST(value="v3/itp") retrofit2.Call<Message> submitIntentToParticipate(@Body IntentToParticipate intentToParticipate)
intentToParticipate - (required)Copyright © 2024 Sage Bionetworks. All rights reserved.