public interface InternalApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
createSmsRegistration(String userId)
Create an SMS notification registration for the given user.
|
retrofit2.Call<Message> |
deleteAllParticipantVersionsForUser(String userId)
Delete all participant versions for the given user.
|
retrofit2.Call<Message> |
deleteRecordsEx3ForUser(String appId,
String userId)
Deletes all health data records from the Exporter 3 implementation for the given user.
|
retrofit2.Call<HealthDataRecordList> |
getHealthDataByCreatedOn(DateTime createdOnStart,
DateTime createdOnEnd)
Get health data records by createdOn date range.
|
retrofit2.Call<SmsMessage> |
getMostRecentSmsMessage(String userId)
Returns the most recent message sent to the phone number of the given user.
|
retrofit2.Call<HealthDataRecord> |
submitHealthDataForParticipant(String userId,
HealthDataSubmission healthDataSubmission)
Upload health data for the given user
Allows a developer to submit health data on behalf of the participant.
|
@Headers(value="Content-Type:application/json") @POST(value="v3/participants/{userId}/notifications/sms") retrofit2.Call<Message> createSmsRegistration(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @DELETE(value="v3/participants/{userId}/versions") retrofit2.Call<Message> deleteAllParticipantVersionsForUser(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/apps/{appId}/participants/{userId}/exporter3/healthdata") retrofit2.Call<Message> deleteRecordsEx3ForUser(@Path(value="appId") String appId, @Path(value="userId") String userId)
appId
- App ID (required)userId
- User ID (required)@Headers(value="Content-Type:application/json") @GET(value="v3/healthdata") retrofit2.Call<HealthDataRecordList> getHealthDataByCreatedOn(@Query(value="createdOnStart") DateTime createdOnStart, @Query(value="createdOnEnd") DateTime createdOnEnd)
createdOnStart
- Start time (ISO 8601) for a createdOn date-time range (optional)createdOnEnd
- End time (ISO 8601) for a createdOn date-time range (optional)@Headers(value="Content-Type:application/json") @GET(value="v3/participants/{userId}/sms/recent") retrofit2.Call<SmsMessage> getMostRecentSmsMessage(@Path(value="userId") String userId)
userId
- User ID (required)@Headers(value="Content-Type:application/json") @POST(value="v3/participants/{userId}/healthdata") retrofit2.Call<HealthDataRecord> submitHealthDataForParticipant(@Path(value="userId") String userId, @Body HealthDataSubmission healthDataSubmission)
userId
- User ID (required)healthDataSubmission
- Health data submitted on behalf of the user (required)Copyright © 2023 Sage Bionetworks. All rights reserved.