respondentID
Respondent unique identifier.
firstName
Respondent first name. Is optional.
lastName
Respondent last name. Is optional.
birthDate
Respondent date of birth. Is optional.
genderEnumeration:
malefemale
unknown gender
Respondent gender. Is optional.
password
Respondent personal password.
Is required when adding, optional when updating.
mobilePhone
Respondent mobile phone.
email
Respondent email address. The structure is validated.
address
Respondent address. Is optional.
loginName
The loginName (username) must be used by the
respondent in combination with the password
to be able to log on to the respondent portal.
If no loginName is submitted the
system will generate a unique loginName.
loginName must be unique within an
installation, and preferrably identify
the respondent in such a way that the id
is unique across all installations.
enabled
Respondent is either enabled or
disabled. A disabled respondent cannot
login to the respondent portal.
testAccount
Defines if this account is for test purposes or not, default value is NOT test account.
respondentGroupID
You may group respondents. If this is
the case, use the respondent group
element.
userID
If the respondent is managed by a
specific clinician, this element must be
present to connect the respondent with
the clinician.
treatmentInstance
This property is used only with addRespondent method. It creates treatment with attributes, roles and clinicians assgned to this treatment.
If field is not set, new treatment from default treatment type will be created and assigned to respondent.
respondentAttributeCollectionCollection of additional information fields defined for respondent
codeExternal resource Code