Skip to main content
GET
/
groups
/
{id}
Hämta grupper baserat på ID
curl --request GET \
  --url https://ss12000.staging.meitner.se/api/v1/groups/{id} \
  --header 'Authorization: Bearer <token>'
{
  "groupType": null,
  "endDate": "2000-01-23T00:00:00.000Z",
  "meta": {
    "created": "2000-01-23T04:56:07.000Z",
    "modified": "2000-01-23T04:56:07.000Z"
  },
  "displayName": "displayName",
  "schoolType": null,
  "organisation": null,
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "startDate": "2000-01-23T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

ID för grupp som ska hämtas

Query Parameters

​
expand
enum<string>[]

Beskriver om expanderade data ska hämtas

Available options:
assignmentRoles
​
expandReferenceNames
boolean

Returnera displayName för alla refererade objekt.

Response

Anropet lyckades.

Group kan innehålla personer eller bara vara en tom "platshållare" utan medlemmar, som kan populeras vid ett senare tillfälle. Notera att gruppens koppling till ämnen/kurser och lärare görs via Aktivitet. Grupper har olika egenskaper baserat på grupptyp. Individer kan ha olika roller i relation till en viss grupp. Grupper har specifika egenskaper.

​
id
string<uuid>
required

Identifierare för gruppen

​
meta
Meta · object
required
Example:
{
  "created": "2000-01-23T04:56:07.000Z",
  "modified": "2000-01-23T04:56:07.000Z"
}
​
displayName
string
required

Gruppens benämning.

​
startDate
string<date>
required

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

​
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
​
organisation
OrganisationReference · object
required

Referens till ett organisationselement.

​
endDate
string<date>

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

​
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
​
groupMemberships
GroupMembership · object[]

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

​
_embedded
object