Hämta en lista med tjänstgöringar.

Authorizations

Authorization

string

header

required

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

Query Parameters

organisation

string<uuid>

Begränsa urvalet till de tjänstgöringar som är kopplade till ett organisationselement eller underliggande element.

dutyRole

enum<string>

Begränsta urvalet till de tjänstgöringar som matchar roll Roller för en Duty. Förskolechef och Övriga pedagogisk personal är deprekerade och kommer tas bort till nästa version.

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

person

string<uuid>

Begränsa urvalet till de tjänstgöringar som är kopplade till person ID

startDate.onOrBefore

string<date>

Begränsa urvalet till tjänstgöringar 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 tjänstgöringar 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 tjänstgöringar 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 tjänstgöringar 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:

person

expandReferenceNames

boolean

Returnera displayName för alla refererade objekt.

sortkey

enum<string>

Anger hur resultatet ska sorteras.

Available options:

StartDateDesc,

StartDateAsc,

ModifiedDesc

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

Duty · object[]

required

Show child attributes

data.id

string<uuid>

required

Ett ID för tjänsten.

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

OrganisationReference · object

required

Referens till ett organisationselement.

Show child attributes

data.dutyAt.id

string<uuid>

required

data.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.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.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.person

PersonReference · object

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

Show child attributes

data.person.id

string<uuid>

required

data.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.person.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data.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.assignmentRole.group

GroupReference · object

required

Referens till en grupp

Show child attributes

data.assignmentRole.group.id

string<uuid>

required

data.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.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.assignmentRole.startDate

string<date>

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

data.assignmentRole.endDate

string<date>

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

data.description

string

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

data.signature

string

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

data.dutyPercent

integer

Tjänstgöringsgrad i procent

data.hoursPerYear

integer

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

data.endDate

string<date>

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

data._embedded

object

Show child attributes

data._embedded.person

object

Show child attributes

data._embedded.person.id

string<uuid>

required

Ett objekt ska ha samma överförings-ID mellan samtliga ingående system och således är det ett enda namespace för de gemensamma ID:na. Objektidentifikatorn är den nyckel som skall vara persistent mellan olika processer (enl figur 1).

data._embedded.person.meta

Meta · object

required

Show child attributes

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

string<date-time>

required

Example:

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

data._embedded.person.givenName

string

required

Förnamn.

data._embedded.person.familyName

string

required

Efternamn.

data._embedded.person.middleName

string

Mellannamn.

data._embedded.person.eduPersonPrincipalNames

string[]

De identifierare som ska användas för att identifiera användaren i skilda e-tjänster. Identifieraren ska vara en spårbar, persistent och globalt unik sträng. Den ska bestå av en lokalt unik användaridentifierare, ett '@' och en domän. En domän är ofta, men inte nödvändigtvis, samma som organisationens internet-domännamn. Exempel: [email protected]

data._embedded.person.externalIdentifiers

externalIdentifier · object[]

Show child attributes

data._embedded.person.externalIdentifiers.value

string

required

Identifierare för användaren.

data._embedded.person.externalIdentifiers.context

string

required

Anger för vilket sammanhang användaridentifieraren ska användas. Beskriv med en URI. Värdet kan överenskommas bilateralt mellan två integrerande parter.

Example:

"http://linkoping.se/AD"

data._embedded.person.externalIdentifiers.globallyUnique

boolean

required

Anger om identifieraren är så utformad att den kan anses vara globalt unik.

data._embedded.person.civicNo

object

Personnummer.

Show child attributes

data._embedded.person.civicNo.value

string

required

Svenskt personnummer, tilldelat personnummer eller Skatteverkets samordningsnummer för personen. Ska anges med 12 siffror utan separatorer. Exempel: 200112240123

Samordningsnummer ska anges med 12 siffror utan separator. Födelsedagen adderas med talet 60, det vill säga någon född den 24 i en månad får talet 84 som dag. Exempel: 200112840123

Saknas både personnummer och samordningsnummer så förekommer det att "tillfälligt personnummer" definieras i elevregistret. Dessa är möjliga att beskriva i detta fält och i så fall tillåts de två första positionerna efter datumdelen att vara bokstäver. Exempel: 20130101TF01

data._embedded.person.civicNo.nationality

string

default:SE

Landskod för det land som personnumret härstammar från, enligt ISO 3166-1 alpha-2.

Example:

{ "nationality": "SE", "value": "value" }

data._embedded.person.birthDate

string<date>

Födelsedatum (RFC 3339-format, t.ex. "2016-10-15")

data._embedded.person.sex

enum<string>

Biologiskt kön

Available options:

Man,

Kvinna,

Okänt

data._embedded.person.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data._embedded.person.personStatus

enum<string>

default:Aktiv

Anger ifall en person har en aktiv status eller en annan status, såsom utvandrad eller avliden.

Available options:

Aktiv,

Utvandrad,

Avliden

data._embedded.person.emails

Email · object[]

En lista med personens epostadresser

Show child attributes

data._embedded.person.emails.value

string<email>

required

data._embedded.person.emails.type

enum<string>

required

Available options:

Privat,

Skola elev,

Skola personal,

Arbete övrigt

data._embedded.person.phoneNumbers

Phonenumber · object[]

En lista med telefonnummer till personen.

Show child attributes

data._embedded.person.phoneNumbers.value

string

required

Telefonnumret.

data._embedded.person.phoneNumbers.type

enum<string>

required

Available options:

