Math4Team/RIT/Projects/Question Support API/Data Model: Difference between revisions

No edit summary
highlight recursive entities
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{TOCright}}
===Data Model===
===Data Model===
A potential data model: (It was built for a corporate medical department's medical records. I've already renamed Clinic and Provider to School and Teacher.)
Here is a potential data model: (It was built for a corporate medical department's medical records. I've already renamed Clinic and Provider to School and Teacher.)
[[Image:QuestionERDiagram.PNG|left]]
 
Authorship and history attributes for Questions could be provided through a new Person ID field in Questionnaire and recursive links.
[[Image:QuestionERDiagram.PNG|left]]<br clear="all">
: The Moodle [http://docs.moodle.org/en/Development:Question_database_structure Question database structure].
====Table Dictionary====
====Table Dictionary====
{{Definition_table
{{Definition_table
|Questionnaire |A collection of questions that might be used in a Survey, Quiz, Exam, etc.
|Questionnaire |A collection of questions that might be used in a Survey, Quiz, Exam, etc., or when its key appears in the Category field, a group, class, or category of Questionnaires (a recursive entity)
|Question | A problem seeking an answer
|Question | A problem seeking an answer
|Answer | A potential solution to the problem
|Answer | A potential solution to the problem
|AnswerType | The class of answer suitable for the problem or question
|AnswerType | The class of answer suitable for the problem or question
|Survey | An event instance of collecting Answers to Questions or problems
|Survey | An event in time instance, at which Answers to Questions or problems are gathered. Survey events can reference other surveys, such as follow-up Surveys (a recursive entity).
|Response | An event instance of the Student providing an answer to a question on a Survey or Quiz, etc
|Response | An event in time instance, at which the Student provides an answer to a question on a Survey or Quiz, etc.
|School | An organization
|School | An organization
|Person | An individual, such as a Teacher, Student, etc.
|Person | An individual, such as a Teacher, Student, etc.
}}
}}
====Questionnaire====
====Questionnaire====
: '''''A collection of questions that might be used in a Survey, Quiz, Exam, etc.''''',
:: or when its key appears in the Category field making a recursive entity,
: '''''a group, class, or category of Questionnaires'''''
{{Definition_table
{{Definition_table
|ID | primary key
|ID | primary key
|Title | Short name for questionnaire
|Title | Short name for questionnaire
|Category | Classifier ID, the ID of a Questionnaire class or category of Questionnaire
|Category | Category ID, the ID of a Questionnaire group, class, or category of Questionnaire (the parent of a recursive relationship with other Questionnaire records)
|Notes | Description, Image link, rich format data
|Notes | Description, Image link, rich format data
|StartDate | Effective date for this instance of the Questionnaire
|StartDate | Effective date for this instance of the Questionnaire
Line 27: Line 28:


====Question====
====Question====
: '''''A problem seeking an answer'''''
{{Definition_table
{{Definition_table
|ID | primary key
|ID | primary key
Line 39: Line 41:
}}
}}
====Answer====
====Answer====
: '''''A potential solution to the problem'''''
{{Definition_table
{{Definition_table
|ID | primary key
|ID | primary key
Line 49: Line 52:
}}
}}
====AnswerType====
====AnswerType====
: '''''The class of answer suitable for the problem or question'''''
{{Definition_table
{{Definition_table
|ID | primary key
|ID | primary key
Line 55: Line 59:
}}
}}
====Survey====
====Survey====
: '''''An event in time instance, at which Answers to Questions or problems are gathered. Survey events can reference other surveys, such as follow-up Surveys''''' (a recursive entity).
{{Definition_table
{{Definition_table
|ID | primary key
|ID | primary key
Line 67: Line 72:
}}
}}
====Response====
====Response====
: '''''An event in time instance, at which the Student provides an answer to a question on a Survey or Quiz, etc.'''''
{{Definition_table
{{Definition_table
|ID | primary key
|ID | primary key
Line 81: Line 87:


====School====
====School====
: '''''An organization'''''
{{Definition_table
{{Definition_table
|ID | primary key
|ID | primary key
Line 86: Line 93:
}}
}}
====Person====
====Person====
: '''''An individual, such as a Teacher, Student, etc.'''''
{{Definition_table
{{Definition_table
|ID | primary key
|ID | primary key
Line 91: Line 99:
|First Name | Primary name for Person
|First Name | Primary name for Person
}}
}}
== Comments ==
Authorship and history attributes for Questions could be provided through a new Person ID field in Questionnaire and recursive links.
:: For reference, here is the Moodle [http://docs.moodle.org/en/Development:Question_database_structure Question database structure].