CheckWare partner API reference guide

Datatypes

OverviewDatatypesWebservice operationsChangelog

respondent

The respondent is the structure representing a respondent (the individual that
responds to an assessment).

Respondent ID is set in any situation also when adding a new respondent. Social security number
of the respondent or other uniquely indentifying numbers/strings are normally used.

Grouping method: sequence
Multiplicity: 1 .. 1

ElementMultiplicityTypeRestrictionDescription
respondentID1 .. 1respondentID 


Respondent unique identifier.

firstName0 .. 1string 


Respondent first name. Is optional.

lastName0 .. 1string 


Respondent last name. Is optional.

birthDate0 .. 1date 


Respondent date of birth. Is optional.

gender0 .. 1string

Enumeration:

male
female
unknown gender


Respondent gender. Is optional.

password0 .. 1string 


Respondent personal password.
Is required when adding, optional when updating.

mobilePhone0 .. 1string 


Respondent mobile phone.

email0 .. 1string 


Respondent email address. The structure
is validated.

address0 .. 1string 


Respondent address. Is optional.

loginName0 .. 1string 


The loginName must be used by the
patient in combination with the password
to be able to logon to the assessment
server. 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.

enabled1 .. 1boolean 


Respondent is either enabled or
disabled. A disabled respondent cannot
login to the assessment solution.

testAccount0 .. 1boolean 


Defines if this account is for test purposes or not, default value is NOT test account.

respondentGroupID0 .. 1respondentGroupID 


You may group respondents. If this is
the case, use the respondent group
element.

userID0 .. 1userID 


If the respondent is managed by a
specific user, this element must be
present to connect the respondent with
the user.

treatmentInstance0 .. 1treatmentInstance 


This property is using only with addRespondent method. It creates traetment with attributes, roles and clinicians assgned to this treatment.
if filed is not set, new treatment from default treatment type will be created and assigned to respondent.

respondentAttributeCollection0 .. 1respondentAttributeCollection 

Collection of additional info fields defined for respondent

code0 .. 1code 

External resource Code