CheckWare partner API reference guide

Changelog

OverviewDatatypesWebservice operationsChangelog

Changelog

The following changes are made to the WSDL file (includes both WSDL structure and
datatypes):


2011-08-19:
Added "completedDate" to the assessmentInstance datatype.

2011-08-28:
Added extra part for both addRespondent and updateRespondent to manage SMS sending related to new
respondents.

2011-09-16:
Added optional field loginName to the Respondent datatype.

2011-09-29:
Added getRespondentByLoginName to enable lookup on both values.
Added changeRespondentID operation and the respondentChange datatype used as argument.

2011-11-21:
Added lastModified as a required field to AssessmentInstance.

2011-11-28:
Minimum occurence changed from 1 to 0 (from required to optional) for the following fields on the User
datatype: birthDate, Gender

2013-11-09:
Added new methods TNG 2.4:
exportAssessmentInstanceData, exportAssessmentPlanData, exportAssessmentStatusData, exportLoginSessionData,
exportUserData,
exportUserGroupData, exportRespondentData, exportRespondentGroupData,
exportUserGroupRespondentGroupMappingData,
addRespondentAttributeMeta, updateRespondentAttributeMeta, deleteRespondentAttributeMeta,
getRespondentAttributesMeta,
addUserAttributeMeta, updateUserAttributeMeta, deleteUserAttributeMeta, getUserAttributesMeta,
Add optional attribute:
In respondent model respondentAttributeCollection
In user model: userAttributeCollection

2013-11-11:
Added new methods resolveDuplicates and getAssessmentInstanceAvailableReportsByDate.

2013-11-21
New methods: addAssessmentPlanInstance, getAssessmentPlans
New models: AssessmentPlan, AssessmentPlanInstance, AssessmentPlanCollection

2013-11-25
Changed method name: getAssessmentInstanceAvailableReportsFilter instead of
getAssessmentInstanceAvailableReportsByDate

2014-01-22
New methods: getNewReportInstances, getAssessmentInstanceReportFileKITH,
setReportInstanceArchived,getCVSFile
New models: assessmentInstanceReportFileKITH

2014-01-24
New parts:
getAssessmentInstnaceAvailableReportsIncludeExported in getAssessmentInstanceAvailableReports method,
getAssessmentInstanceReportFileArchive in getAssessmentInstanceReportFile method

2014-01-27
Removed method getCVSFile

2014-11-10
New type ownerID added to assessmentInstance and assessmentPlanInstance models as optional attribute.

2015-01-10
New methods:
getDataExportAvailableTemplates, executeDataExportTemplate, getDataExportInstance, getAvailableLanguages

2015-03-24
New methods with relevant datatypes:
getAssessmentInstanceContexts
getAssessmentPlanInstanceHasAssessmentInstance
getAvailableUserGroups
getRespondentGroupUserGroupMapping
getMessage
addMessage
editMessage

Changes in user datatype:
new optional field: userGroup to add/get clinician groups to/from clinician
field password become optional

Changes in respondent datatype:
field password become optional

Changes in assessmentInstance datatype:
new optional field startDateTime
new optional field expireDateTime
new optional field contextID

New optional fields in respondentGroup datatype:
category
isCommon

New data type assessmentPlanFilter to filter assessment plans, it is used in getAssessmentPlans operation.

2015-10-12
New operations with relevant datatypes:
addTreatmentType
deleteTreatmentType
getTreatmentType
getTreatmentTypes
updateTreatmentType
addTreatment
deleteTreatemnt
getTreatment
getTreatments
updateTreatment

new fields treatmentInstanceID in assessmentInstance and assessmentPlanInstance

new optional fields: treatmentInstanceID, treatmentTypeID in queries for findAssessmentInstances, getAssessmentPlanInstanceHasAssessmentInstance

2016-05-23
New field in respondent datatype: address.

2016-06-21
The following fields won't be returned in the response if they have empty values:
dataExportTemplate:filterDateRangeStart
dataExportTemplate:filterDateRangeStop
assessmentInstanceCalculation:assessmentInstanceCalculationValue
assessmentPlan:assessmentPlanLastChangeDate
assessmentPlan:assessmentPlanLastGeneratedDate

2016-11-22
New method getAssessmentInstanceReportFileHL7v3

2017-02-08
New Method getNewReportInstancesDetailed
Added treatmentRole to methods concerning treatments
Addd ne optional parameter testAccount to respondent model

2018-02-15
New methods added:
findAssessmentPlanInstance
findAssessmentInstanceDetailed

2018-07-16
New field treatmentInstanceID in Message datatype
New field treatmentInstanceID in MessageFilter datatype

2020-01-29
New datatype: RoleSet, roleInRoleSet, treatmentTypeHasRoleSet
New methods:
addRoleSet
deleteRoleSet
updateRoleSet
getRoleSet
getRoleSets
addOrUpdateRoleSetHasRole
deleteRoleSetHasRole
addRoleSetToTreatmentType
removeRoleSetFromTreatmentType

2020-06-09
Responses of 'exportAssessmentPlanData' and 'exportAssessmentInstanceStatusData' have changed.
Word 'workflow' in CSV header column names has been replaced by 'plan'.

2020-06-18
Removed TreatmentInstance status field
Deleted fields 'birthDate' and 'gender' from User datatype.

2020-06-23
New method 'findLastFinishedDataExportInstanceMetadata' has been added.

2021-03-03
New method 'exportSystemEventLogData' has been added.

2021-09-06
Property 'assessmenPlanImage' in 'assessmentPlan' datatype is optional now.

2021-08-30
Content type of SOAP response is 'application/soap+xml' now

2021-09-07
Property 'publisher' is removed from 'assessment' datatype.

2021-09-19
dataExportTemplate:createdDate is now timestamp
dataExportTemplate:lastModifiedDate is now timestamp
dataExportTemplate:filterDateRangeStart is now date
dataExportTemplate:filterDateRangeStop is now date

2021-09-23
Update SOAP server version to 1.2

2023-03-23
Parameter 'treatmentTypeID' used to export treatments with 'exportTreatmentInstanceData' method is mandatory since now.

2023-08-11
New methods: 'getConsent', 'getConsentInstance', 'getConsentInstances', 'getConsents', 'submitConsentInstance' added
New datatypes: 'consent', 'consentInstance', 'consentVersion',

2023-08-22
Removal of deprecated 'getAssessmentInstanceReportFileKITH' method

2023-11-06
added optional property 'parentId' in 'addAdministratorGroup' request body
added property 'parentId' in 'getAvailableUserGroups' response body when using multiple enterprises
added column 'clinician group parent id' in 'exportUserGroupData' response body when using multiple enterprises

2024-07-11
added optional property 'userRoleID' in 'exportSystemEventLogData' request body