Hämta en lista med aktiviteter baserat på ett antal sökparametrar.

Authorizations

Authorization

string

header

required

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

Query Parameters

member

string<uuid>

Begränsa urvalet till aktiviteter vars grupper groups inkluderar denna person. Tidsbegräninsgar (startDate, endDate) appliceras inte för detta filter.

teacher

string<uuid>

Begränsa urvalet till aktiviteter vars lärare teachers inkluderar detta id i attributet duty.id. Tidsbegräninsgar (startDate, endDate) appliceras inte för detta filter.

organisation

string<uuid>

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

group

string<uuid>

Begränsa urvalet till utpekad grupp.

startDate.onOrBefore

string<date>

Begränsa urvalet till aktiviteter 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 aktiviteter 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 aktiviteter som har ett endDate värde innan eller på det angivna datumet (RFC 3339-format, t.ex. "2016-10-15"). Poster med ett endDate som ej är satt, tas alltid med.

endDate.onOrAfter

string<date>

Begränsa urvalet till aktiviteter som har ett endDate värde på eller efter det angivna datumet (RFC 3339-format, t.ex. "2016-10-15"). Poster med ett endDate som ej är satt, tas alltid med.

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.

expand

enum<string>[]

Beskriver om expanderade data ska hämtas

Available options:

groups,

teachers

expandReferenceNames

boolean

Returnera displayName för alla refererade objekt.

sortkey

enum<string>

Available options:

ModifiedDesc,

DisplayNameAsc

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

Activity · object[]

required

Show child attributes

data.id

string<uuid>

required

Identifierare för aktiviteten.

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

string

required

Namn på aktiviteten, i presentationssyfte.

data.calendarEventsRequired

boolean

required

Detta ska uttrycka huruvida aktiviteten ska vara underlag för generering av lektion eller inte.

data.startDate

string<date>

required

Datum för när aktiviteten startar (RFC 3339-format, t.ex. "2016-10-15").

data.groups

GroupReference · object[]

required

De grupper som är kopplade till aktiviteten.

Minimum array length: 1

Show child attributes

data.groups.id

string<uuid>

required

data.groups.displayName

string

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

data.organisation

OrganisationReference · object

required

Den skolenhet/skola som aktiviteten är knuten till.

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

string<date>

Datum för när aktiviteten slutar (RFC 3339-format, t.ex. "2016-10-15").

data.activityType

enum<string>

Beskriver vilken typ av aktivitet som avses.

Undervisning - Schemalagd tid med koppling till timplan, som ska närvarorapporteras.
Elevaktivitet - Schemalagd tid för elever som inte är undervisning enligt timplan, och som ska närvarorapporteras, exempelvis mentorstid, klassråd eller friluftsdag
Provaktivitet - En aktivitet som är avsedd för att definiera ett eller flera provtillfällen
Läraraktivitet - Tid för lärare som inte är undervisning och som ingår i lärarens arbetstid, kan vara schemalagd, men ska inte närvarorapporteras, exempelvis konferenstid.
Övrigt - Läxhjälp, lunch, bokning och annat som finns på schemat, men inte är undervisning och inte ska närvarorapporteras

Available options:

Undervisning,

Elevaktivitet,

Provaktivitet,

Läraraktivitet,

Övrigt

data.comment

string

En text med kompletterande information.

data.minutesPlanned

integer

Den totalt planerade tiden i minuter.

data.teachers

DutyAssignment · object[]

De lärare (Duty-objekt) som är kopplade till aktiviteten.

Show child attributes

data.teachers.duty

DutyReference · object

required

Referens till en Duty

Show child attributes

data.teachers.duty.id

string<uuid>

required

data.teachers.duty.displayName

string

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

data.teachers.startDate

string<date>

Datum för när lärarens deltagande i aktiviteten startar (RFC 3339-format, t.ex. "2016-10-15").

data.teachers.endDate

string<date>

Datum för när lärarens deltagande i aktiviteten slutar (RFC 3339-format, t.ex. "2016-10-15").

data.teachers.minutesPlanned

integer

Det antal minuter läraren är kopplad till aktiviteten

data.teachers.grader

boolean

Markerar att läraren har rollen som betygsättande lärare för aktiviteten

data.syllabus

SyllabusReference · object

Det kurs- eller ämnesplan som aktiviteten är knuten till.

Show child attributes

data.syllabus.id

string<uuid>

required

data.syllabus.displayName

