Package | Description |
---|---|
org.sagebionetworks.bridge.rest.api | |
org.sagebionetworks.bridge.rest.model |
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<StudyParticipant> |
ForResearchersApi.getParticipantByExternalId(String externalId,
Boolean consents)
Get a study participant (user) record using the external ID of the account
|
retrofit2.Call<StudyParticipant> |
ParticipantsApi.getParticipantByExternalId(String externalId,
Boolean consents)
Get a study participant (user) record using the external ID of the account
|
retrofit2.Call<StudyParticipant> |
ForWorkersApi.getParticipantByExternalIdForApp(String appId,
String externalId,
Boolean consents)
Get a study participant (user) record in an app using the account's external ID.
|
retrofit2.Call<StudyParticipant> |
ForResearchersApi.getParticipantByHealthCode(String healthCode,
Boolean consents)
Get a study participant (user) record using the health code of the account
|
retrofit2.Call<StudyParticipant> |
ParticipantsApi.getParticipantByHealthCode(String healthCode,
Boolean consents)
Get a study participant (user) record using the health code of the account
|
retrofit2.Call<StudyParticipant> |
ForWorkersApi.getParticipantByHealthCodeForApp(String appId,
String healthCode,
Boolean consents)
Get a study participant (user) record in an app using the account's health code.
|
retrofit2.Call<StudyParticipant> |
ForResearchersApi.getParticipantById(String userId,
Boolean consents)
Get a study participant (user) record
This endpoint can be called by researchers (all authenticated users can retrieve their own StudyParticipant record by using the `getUsersParticipantRecord` method, which should be used by administrative accounts as well, such as developers).
|
retrofit2.Call<StudyParticipant> |
ParticipantsApi.getParticipantById(String userId,
Boolean consents)
Get a study participant (user) record
This endpoint can be called by researchers (all authenticated users can retrieve their own StudyParticipant record by using the `getUsersParticipantRecord` method, which should be used by administrative accounts as well, such as developers).
|
retrofit2.Call<StudyParticipant> |
ForWorkersApi.getParticipantByIdForApp(String appId,
String userId,
Boolean consents)
Get a study participant (user) record in an app
|
retrofit2.Call<StudyParticipant> |
ForResearchersApi.getStudyParticipantById(String studyId,
String userId,
Boolean consents)
Get a study participant.
|
retrofit2.Call<StudyParticipant> |
StudyParticipantsApi.getStudyParticipantById(String studyId,
String userId,
Boolean consents)
Get a study participant.
|
retrofit2.Call<StudyParticipant> |
ForStudyCoordinatorsApi.getStudyParticipantById(String studyId,
String userId,
Boolean consents)
Get a study participant.
|
retrofit2.Call<StudyParticipant> |
ForConsentedUsersApi.getUsersParticipantRecord(Boolean consents)
Get user's participant record
Get the current user's participant record.
|
retrofit2.Call<StudyParticipant> |
ParticipantsApi.getUsersParticipantRecord(Boolean consents)
Get user's participant record
Get the current user's participant record.
|
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
ForResearchersApi.updateParticipant(String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
This endpoint can be called by researchers, and by other administrators for their own account account.
|
retrofit2.Call<Message> |
ParticipantsApi.updateParticipant(String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
This endpoint can be called by researchers, and by other administrators for their own account account.
|
retrofit2.Call<Message> |
ForResearchersApi.updateStudyParticipant(String studyId,
String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
|
retrofit2.Call<Message> |
StudyParticipantsApi.updateStudyParticipant(String studyId,
String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
|
retrofit2.Call<Message> |
ForStudyCoordinatorsApi.updateStudyParticipant(String studyId,
String userId,
StudyParticipant studyParticipant)
Update an existing study participant (user) record
|
retrofit2.Call<UserSessionInfo> |
ForConsentedUsersApi.updateUsersParticipantRecord(StudyParticipant studyParticipant)
Update user's participant record
Update the current user's participant record.
|
retrofit2.Call<UserSessionInfo> |
ParticipantsApi.updateUsersParticipantRecord(StudyParticipant studyParticipant)
Update user's participant record
Update the current user's participant record.
|
Modifier and Type | Method and Description |
---|---|
List<StudyParticipant> |
AppAndUsers.getUsers()
A list of users in the new Study.
|
Modifier and Type | Method and Description |
---|---|
AppAndUsers |
AppAndUsers.addUsersItem(StudyParticipant usersItem) |
Modifier and Type | Method and Description |
---|---|
void |
AppAndUsers.setUsers(List<StudyParticipant> users) |
AppAndUsers |
AppAndUsers.users(List<StudyParticipant> users) |
Copyright © 2023 Sage Bionetworks. All rights reserved.