Get Aggregate Oral Reading Measures for Students

This needs to have the structure "Bearer {accessToken}"

• characteristics: Use this when you want to pass characteristics of an audio performance, like wcpm, to get a measurement.
• performanceIds: Use this if you want to pass performanceIds received using the Get Oral Reading Measures for Students call the to get a measurement.

Values you can pass are:

• True: An annotations object that contains a measurement for each performance will be returned in addition to an aggregate measurement for all performances.
• False: The call will only return an aggregate measurement for all performances.

Example: 160

Example: 0.9

• measure:
  • value: The Lexile measure for the text rounded to the nearest 10L.
  • display: The measure to be used when reporting a Lexile oral readability measure for a text.

• behaviors
  • APPROPRIATE_RATE: Student reads at an appropriate rate. Example: 0.5
  • TOO_SLOW: Student reads too slowly. Example: 0.5
  • TOO_FAST: Student reads too fast. Example: 0.5
  • Varied Rate: student's reading rate fluctuates significantly. Example: 0.5
  • NON_SIGHT_CORRECT: Student reads non sight words correctly. Example: 0.5
  • NON_SIGHT_OKAY: Student reads non sight words with some pronunciation mistakes or hesitation. Example: 0.5
  • NON_SIGHT_SKIP: Student tends to skip non sight words. Example: 0.5
  • NON_SIGHT_GUESS: Student tends to guess at non sight words. Example: 0.5
  • SIGHT_AUTOMATIC: Student reads sight words with accuracy and automaticity. Example: 0.5
  • SIGHT_SLOW: Student reads sight words slowly, without automaticity. Example: 0.5
  • SIGHT_SKIPS: Student tends to skip sight words. Example: 0.5
  • SIGHT_GUESSES: Student tends to guess at sight words. Example: 0.5
  • PAUSING_GOOD: Student pauses at the appropriate times. Example: 0.5
  • RUN_ON: Student does not pause at appropriate times. Example: 0.5
  • TOO_MUCH_PAUSING: Student pauses too much or inappropriately. Example: 0.5
  • GOOD_INTONATION: Student demonstrates good intonation at the ends of sentences. Example: 0.5
  • BAD_INTONATION: Student demonstrates bad intonation at the ends of sentences. Example: 0.5
• readingAdvice: An overall plain language feedback message based on the observed reading behaviors, highlighting a positive aspect of the performance and identifying an area for practice or improvement. Example: 0.5

• measure
  • value: The Lexile oral reading measure for a student rounded to the nearest 5L. Example: 400
  • display: The measure to be used when reporting a Lexile oral reading measure for a student. The letters included with the measure indicate what type of measure this is. Example: 400L
  • uncertainty: The degree of uncertainty expressed in Lexiles.

{
   "annotations":[
      {
         "wcpm":80,
         "accuracy":0.7,
         "oralReadingAbility": {
            "measure":{
               "value":210,
               "display":"210L",
               "uncertainty":20
            },
            "displayName":"Lexile Oral Reading"
          }
       }
   ],
   "aggregate": {
      "oralReadingAbility": {
         "measure":{
            "value":210,
            "display":"210L",
            "uncertainty":20
         },
         "displayName":"Lexile Oral Reading"
      }
      "feedback": {
         "behaviors": {
            "APPROPRIATE_RATE": 0.75,
            "TOO_SLOW": 0.01,
            "TOO_FAST": 0.62,
            "VARIED_RATE": 0.08,
            "NON_SIGHT_CORRECT": 1.0,
            "NON_SIGHT_OKAY": 0.07,
            "NON_SIGHT_SKIP": 0.03,
            "NON_SIGHT_GUESS": 0.02,
            "SIGHT_AUTOMATIC": 1.0,
            "SIGHT_SLOW": 0.0,
            "SIGHT_SKIPS": 0.03,
            "SIGHT_GUESSES": 0.0,
            "PAUSING_GOOD": 0.75,
            "RUN_ON": 0.87,
            "TOO_MUCH_PAUSING": 0.16,
            "GOOD_INTONATION": 0.75,
            "BAD_INTONATION": 0.89
        },
        "readingAdvice": "Good job correctly reading larger and harder words. Remember to pause at the ends of sentences."
      }
   },
   "apiVersion":"0.1.1"
}

For example, you could receive this error when the audio is too soft or the file is too short to be measured.

{
     "message": "Invalid input.",
     "exceptionType": "ValidationError",
     "additionalInfo": "Check validation errors for specifics.",
     "validationErrors": {
     "audioFile": [
     "Sample Depth of 8 bits is too low."
  ],
     "textFile": [
     "Text file must have a .txt extension and be UTF-8 encoded."
]
}
}

{
     "message": "The audio recording's performance has characteristics that made it's score unreliable.",
     "exceptionType": "UnReportableScoreException"
}

{
  "message": "Service temporarily unavailable, try again later",
  "exceptionType": "APIException",
  "additionalInfo": "Error when calling remote service"
}