string

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

data.parentActivity

ActivityReference · object

Möjlighet att koppla aktiviteten till en eller flera ursprungliga "föräldraaktiviteter".

Show child attributes

data.parentActivity.id

string<uuid>

required

data.parentActivity.displayName

string

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

data._embedded

object

Show child attributes

data._embedded.groups

Group · object[]

Show child attributes

data._embedded.groups.id

string<uuid>

required

Identifierare för gruppen

data._embedded.groups.meta

Meta · object

required

Show child attributes

data._embedded.groups.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._embedded.groups.meta.modified

string<date-time>

required

Example:

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

data._embedded.groups.displayName

string

required

Gruppens benämning.

data._embedded.groups.startDate

string<date>

required

Startdatum för gruppens giltighetstid (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.

data._embedded.groups.groupType

enum<string>

required

Grupptyp anger vad en grupp ska användas till. Ett värdeförråd för att indikera anger vilka grupptyper som finns.

Undervisning - Undervisningsgruppen är en grupp som har koppling till ett ämne eller en kurs, och som ska schemaläggas med undervisningstid ihop med en lärare.
Klass - Klassen är en organisatorisk grupp med elever som är skolplacerade på en skola med skolform FSK, GR, GRS, SP, SAM, GY eller GYS. Varje elev ska vara placerad i endast en klass. Klassen kan schemaläggas med undervisning enligt timplan. "Klassföreståndare" kan beskrivas genom att koppla en AssignmentRole av typen Mentor.
Mentor - Grupp med elever vilka delar samma mentor/mentorer. Mentor kopplas till gruppen genom en AssignmentRole.
Provgrupp - Grupp med elever vilka ska genomföra ett eller flera prov.
Schema - Schemagrupper är grupper som utgör ett komplement till grupper av typen Undervisning. Schemagrupper ska schemaläggas för att åstadkomma anpassningar av schemat för enskilda elever eller grupper av elever. Exempel på schemagrupper är delgrupper och grupper som används för stödundervisning eller läxhjälp.
Avdelning - Avdelningen är en grupp för placering inom skolformerna förskola eller fritidshem.
Personalgrupp - En grupp vars medlemmar utgörs av personal.
Övrigt - Övriga grupper är andra grupper som inte är något av ovanstående.

Available options:

Undervisning,

Klass,

Mentor,

Provgrupp,

Schema,

Avdelning,

Personalgrupp,

Övrigt

data._embedded.groups.organisation

OrganisationReference · object

required

Referens till ett organisationselement.

Show child attributes

data._embedded.groups.organisation.id

string<uuid>

required

data._embedded.groups.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._embedded.groups.endDate

string<date>

Slutdatum för gruppens giltighetstid (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.

data._embedded.groups.schoolType

enum<string>

Följande värden används för att beskriva skolform:

FS - Förskola
FKLASS - Förskoleklass
FTH - Fritidshem
OPPFTH - Öppen fritidsverksamhet
GR - Grundskola
GRS - Grundsärskola
TR - Träningsskolan
SP - Specialskola
SAM - Sameskola
GY - Gymnasieskola
GYS - Gymnasiesärskola
VUX - Kommunal vuxenutbildning
VUXSFI - Kommunal vuxenutbildning i svenska för invandrare
VUXGR - Kommunal vuxenutbildning på grundläggande nivå
VUXGY - Kommunal vuxenutbildning på gymnasial nivå
VUXSARGR - Kommunal vuxenutbildning som särskild utbildning på grundläggande nivå
VUXSARTR - Kommunal vuxenutbildning som särskild utbildning som motsvarar träningsskolan
VUXSARGY - Kommunal vuxenutbildning som särskild utbildning på gymnasial nivå
SFI - Utbildning i svenska för invandrare
SARVUX - Särskild utbildning för vuxna
SARVUXGR - Särskild utbildning för vuxna på grundläggande nivå
SARVUXGY - Särskild utbildning för vuxna på gymnasial nivå
SFI - Kommunal vuxenutbildning i svenska för invandrare
KU - Kulturskola
YH - Yrkeshögskola
FHS - Folkhögskola
STF - Studieförbund
KKU - Konst- och kulturutbildning
HS - Högskola
ABU - Arbetsmarknadsutbildning
AU - Annan undervisning

Available options:

FS,

FKLASS,

FTH,

OPPFTH,

GR,

GRS,

TR,

SP,

SAM,

GY,

GYS,

VUX,

VUXSFI,

VUXGR,

VUXGY,

VUXSARGR,

VUXSARTR,

VUXSARGY,

SFI,

SARVUX,

SARVUXGR,

SARVUXGY,

KU,

YH,

FHS,

STF,

KKU,

HS,

ABU,

AU

data._embedded.groups.groupMemberships

GroupMembership · object[]

Gruppmedlemskap anger att en person är medlem i en grupp och vilken tidsperiod medlemskapet omfattar.

Show child attributes

data._embedded.groups.groupMemberships.person

PersonReference · object

required

Referens till en person

Show child attributes

data._embedded.groups.groupMemberships.person.id

string<uuid>

required

data._embedded.groups.groupMemberships.person.displayName

string

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

data._embedded.groups.groupMemberships.person.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data._embedded.groups.groupMemberships.startDate

string<date>

Startdatum för personens medlemskap i gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.

data._embedded.groups.groupMemberships.endDate

string<date>

Slutdatum för personens medlemskap i gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.

data._embedded.teachers

Duty · object[]

Show child attributes

data._embedded.teachers.id

string<uuid>

required

Ett ID för tjänsten.

data._embedded.teachers.meta

Meta · object

required

Show child attributes

data._embedded.teachers.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._embedded.teachers.meta.modified

string<date-time>

required

Example:

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

data._embedded.teachers.dutyAt

OrganisationReference · object

required

Referens till ett organisationselement.

Show child attributes

data._embedded.teachers.dutyAt.id

string<uuid>

required

data._embedded.teachers.dutyAt.displayName

string

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

data._embedded.teachers.dutyRole

enum<string>

required

Syfte med tjänsten, den roll tjänsen avser, till exempel lärare eller rektor.

Available options:

Rektor,

Lärare,

Förskollärare,

Barnskötare,

Bibliotekarie,

Lärarassistent,

Fritidspedagog,

Annan personal,

Studie- och yrkesvägledare,

Förstelärare,

Kurator,

Skolsköterska,

Skolläkare,

Skolpsykolog,

Speciallärare/specialpedagog,

Skoladministratör,

Övrig arbetsledning,

Övrig pedagogisk personal,

Förskolechef

data._embedded.teachers.startDate

string<date>

required

Startdatum för personens anställning på en viss skolenhet eller skola (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.

data._embedded.teachers.person

PersonReference · object

Identifierare av person som tjänsten är knuten till.

Show child attributes

data._embedded.teachers.person.id

string<uuid>

required

data._embedded.teachers.person.displayName

string

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

data._embedded.teachers.person.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data._embedded.teachers.assignmentRole

object[]

Datatyp som ska användas för att beskriva arbetsuppgifter för en person i relation till elevgrupp. Lärares undervisning ska inte uttryckas som en arbetsuppgift, för detta syfte används i stället Aktivitet.

Show child attributes

data._embedded.teachers.assignmentRole.group

GroupReference · object

required

Referens till en grupp

Show child attributes

data._embedded.teachers.assignmentRole.group.id

string<uuid>

required

data._embedded.teachers.assignmentRole.group.displayName

string

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

data._embedded.teachers.assignmentRole.assignmentRoleType

enum<string>

required

Available options:

Mentor,

Förskollärare,

Barnskötare,

Fritidspedagog,

Specialpedagog,

Elevhälsopersonal,

Pedagogisk ledare,

Schemaläggare,

Lärarassistent,

Administrativ personal

data._embedded.teachers.assignmentRole.startDate

string<date>

Startdatum för tjänstens relation till gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.

data._embedded.teachers.assignmentRole.endDate

string<date>

Slutdatum för tjänstens relation till gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.

data._embedded.teachers.description

string

Arbetsområde. Kompletterande information till personalkategori, exempelvis Bibliotekarie.

data._embedded.teachers.signature

string

En signatur för tjänstgöringen exempelvis NJN, JOAN.

data._embedded.teachers.dutyPercent

integer

Tjänstgöringsgrad i procent

data._embedded.teachers.hoursPerYear

integer

Antalet timmar tjänstgöringen omfattar under ett år.

data._embedded.teachers.endDate

string<date>

Slutdatum för personens anställning på en viss skolenhet eller skola (RFC 3339-format, e.g. "2016-10-15"). Inkluderande.

pageToken

string | null

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

Getting started

Reference

Authorizations

Query Parameters

Response