Absences & Class Register

Read-only access to student absence data from the Untis Platform class register module. Retrieve aggregated absence totals or individual lesson-level absence records.

v1 Read-only Endpoints: 2

Use cases

Attendance tracking

Integrate absence data into attendance dashboards and reporting tools.

Parent portals

Show parents detailed absence records for their children.

Endpoints

Method	Operation ID	Description
`GET`	`getStudentAbsenceTimes`	Aggregated absence totals per student
`GET`	`getStudentLessonAbsences`	Individual lesson-level absence records

Java example

Retrieve aggregated absence totals per student for a given school year. Construct the client with an access token obtained via Client Credentials.


9 collapsed lines
1
import org.springframework.http.HttpHeaders;
2
import org.springframework.http.HttpStatusCode;
3
import org.springframework.http.MediaType;
4
import org.springframework.util.StreamUtils;
5
import org.springframework.web.client.RestClient;
6
import org.springframework.web.util.UriComponentsBuilder;
7
import java.nio.charset.StandardCharsets;
8
import java.util.List;
9

10
public class UntisApiClient {
11

12
    private final RestClient http;
13

14
    public UntisApiClient(String apiUrl, String accessToken) {
15
        this.http = RestClient.builder()
16
                .baseUrl(apiUrl)
17
                .defaultHeader(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken)
18
                .defaultHeader(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON_VALUE)
19
                .build();
20
    }
21

22
    public AbsencesResponse getStudentAbsenceTimes(int schoolYearId) {
23
        String uri = UriComponentsBuilder
24
                .fromPath("/WebUntis/api/rest/extern/v1/classreg/students/absencetimes")
25
                .queryParam("schoolYearId", schoolYearId)
26
                .build().toUriString();
27

28
        return http.get()
29
                .uri(uri)
30
                .retrieve()
31
                .onStatus(HttpStatusCode::is4xxClientError, (req, res) -> {
32
                    String body = StreamUtils.copyToString(res.getBody(), StandardCharsets.UTF_8);
33
                    throw new IllegalArgumentException(
34
                        "[" + res.getStatusCode().value() + "] " + req.getURI() + ": " + body);
35
                })
36
                .onStatus(HttpStatusCode::is5xxServerError, (req, res) -> {
37
                    String body = StreamUtils.copyToString(res.getBody(), StandardCharsets.UTF_8);
38
                    throw new RuntimeException(
39
                        "[" + res.getStatusCode().value() + "] " + req.getURI() + ": " + body);
40
                })
41
                .body(AbsencesResponse.class);
42
    }
43

44
    public record AbsencesResponse(List<StudentAbsence> students) {
45
        public record StudentAbsence(int studentId, String studentExternKey,
46
                                     AbsenceTotals totals, AbsenceTotals excusedTotals,
47
                                     AbsenceTotals unexcusedTotals,
48
                                     List<AbsenceTime> absenceTimes) {}
49
        public record AbsenceTotals(DayCount days, int hours, int delays) {}
50
        public record DayCount(int count, int remainingHours) {}
51
        public record AbsenceTime(String start, String end, int minutes,
52
                                  String subjectName, String status, String type) {}
53
    }
54
}

Usage:

1
UntisApiClient client = new UntisApiClient("https://api.integration.webuntis.dev", accessToken);
2
UntisApiClient.AbsencesResponse response = client.getStudentAbsenceTimes(2025);
3
response.students().forEach(s -> {
4
    System.out.println("Student " + s.studentId()
5
        + " — total hours absent: " + s.totals().hours());
6
});

Student Management The student master-data referenced in absence records.

Lessons Lesson data that absence records refer to.