Exercise Format Definitions

All exercise types define special data formats for the attributes exercise_content, exercise_solution (ExerciseModel) and solution_content (SolutionModel). All definitions follow the JSON standard and are listed below.

Parsons Puzzle Exercise

exercise_content

{
    "list": [
        "<piece 1>",
        "<piece 2>",
        ...
        "<piece n>"
    ]
}

example:

"exercise_content": {
        "list": [
            "Hello",
            "World",
            "this",
            "is",
            "the",
            "first",
            "exercise"
        ]
    }

Note: When getting this via GET, the pieces will be randomized.

exercise_solution

{
    "list": [
        "<piece 1>",
        "<piece 2>",
        ...
        "<piece n>"
    ]
}

example:

"exercise_solution": {
        "list": [
            "Hello",
            "World",
            "this",
            "is",
            "the",
            "first",
            "exercise"
        ]
    }

solution_content

{
    "list": [
        "<piece 1>",
        "<piece 2>",
        ...
        "<piece n>"
    ]
}

example:

"solution_content": {
        "list": [
            "Hello",
            "World",
            "this",
            "is",
            "the",
            "first",
            "exercise"
        ]
    }

Programming Exercise

exercise_content

{
    "code": "<sample_code>",
    "func": "<function_name>"
}

<func_name> must be the name of the function to be called from the evaluator

example:

{
    "exercise_content": {
        "code": "def multiply(x,y):\r\npass",
        "func": "multiply"
    }
}

exercise_solution

{
    "0": [[<params>],[<result>]],
    "1": [[<params>],[<result>]],
    ...
    "n": [[<params>],[<result>]]
}

params should be a list of parameters, according to the expected data types of the executed function. result should be the expected output of the function (should also be a list).

example:

{
    "exercise_solution": {
        "0": [[0, 0], [0]],
        "1": [[1, 0], [0]],
        "2": [[1, 2], [2]],
        "3": [[2, 2], [4]],
        "4": [[6, 7], [42]],
        "5": [[-4, 5], [-20]],
    }
}

solution_content

{
    "code": "<user_code>"
}

<user_code> should be the code the user submits

example:

{
    "solution_content": {
        "code": "def multiply(x,y):\r\nreturn x*y"
    }
}

Gap Text Exercise

exercise_content

{
    "text": "<exercise text>",
    "gap_positions": [
        <pos 1>,
        <pos 2>,
        ...
        <pos n>
    ]
}

example:

"exercise_content": {
        "text": "This is a long code where something is missing, with some gaps.",
        "gap_positions": [
            3,
            44,
            56
        ]
    }

text should be the exercsie text which should have the gaps inside. gap_positions should be a list of ints, with the char position of all gaps.

exercise_solution

{
    "gap_entries": [
        "<gap 1>",
        "<gap 2>",
        ...
        "<gap n>"
    ]
}

gap_entries should be the a list of strings with the right gap fillings in the order of gap location.

example:

"exercise_solution": {
        "gap_entries": [
            "These",
            "are",
            "the",
            "gap",
            "entries"
        ]
    }

solution_content

{
    "gap_entries": [
        "<gap 1>",
        "<gap 2>",
        ...
        "<gap n>"
    ]
}

gap_entries should be the a list of strings with the right gap fillings in the order of gap location.

example:

"exercise_solution": {
        "gap_entries": [
            "These",
            "are",
            "the",
            "gap",
            "entries"
        ]
    }