public interface HealthDataApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<HealthDataRecordEx3List> |
getAllRecordsEx3ForSelf(DateTime createdOnStart,
DateTime createdOnEnd,
Integer pageSize,
String offsetKey)
Retrieves all records from the Exporter 3 implementation for the current user and time range - For developers to validate uploads from the app.
|
retrofit2.Call<HealthDataRecordEx3> |
getRecordEx3ById(String recordId,
String download)
Retrieves the record for the given ID from the Exporter 3 implemention, provides a dowload link for the record if requested - For developers to validate uploads from the app.
|
retrofit2.Call<HealthDataRecord> |
submitHealthData(HealthDataSubmission healthDataSubmission)
Upload health data
Synchronous health data API.
|
@Headers(value="Content-Type:application/json") @GET(value="v3/participants/self/exporter3/healthdata") retrofit2.Call<HealthDataRecordEx3List> getAllRecordsEx3ForSelf(@Query(value="createdOnStart") DateTime createdOnStart, @Query(value="createdOnEnd") DateTime createdOnEnd, @Query(value="pageSize") Integer pageSize, @Query(value="offsetKey") String offsetKey)
createdOnStart
- Start time (ISO 8601) for a createdOn date-time range (optional)createdOnEnd
- End time (ISO 8601) for a createdOn date-time range (optional)pageSize
- maximum number of records in each returned page (optional, default to 50)offsetKey
- next page start key for pagination (optional)@Headers(value="Content-Type:application/json") @GET(value="v3/participants/self/exporter3/healthdata/{recordId}") retrofit2.Call<HealthDataRecordEx3> getRecordEx3ById(@Path(value="recordId") String recordId, @Query(value="download") String download)
recordId
- Health data record ID (required)download
- If the user requires to download their record. (optional, default to false)@Headers(value="Content-Type:application/json") @POST(value="v3/healthdata") retrofit2.Call<HealthDataRecord> submitHealthData(@Body HealthDataSubmission healthDataSubmission)
healthDataSubmission
- Health data submitted by the user (required)Copyright © 2023 Sage Bionetworks. All rights reserved.