Proposed RESTful API for exams data integration

[Ghislain Hachey]

Proposed RESTful API for pulling the data from the Pacific Testing Center exams OnlineSBA system.

[Ghislain Hachey]

Get the various exams from URI /api/v1/exams

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<Exams>
  <Exam ExamID="MISAT">
    <Name>Marshall Islands Standard Achievement Test</Name>
  <Exam>
</Exams>

Get the various tests for an exam from URI /api/v1/exams/misat/tests

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<Tests>
  <Test TestID="M10">
    <Name>Year 10 Maths</Name>
    <Year>2016-17</Year>
  </Test>
  <Test TestID="M10">
    <Name>Year 10 Maths</Name>
    <Year>2017-18</Year>
  </Test>
  <Test TestID="R08">
    <Name>Year 8 Reading</Name>
    <Year>2016-17</Year>
  <Test>
  <Test TestID="R08">
    <Name>Year 8 Reading</Name>
    <Year>2016-17</Year>
  <Test>  
</Tests>

Get the actual data for the tests for an exam from URI /api/v1/exams/misat/tests/m10/2016-17

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<MISAT>

  <Test TestID="M10">
    <Name>Year 10 Maths</Name>
    <Year>2016-17</Year>
  </Test>

  <Curriculum>
    <Standards>
      <Standard StandardID="Mth.1">
        <Description>Number, Operations and Computation</Description>
      </Standard>
      <Standard StandardID="Mth.2">
        <Description>Geometry, Measurement and Transformation</Description>
      </Standard>
      <Standard StandardID="Mth.3">
        <Description>Patterns and Algebra</Description>
      </Standard>
      <Standard StandardID="Mth.4">
        <Description>Statistics and Probability</Description>
      </Standard>
    </Standards>
    <Benchmarks>
      <Benchmark BenchmarkID="Mth.1.1" StandardID="Mth.1">
        <Description>Demonstrate the inverse relationship between square numbers and square roots.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.1.2" StandardID="Mth.1">
        <Description>Compare and order rational numbers and square roots using a number line.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.1.3" StandardID="Mth.1">
        <Description>Solve problems with squares and square roots, limited to square roots of square numbers.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.1.4" StandardID="Mth.1">
        <Description>Represent numbers in a variety of forms and change from one form to another.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.2.1" StandardID="Mth.2">
        <Description>Apply an understanding of the English and metric systems of measurement to solve problems.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.2.2" StandardID="Mth.2">
        <Description>Use formulas, including approximate units of measure, to determine the surface area and volume of selected prisms, cylinders, and pyramids.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.2.3" StandardID="Mth.2">
        <Description>Apply the Pythagorean Theorem to solve problems involving right triangles.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.2.4" StandardID="Mth.2">
        <Description>Perform transformations including reflection, rotation, and translation and describe the size, position, and orientation of the resulting shapes.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.3.1" StandardID="Mth.3">
        <Description>Represent a variety of patterns, including recursive patterns, with tables, graphs, words, and symbols.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.3.2" StandardID="Mth.3">
        <Description>Represent mathematical situations as algebraic expressions and equations and describe algebraic expressions using words.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.3.3" StandardID="Mth.3">
        <Description>Solve Single-variable equations and inequalities using rational numbers.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.3.4" StandardID="Mth.3">
        <Description>Use tables and graphs to present linear equalities and inequalities with two variables and solve problems.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.3.5" StandardID="Mth.3">
        <Description>Justify the steps used in simplifying expressions and solve equations and inequalities.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.4.1" StandardID="Mth.4">
        <Description>Analyze and interpret data using mean, median, mode, range and frequency.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.4.2" StandardID="Mth.4">
        <Description>Design a study, collect data, and select the appropriate representations to make conclusions and generalizations.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.4.3" StandardID="Mth.4">
        <Description>Judge the validity of reported data, conclusions and generalizations.</Description>
      </Benchmark>
      <Benchmark BenchmarkID="Mth.4.4" StandardID="Mth.4">
        <Description>Calculate probabilities for simple events under different relationships, including independent, dependent, with replacement and without replacement.</Description>
      </Benchmark>
    </Benchmarks>
    <AchievementLevels>
      <AchievementLevel AchievementLevelID="1">
        <Name>Well below competent</Name>
      </AchievementLevel>
      <AchievementLevel AchievementLevelID="2">
        <Name>Approaching competence</Name>
      </AchievementLevel>
      <AchievementLevel AchievementLevelID="3">
        <Name>Minimally competent</Name>
      </AchievementLevel>
      <AchievementLevel AchievementLevelID="4">
        <Name>Competent</Name>
      </AchievementLevel>
    </AchievementLevels>
  </Curriculum>

  <Students>
    <Student StudentID="">
      <Name>Leensen Peter</Name>
      <Gender>Female</Gender>
      <SpEd>No</SpEd>
      <Teacher TeacherID="" TeacherName=""></Teacher>
      <Accomodation>Yes</Accomodation>
      <TotalItemsCorrect>59</TotalItemsCorrect>
      <PassingNonPassing>Passing</PassingNonPassing>
      <OverallScore AchievementLevelID="3" />
      <School SchoolID="SCH001"/>
      <Results>
        <Result AchievementLevelID="3" BenchmarkID="Mth.1.1"/>
        <Result AchievementLevelID="4" BenchmarkID="Mth.1.2"/>
        <Result AchievementLevelID="3" BenchmarkID="Mth.1.3"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.1.4"/>
        <Result AchievementLevelID="2" BenchmarkID="Mth.2.1"/>
        <Result AchievementLevelID="2" BenchmarkID="Mth.2.2"/>
        <Result AchievementLevelID="2" BenchmarkID="Mth.2.3"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.2.4"/>
        <Result AchievementLevelID="3" BenchmarkID="Mth.3.1"/>
        <Result AchievementLevelID="4" BenchmarkID="Mth.3.2"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.3.3"/>
        <Result AchievementLevelID="2" BenchmarkID="Mth.3.4"/>
        <Result AchievementLevelID="2" BenchmarkID="Mth.3.5"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.4.1"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.4.2"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.4.3"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.4.4"/>
      </Results>
    </Student>
    <Student StudentID="">
      <Name>Dermy Ham</Name>
      <Gender>Female</Gender>
      <SpEd>No</SpEd>
      <Teacher TeacherID="" TeacherName=""></Teacher>
      <Accomodation>Yes</Accomodation>
      <TotalItemsCorrect>59</TotalItemsCorrect>
      <PassingNonPassing>Passing</PassingNonPassing>
      <OverallScore AchievementLevelID="3" />
      <School SchoolID="SCH001"/>
      <Results>
        <Result AchievementLevelID="1" BenchmarkID="Mth.1.1"/>
        <Result AchievementLevelID="2" BenchmarkID="Mth.1.2"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.1.3"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.1.4"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.2.1"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.2.2"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.2.3"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.2.4"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.3.1"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.3.2"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.3.3"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.3.4"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.3.5"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.4.1"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.4.2"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.4.3"/>
        <Result AchievementLevelID="1" BenchmarkID="Mth.4.4"/>
      </Results>
    </Student>
    ...
  </Students>

</MISAT>

[Ghislain Hachey]

This was discussed and final specs are at http://docs.pacific-emis.org/doku.php?id=exams_integration_restful_api

This is already working in production for RMI