> ## 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 en lista med aktiviteter baserat på ett antal sökparametrar. ## OpenAPI ````yaml https://meitner-api-docs.s3.eu-north-1.amazonaws.com/meitner_ss12000_version2_1_0.yaml get /activities 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: /activities: get: tags: - Aktiviteter summary: Hämta en lista med aktiviteter baserat på ett antal sökparametrar. parameters: - description: >- Begränsa urvalet till aktiviteter vars grupper `groups` inkluderar denna person. Tidsbegräninsgar (`startDate`, `endDate`) appliceras inte för detta filter. in: query name: member schema: format: uuid type: string - description: >- 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. in: query name: teacher schema: format: uuid type: string - description: >- Begränsa urvalet till utpekat organisationselement och dess underliggande element. in: query name: organisation schema: format: uuid type: string - description: Begränsa urvalet till utpekad grupp. in: query name: group schema: format: uuid type: string - description: > 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"). in: query name: startDate.onOrBefore schema: format: date type: string - description: > 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"). in: query name: startDate.onOrAfter schema: format: date type: string - description: > 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. in: query name: endDate.onOrBefore schema: format: date type: string - description: > 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. in: query name: endDate.onOrAfter schema: format: date type: string - description: > Endast poster skapade på eller före detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Inkluderande. in: query name: meta.created.before schema: format: date-time type: string - description: > Endast poster skapade efter detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Exkluderande. in: query name: meta.created.after schema: format: date-time type: string - description: > Endast poster modifierade på eller före detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Inkluderande. in: query name: meta.modified.before schema: format: date-time type: string - description: > Endast poster modifierade efter detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Exkluderande. in: query name: meta.modified.after schema: format: date-time type: string - description: Beskriver om expanderade data ska hämtas in: query name: expand schema: items: enum: - groups - teachers type: string type: array - description: Returnera `displayName` för alla refererade objekt. in: query name: expandReferenceNames schema: type: boolean - in: query name: sortkey schema: enum: - ModifiedDesc - DisplayNameAsc type: string - description: > Antal poster som ska visas i resultatet. Utelämnas det så returnas så många poster som möjligt av servern, se `pageToken`. in: query name: limit required: false schema: minimum: 1 type: integer - description: > 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`. in: query name: pageToken schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Activities' description: Anropet lyckades. '400': content: application/json: schema: $ref: '#/components/schemas/Error' description: >- Filter (ex `sortkey`, `meta.modified.after`, `meta.modified.before`, `meta.created.after`, `meta.created.before` etc.) kan inte kombineras med `pageToken`. '403': content: application/json: schema: $ref: '#/components/schemas/Error' description: Åtkomst nekad. default: content: application/json: schema: $ref: '#/components/schemas/Error' description: Okänt fel. components: schemas: Activities: example: data: - null - null pageToken: pageToken properties: data: items: $ref: '#/components/schemas/ActivityExpanded' type: array pageToken: description: > Om värdet är null finns inget mer att hämta på det token som skickades in som query parameter. nullable: true type: string required: - data type: object 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 ActivityExpanded: allOf: - $ref: '#/components/schemas/Activity' - $ref: '#/components/schemas/ActivityExpanded_allOf' Activity: example: syllabus: null parentActivity: null endDate: '2000-01-23T00:00:00.000Z' displayName: displayName groups: - null - null organisation: null calendarEventsRequired: true meta: created: '2000-01-23T04:56:07.000Z' modified: '2000-01-23T04:56:07.000Z' teachers: - endDate: '2000-01-23T00:00:00.000Z' minutesPlanned: 2 duty: null grader: true startDate: '2000-01-23T00:00:00.000Z' - endDate: '2000-01-23T00:00:00.000Z' minutesPlanned: 2 duty: null grader: true startDate: '2000-01-23T00:00:00.000Z' minutesPlanned: 5 comment: comment id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 activityType: Undervisning startDate: '2000-01-23T00:00:00.000Z' properties: id: description: Identifierare för aktiviteten. format: uuid type: string meta: $ref: '#/components/schemas/Meta' displayName: description: Namn på aktiviteten, i presentationssyfte. type: string calendarEventsRequired: description: > Detta ska uttrycka huruvida aktiviteten ska vara underlag för generering av lektion eller inte. type: boolean startDate: description: > Datum för när aktiviteten startar (RFC 3339-format, t.ex. "2016-10-15"). format: date type: string endDate: description: > Datum för när aktiviteten slutar (RFC 3339-format, t.ex. "2016-10-15"). format: date type: string activityType: description: > 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 enum: - Undervisning - Elevaktivitet - Provaktivitet - Läraraktivitet - Övrigt title: Code_ActivityType type: string comment: description: En text med kompletterande information. type: string minutesPlanned: description: Den totalt planerade tiden i minuter. type: integer groups: description: De grupper som är kopplade till aktiviteten. items: $ref: '#/components/schemas/GroupReference' minItems: 1 type: array teachers: description: De lärare (Duty-objekt) som är kopplade till aktiviteten. items: $ref: '#/components/schemas/DutyAssignment' type: array syllabus: $ref: '#/components/schemas/Activity_syllabus' organisation: $ref: '#/components/schemas/Activity_organisation' parentActivity: $ref: '#/components/schemas/Activity_parentActivity' required: - calendarEventsRequired - displayName - groups - id - meta - organisation - startDate title: Activity type: object ActivityExpanded_allOf: properties: _embedded: $ref: '#/components/schemas/ActivityExpanded_allOf__embedded' 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 GroupReference: allOf: - $ref: '#/components/schemas/ObjectReference' - description: Referens till en grupp title: GroupReference DutyAssignment: example: endDate: '2000-01-23T00:00:00.000Z' minutesPlanned: 2 duty: null grader: true startDate: '2000-01-23T00:00:00.000Z' properties: duty: $ref: '#/components/schemas/DutyReference' startDate: description: > Datum för när lärarens deltagande i aktiviteten startar (RFC 3339-format, t.ex. "2016-10-15"). format: date type: string endDate: description: > Datum för när lärarens deltagande i aktiviteten slutar (RFC 3339-format, t.ex. "2016-10-15"). format: date type: string minutesPlanned: description: Det antal minuter läraren är kopplad till aktiviteten type: integer grader: description: >- Markerar att läraren har rollen som betygsättande lärare för aktiviteten type: boolean required: - duty title: DutyAssignment type: object Activity_syllabus: allOf: - $ref: '#/components/schemas/SyllabusReference' - description: Det kurs- eller ämnesplan som aktiviteten är knuten till. Activity_organisation: allOf: - $ref: '#/components/schemas/OrganisationReference' - description: Den skolenhet/skola som aktiviteten är knuten till. Activity_parentActivity: allOf: - $ref: '#/components/schemas/ActivityReference' - description: > Möjlighet att koppla aktiviteten till en eller flera ursprungliga "föräldraaktiviteter". ActivityExpanded_allOf__embedded: properties: groups: items: $ref: '#/components/schemas/Group' type: array teachers: items: $ref: '#/components/schemas/Duty' type: array 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 DutyReference: allOf: - $ref: '#/components/schemas/ObjectReference' - description: Referens till en Duty title: DutyReference SyllabusReference: allOf: - $ref: '#/components/schemas/ObjectReference' - description: Referens till en Syllabus title: SyllabusReference OrganisationReference: allOf: - $ref: '#/components/schemas/ObjectReference' - description: Referens till ett organisationselement. title: OrganisationReference ActivityReference: allOf: - $ref: '#/components/schemas/ObjectReference' - description: Referens till en aktivitet title: ActivityReference Group: allOf: - $ref: '#/components/schemas/GroupFragment' - $ref: '#/components/schemas/Group_allOf' Duty: description: referens till ett Dutyobjekt properties: id: description: Ett ID för tjänsten. format: uuid type: string meta: $ref: '#/components/schemas/Meta' person: $ref: '#/components/schemas/Duty_person' assignmentRole: description: >- 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. items: $ref: '#/components/schemas/Duty_assignmentRole_inner' type: array dutyAt: $ref: '#/components/schemas/OrganisationReference' dutyRole: allOf: - $ref: '#/components/schemas/DutyRole' - description: > Syfte med tjänsten, den roll tjänsen avser, till exempel lärare eller rektor. description: description: >- Arbetsområde. Kompletterande information till personalkategori, exempelvis Bibliotekarie. type: string signature: description: En signatur för tjänstgöringen exempelvis NJN, JOAN. type: string dutyPercent: description: Tjänstgöringsgrad i procent type: integer hoursPerYear: description: Antalet timmar tjänstgöringen omfattar under ett år. type: integer startDate: description: > Startdatum för personens anställning på en viss skolenhet eller skola (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande. format: date type: string endDate: description: > Slutdatum för personens anställning på en viss skolenhet eller skola (RFC 3339-format, e.g. "2016-10-15"). Inkluderande. format: date type: string required: - dutyAt - dutyRole - id - meta - startDate title: Duty 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 Duty_person: allOf: - $ref: '#/components/schemas/PersonReference' - description: Identifierare av person som tjänsten är knuten till. Duty_assignmentRole_inner: properties: group: $ref: '#/components/schemas/GroupReference' 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 required: - assignmentRoleType - group type: object DutyRole: description: >- Roller för en Duty. Förskolechef och Övriga pedagogisk personal är deprekerade och kommer tas bort till nästa version. enum: - 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 title: Code_DutyRole type: string 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 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 PersonReference: allOf: - $ref: '#/components/schemas/ObjectReference' - $ref: '#/components/schemas/PersonReference_1' 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 ````