Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The /1/assessment_report/iep endpoint returns the structure of the VB-Mapp IEP Assessment Report.

...

Info
titleRequired Headers


Key
Value
Example
X-SystemDomain<the system domain>vbmapp
X-LearnerId<the learner id>The DMTD-supplied identifier that identifies the learner (see REST API Guide)
X-LearnerCode<the learner code>A REST-client-supplied identifier that identifies the learner (see REST API Guide)
User-Agent<company identifier>The exact value here is not important, but it should include something to identify your company
AuthorizationBearer <your token>Bearer wV1MLk5+sFzioJw/3M5r9A==
Acceptapplication/json



Info
titleParagraph Descriptor Fields


FieldTypeOptionalDescription
StyleStringRequiredThe paragraph style  
ConditionStringOptionalAn expression that determines if the paragraph belongs in the report
Condition_CommentStringOptionalA free-form comment describing the Condition field
TextStringRequiredThe paragraph's text, which might contain %SUBSTITUTION_FIELD%s



Info
titleParagraph Descriptor Styles

The following table lists the various styles that can be used to apply common styling across the generated document.

ValueDescription
H1Heading #1
H1NBHeading #1, but not emphasized (bold)
H2Heading #2
H3Heading #3
IndentNormal paragraph, but shifted to the right
IntroNormal paragraph style, in the introduction. Can have alternate styling, if needed.
ListBullet list
WarnAdds emphasis to highlight something to the user
NormalNormal paragraph style



Info
titleCondition Grammar

The grammar for conditions is very trivial. It's simply: "expr op expr".

The Flex lexical description looks as follows:

 

[ \t\n]                          { /* skip spaces */ }
\%([a-zA-Z_][a-zA-Z0-9_]*)\%     { yylval.string = yytext; return IDENTIFIER; }
[0-9]*                           { yylval.string = yytext; return INTEGER_LITERAL; }
\<=                              { return LT; }
\<=                              { return LTE; }
==                               { return EQ; }
\>=                              { return GT; }
\>=                              { return GTE; }
.                                { yyerror("Unknown token: %s", yytext); yyterminate(); }

A Bison grammar looks as follows:

binary_expr
    : /* empty */
    | value LT value
    | value LTE value
    | value EQ value
    | value GT value
    | value GTE value
;
 
value
    : IDENTIFIER
    | INTEGER_LITERAL
;

...

Info
titleExample

curl -X GET \
-H 'User-Agent: dmtd-rest-api' \
-H 'Authorization: Bearer wV1MLk5+sFzioJw/3M5r9A==' \
-H "Accept: application/json" \
-H "X-SystemDomain: vbmapp" \
-H "X-LearnerId: 1" \
https://api-sandbox.datamtd.com/1/assessment_report/iep

...