Resource File Structure

Ediit Resource files are simple JSON structures, allowing for flexible output and delivery.

Ediit Resource files are composed of Structural Elements; Groups, Documents, Pages, Rows, Columns and Blocks. These elements nest within one another.

  • Ediit Resource

    • Groups

      • Documents

        • Pages

          • Rows

            • Columns

              • Blocks

The relationship between these elements is one-to-many, e.g:

  • one Resource can contain many Groups;

  • one Groups can contain many Documents;

  • one Document can contain many Pages;

  • one Page can contain many Rows;

  • one Row can contain many Columns;

  • one Column can contain many Blocks.

The Resource file structure must follow this nesting. For example, a Group cannot directly contain a Block.

{
    "meta" : {
        "id": "b3g784w43g-nw8fy7bg-znsxwe89",
        "title": "Animals Worksheet",
        "authorId": "g034hg-43hg034h403f-fn2un329"
    },
    "content" : [
        {
            "title": "Lesson 1"
            "documents": [
                {
                    "title": "Intro to Animals"
                    "pages": [
                        {
                            "data" : {},
                            "rows": [
                                {
                                    "data" : {},
                                    "columns": [
                                        {
                                            "data" : {},
                                            "blocks": [
                                                {
                                                    "type": "heading",
                                                    "data": {
                                                        "text": "All About Animals",
                                                        "level": 1,
                                                        "textAlign": "center"
                                                    }
                                                },
                                                {
                                                    "type": "paragraph",
                                                    "data": {
                                                        "text": "Animals are amazing!",
                                                    }
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
    
}
                    

Last updated

Was this helpful?