Skip to main content
GET
/
groups
Hämta en lista med grupper.
curl --request GET \
  --url https://ss12000.staging.meitner.se/api/v1/groups \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    null,
    null
  ],
  "pageToken": "pageToken"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
groupType
enum<string>[]

Begränsa urvalet till grupper av en eller flera type.

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
​
schoolTypes
enum<string>[]

Begränsa urvalet av grupper till de som är har en av de angivna skolformerna.

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
​
organisation
string<uuid>[]

Begränsa urvalet till de grupper som direkt kopplade till angivna organisationselement.

​
startDate.onOrBefore
string<date>

Begränsa urvalet till grupper 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 grupper 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 grupper 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 grupper 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:
assignmentRoles
​
expandReferenceNames
boolean

Returnera displayName för alla refererade objekt.

​
sortkey
enum<string>

Anger hur resultatet ska sorteras.

Available options:
ModifiedDesc,
DisplayNameAsc,
StartDateAsc,
StartDateDesc,
EndDateAsc,
EndDateDesc
​
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
Group · object[]
required
​
pageToken
string | null

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