Skip to main content
GET
/
aggregatedAttendance
Returnerar aggregerad närvaro för en student eller grupp.
curl --request GET \
  --url https://ss12000.staging.meitner.se/api/v1/aggregatedAttendance \
  --header 'Authorization: Bearer <token>'
{
  "student": null,
  "meta": {
    "created": "2000-01-23T04:56:07.000Z",
    "modified": "2000-01-23T04:56:07.000Z"
  },
  "startDate": "2000-01-23T00:00:00.000Z",
  "endDate": "2000-01-23T00:00:00.000Z",
  "organisation": null,
  "reportedLessons": 25,
  "totalLessons": 30,
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "attendancePercent": 85.5,
  "attendanceMinutes": 1500,
  "validAbsenceMinutes": 150,
  "invalidAbsenceMinutes": 100,
  "otherAttendanceMinutes": 50
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
student
string<uuid>

Begränsa urvalet till utpekad person.

​
organisation
string<uuid>

Begränsa urvalet till utpekat organisationselement och dess underliggande element.

​
startDate.onOrBefore
string<date>

Begränsa urvalet till närvaro som har ett startDate värde innan eller på det angivna datumet (RFC 3339-format, t.ex. "2016-10-15").

​
startDate.onOrAfter
string<date>

Begränsa urvalet till närvaro som har ett startDate värde på eller efter det angivna datumet (RFC 3339-format, t.ex. "2016-10-15").

​
endDate.onOrBefore
string<date>

Begränsa urvalet till närvaro som har ett endDate värde innan eller på det angivna datumet (RFC 3339-format, t.ex. "2016-10-15").

​
endDate.onOrAfter
string<date>

Begränsa urvalet till närvaro som har ett endDate värde på eller efter det angivna datumet (RFC 3339-format, t.ex. "2016-10-15").

​
meta.created.before
string<date-time>

Endast poster skapade på eller före detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Inkluderande.

​
meta.created.after
string<date-time>

Endast poster skapade efter detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Exkluderande.

​
meta.modified.before
string<date-time>

Endast poster modifierade på eller före detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Inkluderande.

​
meta.modified.after
string<date-time>

Endast poster modifierade efter detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Exkluderande.

​
expandReferenceNames
boolean

Returnera displayName för alla refererade objekt.

​
limit
integer

Antal poster som ska visas i resultatet. Utelämnas det så returnas så många poster som möjligt av servern, se pageToken.

Required range: x >= 1
​
pageToken
string

Ett opakt värde som servern givit som svar på en tidigare ställd fråga. Kan inte komibineras med andra filter men väl med limit.

Response

Anropet lyckades.

Aggregerad närvaro för en student

​
id
string<uuid>
required

Identifierare för den aggregerade närvaroposten.

​
meta
Meta · object
required
Example:
{
  "created": "2000-01-23T04:56:07.000Z",
  "modified": "2000-01-23T04:56:07.000Z"
}
​
student
PersonReference · object
required

Referens till en person

​
startDate
string<date>
required

Startdatum för aggregerad närvaro (RFC 3339-format, t.ex. "2016-10-15").

​
endDate
string<date>
required

Slutdatum för aggregerad närvaro (RFC 3339-format, t.ex. "2016-10-15").

​
totalLessons
integer
required

Totalt antal lektioner under perioden.

​
organisation
OrganisationReference · object

Referens till ett organisationselement.

​
reportedLessons
integer

Antal lektioner som har närvaro rapporterad.

​
attendanceMinutes
integer

Total närvarotid i minuter.

​
validAbsenceMinutes
integer

Total giltig frånvarotid i minuter.

​
invalidAbsenceMinutes
integer

Total ogiltig frånvarotid i minuter.

​
otherAttendanceMinutes
integer

Total tid i minuter för deltagande i annan skolaktivitet, såsom elevråd.

​
attendancePercent
number<float>

Procentuell närvaro under perioden.