Returnerar registrerad frånvaro för en student.

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

{
  "data": [
    {
      "verified": true,
      "endTime": "2000-01-23T04:56:07.000Z",
      "student": null,
      "startTime": "2000-01-23T04:56:07.000Z",
      "meta": {
        "created": "2000-01-23T04:56:07.000Z",
        "modified": "2000-01-23T04:56:07.000Z"
      },
      "registrationDate": "2000-01-23T00:00:00.000Z",
      "organisation": null,
      "absenceReason": "absenceReason",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type": "Giltig"
    },
    {
      "verified": true,
      "endTime": "2000-01-23T04:56:07.000Z",
      "student": null,
      "startTime": "2000-01-23T04:56:07.000Z",
      "meta": {
        "created": "2000-01-23T04:56:07.000Z",
        "modified": "2000-01-23T04:56:07.000Z"
      },
      "registrationDate": "2000-01-23T00:00:00.000Z",
      "organisation": null,
      "absenceReason": "absenceReason",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type": "Giltig"
    }
  ],
  "pageToken": "pageToken"
}

GET

absences

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

{
  "data": [
    {
      "verified": true,
      "endTime": "2000-01-23T04:56:07.000Z",
      "student": null,
      "startTime": "2000-01-23T04:56:07.000Z",
      "meta": {
        "created": "2000-01-23T04:56:07.000Z",
        "modified": "2000-01-23T04:56:07.000Z"
      },
      "registrationDate": "2000-01-23T00:00:00.000Z",
      "organisation": null,
      "absenceReason": "absenceReason",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type": "Giltig"
    },
    {
      "verified": true,
      "endTime": "2000-01-23T04:56:07.000Z",
      "student": null,
      "startTime": "2000-01-23T04:56:07.000Z",
      "meta": {
        "created": "2000-01-23T04:56:07.000Z",
        "modified": "2000-01-23T04:56:07.000Z"
      },
      "registrationDate": "2000-01-23T00:00:00.000Z",
      "organisation": null,
      "absenceReason": "absenceReason",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "type": "Giltig"
    }
  ],
  "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.

registrationDate.onOrBefore

string<date>

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

registrationDate.onOrAfter

string<date>

Begränsa urvalet till frånvaroposter som har ett registrationDate värde efter eller på 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.

data

Absence · object[]

required

Show child attributes

data.id

string<uuid>

required

Identifierare för frånvaroposten.

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.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.organisation

OrganisationReference · object

required

Referens till ett organisationselement.

Show child attributes

data.organisation.id

string<uuid>

required

data.organisation.displayName

string

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

data.registrationDate

string<date>

required

Vilket datum frånvaroposten avser (RFC 3339-format, t.ex. "2016-10-15").

data.startTime

string<date-time>

required

Frånvarons starttid (RFC 3339 format tex "2015-12-12T10:30:00+01:00").

data.endTime

string<date-time>

required

Frånvarons sluttid (RFC 3339 format tex "2015-12-12T12:00:00+01:00").

data.type

enum<string>

required

Frånvarotyp.

Giltig innebär följande: Frånvaro då eleven är ledig enligt schema, exempelvis håltimmar eller frånvaro som har meddelats i förväg och som har godkänts av skolpersonal.
Ogiltig innebär följande: Frånvaro som inte har meddelats i förväg eller godkänts av skolpersonal.

Available options:

Giltig,

Ogiltig

data.absenceReason

string

Textfält för att beskriva frånvaroorsak, exempelvis "Familje-, tandläkar- och läkarbesök".

data.verified

boolean

Anger om frånvaron är verifierad av förälder, elev eller annan behörig person (ej skolpersonal).

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 närvaropost baserat på ID Hämta många frånvaro-poster baserat på en lista av ID:n.

⌘I

Getting started

Reference

Authorizations

Query Parameters

Response