ParticipationService

Application service which allows inviting participants, retrieving participation invitations for study deployments, and managing data related to participants which is input by users.

A participant app uses getActiveParticipationInvitations to find the studies it is invited to, and setParticipantData to store InputData such as informed consent. Works alongside DeploymentService.

Constructors

ParticipationService

ParticipationService()

Constants

API_VERSION

String const API_VERSION

Methods

getActiveParticipationInvitations

Future<List<ActiveParticipationInvitation>> getActiveParticipationInvitations({

1. String? accountId,

})

Get all invitations of active study deployments the account with the given accountId has been invited to.

getParticipantData

Future<ParticipantData> getParticipantData(

1. String studyDeploymentId

)

Get currently set data for all expected participant data in the study deployment with studyDeploymentId. Data which is not set equals null.

getParticipantDataList

Future<List<ParticipantData>> getParticipantDataList(

1. List<String> studyDeploymentIds

)

Get currently set data for all expected participant data for a set of study deployments with studyDeploymentIds. Data which is not set equals null.

setParticipantData

Future<ParticipantData> setParticipantData(

1. String studyDeploymentId,
2. Map<String, Data> data, [
3. String? inputByParticipantRole

])

Set data that was inputByParticipantRole in the study deployment with studyDeploymentId.

If inputByParticipantRole is null, all roles can set it. If you want to set data that was assigned to a specific participant role, inputByParticipantRole needs to be set.

Returns all data for the specified study deployment, including the newly set data.