CheckWare assessment API reference guide

Webservice operations

OverviewDatatypesWebservice operationsChangelog

Webservice operations

assessmentPort

The port for all operations for respondent, user and assessment management.

OperationDescription
addAssessmentInstanceThis operation will add an instance of an assessment for a given respondent.
addAssessmentInstanceDataUse this oeration to save answers, flags, calculation for assessment instance. It is possible to create assessment instance if it is not exist, in this case object assessmentInstanceData should
contain assessmentInstance object to create assessment instance. If assessment instance already exists in system id should be sen as second parameter.

If data is not in proper form, exception will be thrown with list of errors.

addAssessmentPlanInstanceAdd a new assessment plan instance
addRespondentAdd a new respondent to the assessment system.
addRespondentAttributeMetaUse this operation to define and add additional attribute for respondent.
addUserAdd a new user to the assessment system.
addUserAttributeMetaUse this operation to define and add additional attribute for clinicia.
changeRespondentIDNOT AVAILABLE since tng 2.4.1
The operation changeRespondentID makes it possible to change the respondentID for a given respondent.
deleteAssessmentInstanceThis will delete a given assessment instance.
deleteRespondentDelete a respondent from the system.

This will physically delete the respondent from the system. Concider using disableRespondent instead to keep data in system.
deleteRespondentAttributeMetaUse this operation to delete additional attribute defined for respondent.
deleteUserDelete a given user. You might concider using the disableUser operation instead. This will give you the possibility to enable the user later on.

By deleting a user the user will be removed from the system
deleteUserAttributeMetaUse this operation to delete additional attribute defined for clinician.
disableRespondentDisable a respondent based on respondentID.

This is an alternative to deleteRespondent. A disabled respondent is possible to revoke again as opposed to a deleted respondent that is physically removed from the assessment system.
disableUserDisable a given user. This is an alternative til deleteUser.

See also enableUser.
enableRespondentEnable a respondent based on respondentID.

Revoke a disabled respondent back to enabed status.
enableUserEnable a given user. See also disableUser.
exportAssessmentInstanceDataUse this operation to export data fro assessments
exportAssessmentInstanceStatusDataUse this operation to export information about assessment instance statuse.
exportAssessmentPlanDataUse this operation to export information about assessment plans..
exportLoginSessionDataUse this operation for get informatioon about login respondents, clinicians to portals
exportRespondentDataUse this operation to export data about respondents.
exportRespondentGroupDataUse this operation to export data about respondent groups
exportUserDataUse this operation to export data about clinicians.
exportUserGroupDataUse this operation to export data about clinician groups.
exportUserGroupRespondentGroupMappingDataUse this operation to export data about conections between respondent groups and clinician groups
findAssessmentInstancesThis will return a list of assessment instances based on the requested parameters.
getAssessmentInstanceThis will retreive information about a given assessmentInstance. Available reports for the instance is also returned.

Use the getAssessmentInstanceReport to retreive the actual report
getAssessmentInstanceAvailableReportsThis method will retreive a list of available reports for a given assessment instance.

Use the getAssessmentInstanceReportFile to retreive the actual report.
getAssessmentInstanceAvailableReportsFilterGet assessment instance reports based on assessment instance reportid.
getAssessmentInstanceDataGet assessment instance with answers, claculations and flags
getAssessmentInstanceReportFileThis method will retreive a given report for a given assessment instance.

Use the getAssessmentInstanceAvailableReports operation to see available reports for a given assessment instance.
getAssessmentInstanceReportFileKITHGet report file in KITH message format.
getAssessmentPlansGet all assessment plans templates
getAvailableAssessmentsThis operation will retreive a list of all available assessments in the system.
getAvailableRespondentGroupsGet a collection of all available respondent groups.
getAvailableUserRolesUse this operation to get a list of available user roles.

To be able to add a user, a user role must be assigned to the user.
getNewReportInstancesGet all assessment report instances which haven't been marked as archived/exported.
getRespondentGet data for a given respondent.
getRespondentAttributesMetaUse this operation to get all additional attributes defined for respondent.
getRespondentByLoginNameGet a respondent recordusing the loginName as the key.

See also getRespondent
getUserGet data for a given user.
getUserAttributesMetaUse this operation to get list of all additional attributes defined for clinician.
resolveDuplicatesMerge two respondents into one. The merged respondent is removed and related assessment/workflow instances are moved to the other respondent.
setReportInstanceArchivedSet assessment instance report as archived/exported
updateAssessmentInstanceUpdate information for an existing assessment instance.

Example usage: reschedule an assessment.
updateRespondentUpdate data for a respondent.
updateRespondentAttributeMetaUse this operation to change additional attribute for respondent.
updateUserUpdate data for a given user.
updateUserAttributeMetaUse this operation to change additional attribute definedfor clinician.