variant/apparatus/get

Retrieve variant apparatus data

Parameters

NameRequiredDefaultDescriptionExample
indexContenttrueN/Awhich range of apparatus to obtainActs.4.5
segmentGroupIDfalse-1limit results to a specific segmentGroupID; -1 = all3
augmentGroupIDfalseaugment results with segments from another group7
includeBaselinefalseinclude a baseline edition with apparatusECM
wordContextSizefalse3when computing the word context, include this many baseline words before and after reading or word5
positiveConversionfalsefalseconvert 'a' readings to positive apparatustrue
testIndexfalsefalsesave search data as test indextrue
detailfalsecompleteadd extra detail if desiredextra
formatfalsespecified at session openresponse output format (json|xml|csv|gchart)json

Errors

{indexContent} may not be null-4