CheckWare partner 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: 1 .. 1

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.

password0 .. 1string 


User personal password. If a user logs on to the
system this will be the sign-on password.
Is required when adding, optional when updating.

mobilePhone0 .. 1string 


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

email0 .. 1string 


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.

userRoleID0 .. 1userRoleID 

User role.

userAttributeCollection0 .. 1userAttributeCollection 

Collection of clinician attributes

userLanguageID0 .. 1languageID 

Id of language

testAccount0 .. 1boolean 

Information that clinician is test

userGroup0 .. 1userGroupIDCollection 

Collection of clinician groups identifiers