> ## Documentation Index > Fetch the complete documentation index at: https://docs.meitner.se/llms.txt > Use this file to discover all available pages before exploring further. # Hämta grupper baserat på ID ## OpenAPI ````yaml https://meitner-api-docs.s3.eu-north-1.amazonaws.com/meitner_ss12000_version2_1_0.yaml get /groups/{id} openapi: 3.0.2 info: contact: email: tk450@sis.se description: > Detta är en implementationsspecifikation av SS12000:2020 [TK450](https://www.sis.se/standardutveckling/tksidor/tk400499/sistk450/) termsOfService: https://www.sis.se/standardutveckling/tksidor/tk400499/sistk450/ title: SS12000 version: 2.1.0 servers: - url: https://ss12000.staging.meitner.se/api/v1 description: Staging server - url: https://ss12000.meitner.se/api/v1 description: Production server - url: http://localhost:8600/api/v1 description: Development server security: - BearerAuth: [] tags: - description: Skolans organisation och grundläggande administration. name: Organisation - description: Hanterar personer och personers relationer. name: Person - description: Grupper. name: Grupper - description: Information om kurser, ämnen, program och studieplaner. name: Studieinformation - description: Aktiviteter knyter ihop lärare och elever med ämne eller kurs. name: Aktiviteter externalDocs: description: För mer information hämtas från SIS - TK450 url: https://sis.se/standardutveckling/tksidor/tk400499/sistk450/ paths: /groups/{id}: get: tags: - Grupper summary: Hämta grupper baserat på ID parameters: - description: ID för grupp som ska hämtas in: path name: id required: true schema: format: uuid type: string - description: Beskriver om expanderade data ska hämtas in: query name: expand schema: items: enum: - assignmentRoles type: string type: array - description: Returnera `displayName` för alla refererade objekt. in: query name: expandReferenceNames schema: type: boolean responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupExpanded' description: Anropet lyckades. '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: Felaktigt id. '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Åtkomst nekad. '404': description: Posten hittades inte. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Okänt fel. components: schemas: GroupExpanded: allOf: - $ref: '#/components/schemas/Group' - $ref: '#/components/schemas/GroupExpanded_allOf' Error: properties: code: description: >- Teknisk kod för att beskriva fel, varje källa bestämmer själv över möjliga felkoder. type: string message: description: Text för att beskriva felet. type: string required: - code - message type: object Group: allOf: - $ref: '#/components/schemas/GroupFragment' - $ref: '#/components/schemas/Group_allOf' GroupExpanded_allOf: properties: _embedded: $ref: '#/components/schemas/GroupExpanded_allOf__embedded' type: object GroupFragment: description: > 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. example: 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' properties: id: description: Identifierare för gruppen format: uuid type: string meta: $ref: '#/components/schemas/Meta' displayName: description: Gruppens benämning. type: string startDate: description: > Startdatum för gruppens giltighetstid (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande. format: date type: string endDate: description: > Slutdatum för gruppens giltighetstid (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande. format: date type: string groupType: $ref: '#/components/schemas/GroupTypesEnum' schoolType: $ref: '#/components/schemas/SchoolTypesEnum' organisation: $ref: '#/components/schemas/OrganisationReference' required: - displayName - groupType - id - meta - organisation - startDate title: Group type: object Group_allOf: properties: groupMemberships: description: > Gruppmedlemskap anger att en person är medlem i en grupp och vilken tidsperiod medlemskapet omfattar. items: $ref: '#/components/schemas/GroupMembership' type: array type: object GroupExpanded_allOf__embedded: properties: assignmentRoles: items: $ref: '#/components/schemas/GroupExpanded_allOf__embedded_assignmentRoles' type: array type: object Meta: example: created: '2000-01-23T04:56:07.000Z' modified: '2000-01-23T04:56:07.000Z' properties: created: description: > Datum och tid för när entiteten skapades (RFC 3339 format tex "2015-12-12T10:30:00+01:00"). format: date-time type: string modified: description: > 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. format: date-time type: string readOnly: true required: - created - modified title: Meta type: object GroupTypesEnum: description: > 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. enum: - Undervisning - Klass - Mentor - Provgrupp - Schema - Avdelning - Personalgrupp - Övrigt title: Code_GroupType type: string SchoolTypesEnum: description: | 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 enum: - 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 title: Code_SchoolType type: string OrganisationReference: allOf: - $ref: '#/components/schemas/ObjectReference' - description: Referens till ett organisationselement. title: OrganisationReference GroupMembership: properties: person: $ref: '#/components/schemas/PersonReference' startDate: description: > Startdatum för personens medlemskap i gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande. format: date type: string endDate: description: > Slutdatum för personens medlemskap i gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande. format: date type: string required: - person title: GroupMembership type: object GroupExpanded_allOf__embedded_assignmentRoles: properties: duty: $ref: '#/components/schemas/DutyReference' assignmentRoleType: $ref: '#/components/schemas/AssignmentRoleTypeEnum' startDate: description: > Startdatum för tjänstens relation till gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande. format: date type: string endDate: description: > Slutdatum för tjänstens relation till gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande. format: date type: string type: object ObjectReference: properties: id: format: uuid type: string displayName: description: > Namn för visningsyfte för det refererade objektet. Skall endast returneras när query parametern `expandReferenceNames` är satt till "true". readOnly: true type: string required: - id title: ObjectReference type: object PersonReference: allOf: - $ref: '#/components/schemas/ObjectReference' - $ref: '#/components/schemas/PersonReference_1' DutyReference: allOf: - $ref: '#/components/schemas/ObjectReference' - description: Referens till en Duty title: DutyReference AssignmentRoleTypeEnum: enum: - Mentor - Förskollärare - Barnskötare - Fritidspedagog - Specialpedagog - Elevhälsopersonal - Pedagogisk ledare - Schemaläggare - Lärarassistent - Administrativ personal title: Code_AssignmentRole type: string PersonReference_1: description: Referens till en person properties: securityMarking: description: | Återspeglar värdet från folkbokföringsregistret. enum: - Ingen - Sekretessmarkering - Skyddad folkbokföring title: Code_SecurityMarking type: string title: PersonReference securitySchemes: BearerAuth: bearerFormat: JWT scheme: bearer type: http ````