Empty DATA[] element returned by some student-academic-analytics methods.

[ArethusaData]

Hi,

I have noticed that quite a few of the student-academic-analytics APIs aren't returning any data. I get the usual JSON formatted response back from the API, but the DATA element is empty. See example below:

{"DATA":[],"__tassversion":"01.058.12.200","token":{"timestamp":"{ts '2024-02-27 12:14:12'}","objcode":"all"}}

The affected methods I've found so far include:

getActivityAnalyticMapping
getActivityMinMaxResults
getStudentActivityAnalyticMapping
getStudentSubjectMapResults
getStudentSubjectResultsProcess
getStudentSubjectsTeacher
getStudentWeightedResults

I can see student subjects and results listed in TASS.web so I was expecting the same data to be available through the API. Hopefully, I'm doing something silly and just can't spot it.

By the way, I receive the expected data when I use the following methods:

getClassLessons
getStudentAbsences
getStudentSubjects

Any help you can give me would be really appreciated! Thanks, Guy

[ArethusaData]

Hi,

Can anyone shed any light on this? Could it have something to do with permissions? It is a version 2 API so there is no security role specified in TASS.web.

Cheers, Guy

[ArethusaData]

Hi,

Unfortunately, I've discovered a potential issue with getStudentAbsences after all. Although it does return most of the data, there are definitely records missing from the API results, but which are visible in TASS.web and are also in the results generated by the student absence listings section of the Teacher Kiosk.

I don't want to post an example here but if you contact me, I can give you the details to reproduce the problem.

Cheers, Guy

[scottetass]

Hi Guy,

Are the missing records for a particular teacher/class? One of the requirements for data to appear in getStudentAbsences is that the teacher who entered the absence must be a valid kiosk user. You can check this by looking at the teacher record in TASS and ensuring that the 'Teacher Kiosk Access' is checked on for teachers missing data in analytics.

A nightly scheduled task will then regenerate absence data for the current year/semester.

Let me know how you get on with checking this particular method.

As for the other calls, there are many reasons why the data may not be appearing. Some will be because the analytics flags in academic reporting assessment setup are not turned on (see Objectives / Assessment Methods / Result Formats). For others, it may be a bit more complicated.

I'll have to pick through each call and find out the rules that may be stopping records from getting included in analytics.

Thanks, Scott

[scottetass]

Absence records are only included in the student analytics API if the absence was recorded for an entire period or the absence spans over multiple periods. If a student arrives late to class or leaves a class early it is not considered for analytics as they were actually present for some part of the period, albeit a few minutes late for arrival or a few minutes early for departure. This is by design for the analytics data.

We will internally review this requirement to determine it's applicability for the Analytics API and how it may be improved.