CheckWare partner API reference guide

Datatypes

OverviewDatatypesWebservice operationsChangelog

message

Object message represents comunication - messages sent beetwen respondent and
clinician(s)

Grouping method: sequence
Multiplicity: 1 .. 1

ElementMultiplicityTypeRestrictionDescription
messageID0 .. 1messageID 

Identifier of message

respondentID1 .. 1respondentID 

Identifier of respondent who is sender or recipient of the message

treatmentInstanceID1 .. 1treatmentInstanceID 

Identifier of treatment

userID0 .. 1userID 

Identifier of clinician who is sender of the message

senderType0 .. 1string 

Information who is sender of the message, posible values: CLINICIAN,
RESPONDENT

content0 .. 1string 

Content of the message

isRead0 .. 1boolean 

Information that message was read

notifyBySMS0 .. 1boolean 

Information that respondent was notify by sms

isAnswered0 .. 1boolean 

Information that was answer on this message

replyDate0 .. 1dateTime 

Date and time when message was reply

sentDate0 .. 1dateTime 

Information when message was sent