CheckWare assessment API reference guide

Datatypes

OverviewDatatypesWebservice operationsChangelog

user

A user represent a clinician in medical terms. The user is the one evaluating the reports and issuing assessment instances for a given respondent.

Grouping method: sequence
Multiplicity:  

ElementMultiplicityTypeRestrictionDescription
userID1 .. 1userID 


The userID. A unique identifier for the user. If
a user logs on to the system this will be the
sign-on userid.

Must be present in all requests, also when
adding a new user.

firstName1 .. 1string 


User first name.

lastName1 .. 1string 


User last name.

birthDate0 .. 1date 


User date of birth.

gender0 .. 1string

Enumeration:

male
female

User gender.

password1 .. 1string 


User personal password. If a user logs on to the
system this will be the sign-on password.

mobilePhone0 .. 1string 


User mobile phone. If system is setup to alert
via SMS this number will be used.

email0 .. 1string

Pattern:

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


User email address. The structure is validated.
If system is setup to alert via email, this
email will be used.

enabled1 .. 1boolean 


User is either enabled or disabled. A disabled
user cannot login to the assessment solution.

userRoleID1 .. 1userRoleID 

User role.

userAttributeCollection0 .. 1userAttributeCollection