Hämta många närvaro-poster baserat på en lista av ID:n.

curl --request POST \
  --url https://ss12000.staging.meitner.se/api/v1/attendances/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  ]
}
'

[
  {
    "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
  }
]

POST

attendances

lookup

Hämta många närvaro-poster baserat på en lista av ID:n.

curl --request POST \
  --url https://ss12000.staging.meitner.se/api/v1/attendances/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
  ]
}
'

[
  {
    "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
  }
]

Authorizations

Authorization

string

header

required

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

Query Parameters

expandReferenceNames

boolean

Returnera displayName för alla refererade objekt.

Body

application/json

ids

string<uuid>[]

Response

Anropet lyckades.

string<uuid>

required

Identifierare för närvaroposten.

meta

Meta · object

required

Show child attributes

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").

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"
}

calendarEvent

CalendarEventReference · object

required

Referens till en kalenderhändelse

Show child attributes

calendarEvent.id

string<uuid>

required

calendarEvent.displayName

string

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

student

PersonReference · object

required

Referens till eleven.

Show child attributes

student.id

string<uuid>

required

student.displayName

string

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

student.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

isReported

boolean

required

Anger om lektionen är rapporterad.

reporter

PersonReference · object

Person som rapporterat kalenderhändelsen.

Show child attributes

reporter.id

string<uuid>

required

reporter.displayName

string

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

reporter.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

attendanceMinutes

integer

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

validAbsenceMinutes

integer

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

invalidAbsenceMinutes

integer

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

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.

absenceReason

string

Angiven anledning till frånvaro.

reportedTimestamp

string<date-time>

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

Returnerar registrerad närvaro utifrån en aktivitet eller student.Hämta närvaropost baserat på ID

⌘I

Getting started

Reference

Authorizations

Query Parameters

Body

Response