CheckWare assessment API reference guide

Datatypes

OverviewDatatypesWebservice operationsChangelog

respondent

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

Grouping method: sequence
Multiplicity: 1 .. 1

ElementMultiplicityTypeRestrictionDescription
respondentID1 .. 1respondentID 


Respondent unique identifier.

firstName1 .. 1string 


Respondent first name.

lastName1 .. 1string 


Respondent last name.

birthDate1 .. 1date 


Respondent date of birth.

gender1 .. 1string

Enumeration:

male
female


Respondent gender.

password1 .. 1string 


Respondent personal password.

mobilePhone0 .. 1string 


Respondent mobile phone.

email0 .. 1string

Pattern:

^[\w\.=-]+@[\w\.-]+\.[\w]{2,3}$


Respondent email address. The structure
is validated.

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.

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.

respondentAttributeCollection0 .. 1respondentAttributeCollection 

Collection of additional info fields defined for respondent