org.sagebionetworks.bridge.rest.api

Interface ParticipantDataApi

public interface ParticipantDataApi

Method Summary

Modifier and Type	Method and Description
retrofit2.Call<Message>	deleteAllParticipantDataForAdmin(String appId, String userId) Delete all participant data Endpoint for admin to delete all participant data for the given participant.
retrofit2.Call<Message>	deleteDataByIdentifier(String identifier) delete a participant data record
retrofit2.Call<Message>	deleteDataForAdmin(String appId, String userId, String identifier) Delete a participant data Endpoint for admin to delete a participnt data.
retrofit2.Call<ForwardCursorStringList>	getAllDataForAdminWorker(String appId, String userId, String offsetKey, Integer pageSize) Get list of identifiers for participant data Endpoint for worker or admin to get a list of participant data identifiers.
retrofit2.Call<ForwardCursorStringList>	getAllDataForSelf(String offsetKey, Integer pageSize) Get list of identifiers for participant data
retrofit2.Call<ParticipantData>	getDataByIdentifierForAdminWorker(String appId, String userId, String identifier) Get participant data by identifier Endpoint for worker or admin to get a participant data.
retrofit2.Call<ParticipantData>	getDataByIdentifierForSelf(String identifier) Get user's data based on the given identifier Get the participant data record based on the given identifier.
retrofit2.Call<Message>	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>	saveDataForSelf(String identifier, ParticipantData participantData) Save a participant data record Save a participant record.

Method Detail

deleteAllParticipantDataForAdmin

@Headers(value="Content-Type:application/json")
 @DELETE(value="v1/apps/{appId}/participants/{userId}/data")
retrofit2.Call<Message> deleteAllParticipantDataForAdmin(@Path(value="appId")
                                                                                                                                                                      String appId,
                                                                                                                                                                      @Path(value="userId")
                                                                                                                                                                      String userId)

Delete all participant data Endpoint for admin to delete all participant data for the given participant.

Parameters:

appId - App ID (required)

userId - User ID (required)

Returns:

Call<Message>

deleteDataByIdentifier

@Headers(value="Content-Type:application/json")
 @DELETE(value="v3/users/self/data/{identifier}")
retrofit2.Call<Message> deleteDataByIdentifier(@Path(value="identifier")
                                                                                                                                                 String identifier)

delete a participant data record

Parameters:

identifier - identifier (required)

Returns:

Call<Message>

deleteDataForAdmin

@Headers(value="Content-Type:application/json")
 @DELETE(value="v1/apps/{appId}/participants/{userId}/data/{identifier}")
retrofit2.Call<Message> deleteDataForAdmin(@Path(value="appId")
                                                                                                                                                                     String appId,
                                                                                                                                                                     @Path(value="userId")
                                                                                                                                                                     String userId,
                                                                                                                                                                     @Path(value="identifier")
                                                                                                                                                                     String identifier)

Delete a participant data Endpoint for admin to delete a participnt data.

Parameters:

appId - App ID (required)

userId - User ID (required)

identifier - identifier (required)

Returns:

Call<Message>

getAllDataForAdminWorker

@Headers(value="Content-Type:application/json")
 @GET(value="v1/apps/{appId}/participants/{userId}/data")
retrofit2.Call<ForwardCursorStringList> getAllDataForAdminWorker(@Path(value="appId")
                                                                                                                                                                           String appId,
                                                                                                                                                                           @Path(value="userId")
                                                                                                                                                                           String userId,
                                                                                                                                                                           @Query(value="offsetKey")
                                                                                                                                                                           String offsetKey,
                                                                                                                                                                           @Query(value="pageSize")
                                                                                                                                                                           Integer pageSize)

Get list of identifiers for participant data Endpoint for worker or admin to get a list of participant data identifiers.

Parameters:

appId - App ID (required)

userId - User ID (required)

offsetKey - next page start key for pagination (optional)

pageSize - maximum number of records in each returned page (optional, default to 50)

Returns:

Call<ForwardCursorStringList>

getAllDataForSelf

@Headers(value="Content-Type:application/json")
 @GET(value="v3/users/self/data")
retrofit2.Call<ForwardCursorStringList> getAllDataForSelf(@Query(value="offsetKey")
                                                                                                                                            String offsetKey,
                                                                                                                                            @Query(value="pageSize")
                                                                                                                                            Integer pageSize)

Get list of identifiers for participant data

Parameters:

offsetKey - next page start key for pagination (optional)

pageSize - maximum number of records in each returned page (optional, default to 50)

Returns:

Call<ForwardCursorStringList>

getDataByIdentifierForAdminWorker

@Headers(value="Content-Type:application/json")
 @GET(value="v1/apps/{appId}/participants/{userId}/data/{identifier}")
retrofit2.Call<ParticipantData> getDataByIdentifierForAdminWorker(@Path(value="appId")
                                                                                                                                                                                         String appId,
                                                                                                                                                                                         @Path(value="userId")
                                                                                                                                                                                         String userId,
                                                                                                                                                                                         @Path(value="identifier")
                                                                                                                                                                                         String identifier)

Get participant data by identifier Endpoint for worker or admin to get a participant data.

Parameters:

appId - App ID (required)

userId - User ID (required)

identifier - identifier (required)

Returns:

Call<ParticipantData>

getDataByIdentifierForSelf

@Headers(value="Content-Type:application/json")
 @GET(value="v3/users/self/data/{identifier}")
retrofit2.Call<ParticipantData> getDataByIdentifierForSelf(@Path(value="identifier")
                                                                                                                                                          String identifier)

Get user's data based on the given identifier Get the participant data record based on the given identifier. Participants can get reports for their own account. Note that this call does require consent and authentication.

Parameters:

identifier - identifier (required)

Returns:

Call<ParticipantData>

saveDataForAdminWorker

@Headers(value="Content-Type:application/json")
 @POST(value="v1/apps/{appId}/participants/{userId}/data/{identifier}")
retrofit2.Call<Message> saveDataForAdminWorker(@Path(value="appId")
                                                                                                                                                                       String appId,
                                                                                                                                                                       @Path(value="userId")
                                                                                                                                                                       String userId,
                                                                                                                                                                       @Path(value="identifier")
                                                                                                                                                                       String identifier,
                                                                                                                                                                       @Body
                                                                                                                                                                       ParticipantData participantData)

Save a participant data Endpoint for worker or admin to save a participant data.

Parameters:

appId - App ID (required)

userId - User ID (required)

identifier - identifier (required)

participantData - (required)

Returns:

Call<Message>

saveDataForSelf

@Headers(value="Content-Type:application/json")
 @POST(value="v3/users/self/data/{identifier}")
retrofit2.Call<Message> saveDataForSelf(@Path(value="identifier")
                                                                                                                                        String identifier,
                                                                                                                                        @Body
                                                                                                                                        ParticipantData participantData)

Save a participant data record Save a participant record. If a record exists with the given identifier, it will be replaced with this record. Note that this call requires consent and authentication.

Parameters:

identifier - identifier (required)

participantData - (required)

Returns:

Call<Message>