Hem,

Arbete

data._embedded.person.phoneNumbers.mobile

boolean

default:true

required

data._embedded.person.addresses

object[]

En lista med personens postadresser

Show child attributes

data._embedded.person.addresses.streetAddress

string

required

Gatuadress.

data._embedded.person.addresses.locality

string

required

Postort.

data._embedded.person.addresses.postalCode

string

required

Postadress.

data._embedded.person.addresses.country

string

required

Land.

data._embedded.person.addresses.type

enum<string>

default:Folkbokföring

Available options:

Folkbokföring,

Särskild postadress,

Tillfällig adress,

Postadress

data._embedded.person.addresses.countyCode

integer

Län, kod

data._embedded.person.addresses.municipalityCode

integer

Kommun, kod

data._embedded.person.addresses.realEstateDesignation

string

Fastighetsbeteckning

data._embedded.person.photo

string<uri>

Pekar ut en resurs med en bild på personen, specificeras som en URI enligt RFC 3986.

data._embedded.person.enrolments

Enrolment · object[]

En lista med inskrivningar för personen

Show child attributes

data._embedded.person.enrolments.enroledAt

OrganisationReference · object

required

Referens till ett organisationselement av typen skolenhet.

Show child attributes

data._embedded.person.enrolments.enroledAt.id

string<uuid>

required

data._embedded.person.enrolments.enroledAt.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.person.enrolments.schoolType

enum<string>

required

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.person.enrolments.startDate

string<date>

required

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

data._embedded.person.enrolments.schoolYear

integer

Värdet årskurs anger det år efter skolstarten för vilket en student följer undervisningen.

Required range: 0 <= x <= 10

data._embedded.person.enrolments.endDate

string<date>

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

data._embedded.person.enrolments.cancelled

boolean

Inskrivningen har avbrutits i förväg.

data._embedded.person.enrolments.educationCode

string

Studievägskod för den aktuella inskrivningen.

data._embedded.person.enrolments.specification

string

Kompletterande information angående innehåll i elevens utbildning, används som avgränsning av ett visst utbildningsalternativ för exempelvis lärlingsutbildning.

data._embedded.person.responsibles

object[]

Personens vårdnadshavare eller motsvarande relationer så som familjehemsförälder. Denna relation beskriver ett officiellt ansvarsförhållande.

Show child attributes

data._embedded.person.responsibles.person

PersonReference · object

Referens till en person

Show child attributes

data._embedded.person.responsibles.person.id

string<uuid>

required

data._embedded.person.responsibles.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.person.responsibles.person.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data._embedded.person.responsibles.relationType

enum<string>

Värdeförråd som skall användas för olika typer av relationer till ett barn eller en elev.

Available options:

Vårdnadshavare,

Annan ansvarig,

God man,

Utsedd behörig

Example:

{
  "personStatus": "Aktiv",
  "addresses": [
    {
      "country": "country",
      "countyCode": 0,
      "streetAddress": "streetAddress",
      "postalCode": "postalCode",
      "locality": "locality",
      "type": "Folkbokföring",
      "municipalityCode": 6,
      "realEstateDesignation": "realEstateDesignation"
    },
    {
      "country": "country",
      "countyCode": 0,
      "streetAddress": "streetAddress",
      "postalCode": "postalCode",
      "locality": "locality",
      "type": "Folkbokföring",
      "municipalityCode": 6,
      "realEstateDesignation": "realEstateDesignation"
    }
  ],
  "securityMarking": "Ingen",
  "givenName": "givenName",
  "sex": "Man",
  "photo": "https://openapi-generator.tech",
  "birthDate": "2000-01-23T00:00:00.000Z",
  "civicNo": { "nationality": "SE", "value": "value" },
  "phoneNumbers": [
    {
      "mobile": true,
      "type": "Hem",
      "value": "value"
    },
    {
      "mobile": true,
      "type": "Hem",
      "value": "value"
    }
  ],
  "externalIdentifiers": [
    {
      "globallyUnique": true,
      "context": "http://linkoping.se/AD",
      "value": "value"
    },
    {
      "globallyUnique": true,
      "context": "http://linkoping.se/AD",
      "value": "value"
    }
  ],
  "emails": [
    { "type": "Privat", "value": "value" },
    { "type": "Privat", "value": "value" }
  ],
  "eduPersonPrincipalNames": [
    "eduPersonPrincipalNames",
    "eduPersonPrincipalNames"
  ],
  "meta": {
    "created": "2000-01-23T04:56:07.000Z",
    "modified": "2000-01-23T04:56:07.000Z"
  },
  "familyName": "familyName",
  "middleName": "middleName",
  "enrolments": [
    {
      "endDate": "2000-01-23T00:00:00.000Z",
      "schoolType": null,
      "schoolYear": 1,
      "cancelled": true,
      "specification": "specification",
      "enroledAt": null,
      "educationCode": "educationCode",
      "programme": null,
      "startDate": "2000-01-23T00:00:00.000Z"
    },
    {
      "endDate": "2000-01-23T00:00:00.000Z",
      "schoolType": null,
      "schoolYear": 1,
      "cancelled": true,
      "specification": "specification",
      "enroledAt": null,
      "educationCode": "educationCode",
      "programme": null,
      "startDate": "2000-01-23T00:00:00.000Z"
    }
  ],
  "responsibles": [
    { "relationType": null, "person": null },
    { "relationType": null, "person": null }
  ],
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
}

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