CheckWare partner API reference guide

Datatypes

OverviewDatatypesWebservice operationsChangelog

exportAssessmentInstanceData

Model of export assessment instances. Contains parameters and filters to return
list of assessment instances with answers, calculations, flags and other information about
instances. The export contains the same parameters as the GUI equivalent.

Grouping method: sequence
Multiplicity:  

ElementMultiplicityTypeRestrictionDescription
assessmentID1 .. 1assessmentID 

Id of assessment chosen to export data

anonymous0 .. 1boolean 

This argument defines that personal data will be added to data, i.e. first
name, last name etc. Default value is true.

calculation0 .. 1boolean 

This argument defines that calculation will be added to data. Default
value is false.

flag0 .. 1boolean 

This argument defines that flags will be added to data. Default value is
false.

incomplete0 .. 1boolean 

This argument defines whether all assessment instances or only completed assessment instances will be exported. Default value is false, meaning that only completed will be exported.

includeTestData0 .. 1boolean 

Filters and returns assessment instance data of test respondents.

includePatientData0 .. 1boolean 

Filters and returns assessment instance data of real respondents (non-test respondents)