CheckWare partner API reference guide

Webservice operations

OverviewDatatypesWebservice operationsChangelog

addAssessmentInstanceData

Use this operation to save answers, flags, calculation for assessment instance. It is
possible to create assessment instance if it does 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 sent as second parameter.
If data is not in proper form, exception will be thrown with list of errors.
Calculations must be done on client side in accordance with the rules for the given assessment type
NOTE: This operation can ONLY be used with assessments where the calculation algorithm is known by the client!

Input

addAssessmentInstanceDataRequest
PartTypeDescription
addAssessmentInstanceDataRequestassessmentInstanceDataCollection of answers, calculations, flags and option assessmentInstance model.
Collection of answers is mandatory but could be empty. Sent answers must be matched with type.
Collection of calculations is optional, but if in assessment some colculations are defined, they must be
sent in request.
Collection of flags is optional, if some defined flag will not be sent, application automatically creates
new ones with values false.
Assessment instance at the end of this operation will be submitted.
assessmentInstanceIdassessmentInstanceIDOptional argument. If it is defined, assessmentInstance will be retrieved from existing. If
not, assessment instance will be created from part of addAssessmentInstanceDataRequest

Output

addAssessmentInstanceDataResponse
PartTypeDescription
addAssessmentInstanceDataResponseassessmentInstanceIDThe assessmentInstanceID for the newly added instances or already existing (only on
success).