The port for all operations for respondent, user and assessment management.
Operation | Description |
---|---|
![]() | This operation will add an instance of an assessment for a given respondent. |
![]() | Use 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. |
![]() | Add a new assessment plan instance |
![]() | Add a new respondent to the assessment system. |
![]() | Use this operation to define and add additional attribute for respondent. |
![]() | Add a new user to the assessment system. |
![]() | Use this operation to define and add additional attribute for clinicia. |
![]() | NOT AVAILABLE since tng 2.4.1 The operation changeRespondentID makes it possible to change the respondentID for a given respondent. |
![]() | This will delete a given assessment instance. |
![]() | Delete a respondent from the system. This will physically delete the respondent from the system. Concider using disableRespondent instead to keep data in system. |
![]() | Use this operation to delete additional attribute defined for respondent. |
![]() | Delete 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 |
![]() | Use this operation to delete additional attribute defined for clinician. |
![]() | Disable 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. |
![]() | Disable a given user. This is an alternative til deleteUser. See also enableUser. |
![]() | Enable a respondent based on respondentID. Revoke a disabled respondent back to enabed status. |
![]() | Enable a given user. See also disableUser. |
![]() | Use this operation to export data fro assessments |
![]() | Use this operation to export information about assessment instance statuse. |
![]() | Use this operation to export information about assessment plans.. |
![]() | Use this operation for get informatioon about login respondents, clinicians to portals |
![]() | Use this operation to export data about respondents. |
![]() | Use this operation to export data about respondent groups |
![]() | Use this operation to export data about clinicians. |
![]() | Use this operation to export data about clinician groups. |
![]() | Use this operation to export data about conections between respondent groups and clinician groups |
![]() | This will return a list of assessment instances based on the requested parameters. |
![]() | This will retreive information about a given assessmentInstance. Available reports for the instance is also returned. Use the getAssessmentInstanceReport to retreive the actual report |
![]() | This method will retreive a list of available reports for a given assessment instance. Use the getAssessmentInstanceReportFile to retreive the actual report. |
![]() | Get assessment instance reports based on assessment instance reportid. |
![]() | Get assessment instance with answers, claculations and flags |
![]() | This method will retreive a given report for a given assessment instance. Use the getAssessmentInstanceAvailableReports operation to see available reports for a given assessment instance. |
![]() | Get report file in KITH message format. |
![]() | Get all assessment plans templates |
![]() | This operation will retreive a list of all available assessments in the system. |
![]() | Get a collection of all available respondent groups. |
![]() | Use 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. |
![]() | Get all assessment report instances which haven't been marked as archived/exported. |
![]() | Get data for a given respondent. |
![]() | Use this operation to get all additional attributes defined for respondent. |
![]() | Get a respondent recordusing the loginName as the key. See also getRespondent |
![]() | Get data for a given user. |
![]() | Use this operation to get list of all additional attributes defined for clinician. |
![]() | Merge two respondents into one. The merged respondent is removed and related assessment/workflow instances are moved to the other respondent. |
![]() | Set assessment instance report as archived/exported |
![]() | Update information for an existing assessment instance. Example usage: reschedule an assessment. |
![]() | Update data for a respondent. |
![]() | Use this operation to change additional attribute for respondent. |
![]() | Update data for a given user. |
![]() | Use this operation to change additional attribute definedfor clinician. |