Returnerar registrerad närvaro utifrån en aktivitet eller student.

curl --request GET \
  --url https://ss12000.staging.meitner.se/api/v1/attendances \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "invalidAbsenceMinutes": 3,
      "otherAttendanceMinutes": 2,
      "student": null,
      "meta": {
        "created": "2000-01-23T04:56:07.000Z",
        "modified": "2000-01-23T04:56:07.000Z"
      },
      "calendarEvent": null,
      "absenceReason": "absenceReason",
      "reporter": null,
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "reportedTimestamp": "2000-01-23T04:56:07.000Z",
      "isReported": true,
      "attendanceMinutes": 7,
      "validAbsenceMinutes": 9
    },
    {
      "invalidAbsenceMinutes": 3,
      "otherAttendanceMinutes": 2,
      "student": null,
      "meta": {
        "created": "2000-01-23T04:56:07.000Z",
        "modified": "2000-01-23T04:56:07.000Z"
      },
      "calendarEvent": null,
      "absenceReason": "absenceReason",
      "reporter": null,
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "reportedTimestamp": "2000-01-23T04:56:07.000Z",
      "isReported": true,
      "attendanceMinutes": 7,
      "validAbsenceMinutes": 9
    }
  ],
  "pageToken": "pageToken"
}

GET

attendances

curl --request GET \
  --url https://ss12000.staging.meitner.se/api/v1/attendances \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "invalidAbsenceMinutes": 3,
      "otherAttendanceMinutes": 2,
      "student": null,
      "meta": {
        "created": "2000-01-23T04:56:07.000Z",
        "modified": "2000-01-23T04:56:07.000Z"
      },
      "calendarEvent": null,
      "absenceReason": "absenceReason",
      "reporter": null,
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "reportedTimestamp": "2000-01-23T04:56:07.000Z",
      "isReported": true,
      "attendanceMinutes": 7,
      "validAbsenceMinutes": 9
    },
    {
      "invalidAbsenceMinutes": 3,
      "otherAttendanceMinutes": 2,
      "student": null,
      "meta": {
        "created": "2000-01-23T04:56:07.000Z",
        "modified": "2000-01-23T04:56:07.000Z"
      },
      "calendarEvent": null,
      "absenceReason": "absenceReason",
      "reporter": null,
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "reportedTimestamp": "2000-01-23T04:56:07.000Z",
      "isReported": true,
      "attendanceMinutes": 7,
      "validAbsenceMinutes": 9
    }
  ],
  "pageToken": "pageToken"
}

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.

calendarEvent

string<uuid>

Begränsa urvalet till utpekad kalenderpost.

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.

data

Attendance · object[]

required

Show child attributes

data.id

string<uuid>

required

Identifierare för närvaroposten.

data.meta

Meta · object

required

Show child attributes

data.meta.created

string<date-time>

required

Datum och tid för när entiteten skapades (RFC 3339 format tex "2015-12-12T10:30:00+01:00").

data.meta.modified

string<date-time>

required

Datum och tid för när entiteten senast uppdaterades (RFC 3339 format tex "2015-12-12T10:30:00+01:00"). Tidpunkten avser den senaste tidpunkt när något av de attribut som direkt tillhör entiteten har ändrats. Attribut som kan tas fram med parametrarna expand eller expandReferenceNames räknas inte som ett attribut till entiteten, och ska således inte påverka detta värde.

Example:

{
  "created": "2000-01-23T04:56:07.000Z",
  "modified": "2000-01-23T04:56:07.000Z"
}

data.calendarEvent

CalendarEventReference · object

required

Referens till en kalenderhändelse

Show child attributes

data.calendarEvent.id

string<uuid>

required

data.calendarEvent.displayName

string

Namn för visningsyfte för det refererade objektet. Skall endast returneras när query parametern expandReferenceNames är satt till "true".

data.student

PersonReference · object

required

Referens till eleven.

Show child attributes

data.student.id

string<uuid>

required

data.student.displayName

string

Namn för visningsyfte för det refererade objektet. Skall endast returneras när query parametern expandReferenceNames är satt till "true".

data.student.securityMarking

enum<string>

Återspeglar värdet från folkbokföringsregistret.

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data.isReported

boolean

required

Anger om lektionen är rapporterad.

data.reporter

PersonReference · object

Person som rapporterat kalenderhändelsen.

Show child attributes

data.reporter.id

string<uuid>

required

data.reporter.displayName

string

Namn för visningsyfte för det refererade objektet. Skall endast returneras när query parametern expandReferenceNames är satt till "true".

data.reporter.securityMarking

enum<string>

Återspeglar värdet från folkbokföringsregistret.

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data.attendanceMinutes

integer

Längd i minuter för elevens närvaro på kalenderhändelsen.

data.validAbsenceMinutes

integer

Längd i minuter för elevens giltiga frånvaro på kalenderhändelsen.

data.invalidAbsenceMinutes

integer

Längd i minuter för elevens ogiltiga frånvaro på kalenderhändelsen.

data.otherAttendanceMinutes

integer

Tid i minuter för elevens deltagande i annan skolaktivitet, såsom elevråd, i stället för deltagande på kalenderhändelsen.

data.absenceReason

string

Angiven anledning till frånvaro.

data.reportedTimestamp

string<date-time>

Tidpunkt för rapportering av kalenderhändelsen (RFC 3339 format, tex "2015-12-12T10:30:00+01:00").

pageToken

string | null

Om värdet är null finns inget mer att hämta på det token som skickades in som query parameter.

Hämta en lista med aktiviteter baserat på ett antal sökparametrar.Hämta många närvaro-poster baserat på en lista av ID:n.

⌘I

Getting started

Reference

Authorizations

Query Parameters

Response