Fork me on GitHub ← BACK

TechCaFE Games API

Installation

Download the Node module, and put it under your-app/node_modules.

Usage

                        var techcafe = require('./node_modules/node_techcafe/node_techcafe');
                        techcafe.getTeacherList(function(data){
                            // Returns a list of JSON objects containing all teachers
                            console.log(data);
                        })
                        techcafe.getContentByTeacher('TeacherUsername', function(data){
                            // Returns a list of JSON objects containing all content sets owned by teacher 'TeacherUsername'
                            console.log(data);
                        })

API

getTeacherList(function)

Returns a list of JSON objects containing all teachers in the database.

Data Format:

                                    [
                                        {username:Teacher1}, 
                                        {username:Teacher2},
                                        ...
                                    ]

getContentSetList(function)

Returns JSON object containing all content sets in the database.

Data Format:

                                    {
                                        ContentSet1: Questions, 
                                        ContentSet2: Questions, 
                                        ...
                                    }

getContentByTeacher(teacherID, function)

Returns JSON object containing all content sets for a given teacher ID.

Data Format:

                                    {
                                        username: 'username', 
                                        content_sets: 
                                        [
                                            {name:ContentSet1, questions:Questions},
                                            {name:ContentSet2, questions:Questions},
                                            ...
                                        ]
                                    }

Licence

(The MIT license)

Copyright (c) 2013 Gina Assaf, Sachin Hedge, Rachel Leksana, Esther Wang, Bingying Xia

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.