Hämta en lista med personer.

Authorizations

Authorization

string

header

required

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

Query Parameters

nameContains

string[]

Begränsa urvalet till de personer vars namn innehåller något av parameterns värden. Sökningen ska ske shiftlägesokänsligt och värdet kan förekomma var som helst i något av alla tre namnfälten. Anges flera värden så måste samtliga värden matcha minst ett av namnfälten.

Exempel: [ "Pa", "gens" ] kommer matcha Palle Girgensohn.

civicNo

string

Begränsa urvalet till den person vars civicNo matchar parameterns värde.

eduPersonPrincipalName

string

Begränsa urvalet till den person vars eduPersonPrincipalNames matchar parameterns värde.

identifier.value

string

Begränsa urvalet till den person vilka har ett värde i externalIdentifiers.value som matchar parameterns värde. Kan kombineras med parametern identifier.context för att begränsa matchningen till en specifik typ av indentifierare.

identifier.context

string

Begränsa urvalet till den person vilka har ett värde i externalIdentifiers.context som matchar parameterns värde. Kombineras vanligtvis med identifier.value parametern.

relationship.entity.type

enum<string>

Begränsa urvalet till de personer som har en denna typ av relation till andra entititeter. Denna parameter styr vilket entitetstyp som övriga relationship-parametrar filterar på. Anges inga andra parametrar så returneras personer som har en relation av denna typ.

Möjliga relationer:

enrolment - filtrerar utifrån elever inskrivning.
duty - filtrerar utifrån personer som har minst en tjänstgöring.
placement.child - filtrerar utifrån barn som har minst en placering.
placement.owner - filtrerar utifrån personer som satta som ägare av minst en placering.
responsibleFor.enrolment - filterar utifrån personer som har en "responsibleFor"-relation, dvs är en vårdnadshavare eller annan ansvarig vuxen, till en elev med minst en inskrivning.
responsibleFor.placement - filterar utifrån personer som har en "responsibleFor"-relation, dvs är en vårdnadshavare eller annan ansvarig vuxen, till ett barn med minst en placering. Notera att oftast är det bättre att använda placement.owner än denna parameter.
groupMembership - filtrerar utifrån gruppmedlemsskap

Detta kan kombineras med relationship.startDate.onOrBefore och relationship.endDate.onOrAfter för att begränsa till aktiva relationer.

Available options:

enrolment,

duty,

placement.child,

placement.owner,

responsibleFor.enrolment,

responsibleFor.placement,

groupMembership

relationship.organisation

string<uuid>

Begränsa urvalet till de personer som har en relation till angivet organisationselement (vanligtvis en skolenhet). För att begränsa till en viss relationtyp används parametern relationship.entity.type.

Följande fält/relationer används vid filtreringen:

enrolment - poster matchandes person.enrolment.enroledAt
duty - person poster matchandes duty.person i en lista filtrerad utifrån duty.dutyAt.
placement.child - person poster matchandes placement.child i en lista filtrerad utifrån placement.placedAt.
placement.owner - person poster matchandes placement.owner i en lista filtrerad utifrån placement.placedAt.
responsibleFor.enrolment - person poster matchandes person.responsibles i en lista filtrerad utifrån person.enrolment.enroledAt.
responsibleFor.placement - person poster matchandes person.responsibles i en lista med person poster som i sin tur matchar placement.child i en lista filtrerad utifrån placement.placedAt.
groupMembership - person poster matchandes person.groupMemberships

relationship.startDate.onOrBefore

string<date>

Begränsa urvalet av personer till de som har relationer med startDate innan eller på det angivna datumet (RFC 3339-format, t.ex. "2016-10-15"). Poster med ett startDate som ej är satt, tas alltid med. För att begränsa till en viss relationtyp används parametern relationship.entity.type.

Följande fält/relationer används vid filtreringen:

enrolment - poster matchandes person.enrolment.startDate
duty - person poster matchandes duty.person i en lista filtrerad utifrån duty.startDate.
placement.child - person poster matchandes placement.child i en lista filtrerad utifrån placement.startDate.
placement.owner - person poster matchandes placement.owner i en lista filtrerad utifrån placement.startDate.
responsibleFor.enrolment - person poster matchandes person.responsibles i en lista filtrerad utifrån person.enrolment.startDate.
responsibleFor.placement - person poster matchandes person.responsibles i en lista med person poster som i sin tur matchar placement.child i en lista filtrerad utifrån placement.startDate.
groupMembership - poster matchandes group.groupMemberships.person eller group.assignmentRole.duty.person i en lista filtrerad utifrån group.groupMemberships.startDate eller group.assignmentRole.startDate.

Detta kan kombineras med relationship.endDate.onOrAfter för att begränsa till aktiva relationer.

relationship.startDate.onOrAfter

string<date>

Begränsa urvalet av personer till de som har relationer med startDate efter eller på det angivna datumet (RFC 3339-format, t.ex. "2016-10-15"). Poster med ett startDate som ej är satt, tas alltid med. För att begränsa till en viss relationtyp används parametern relationship.entity.type.

Följande fält/relationer används vid filtreringen:

enrolment - poster matchandes person.enrolment.startDate
duty - person poster matchandes duty.person i en lista filtrerad utifrån duty.startDate.
placement.child - person poster matchandes placement.child i en lista filtrerad utifrån placement.startDate.
placement.owner - person poster matchandes placement.owner i en lista filtrerad utifrån placement.startDate.
responsibleFor.enrolment - person poster matchandes person.responsibles i en lista filtrerad utifrån person.enrolment.startDate.
responsibleFor.placement - person poster matchandes person.responsibles i en lista med person poster som i sin tur matchar placement.child i en lista filtrerad utifrån placement.startDate.
groupMembership - poster matchande group.groupMemberships.person eller group.assignmentRole.duty.person i en lista filtrerad utifrån group.groupMemberships.startDate eller group.assignmentRole.startDate.

relationship.endDate.onOrBefore

string<date>

Begränsa urvalet av personer till de som har relationer med endDate 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. För att begränsa till en viss relationtyp används parametern relationship.entity.type.

Följande fält/relationer används vid filtreringen:

enrolment - poster matchandes person.enrolment.endDate
duty - person poster matchandes duty.person i en lista filtrerad utifrån duty.endDate.
placement.child - person poster matchandes placement.child i en lista filtrerad utifrån placement.endDate.
placement.owner - person poster matchandes placement.owner i en lista filtrerad utifrån placement.endDate.
responsibleFor.enrolment - person poster matchandes person.responsibles i en lista filtrerad utifrån person.enrolment.endDate.
responsibleFor.placement - person poster matchandes person.responsibles i en lista med person poster som i sin tur matchar placement.child i en lista filtrerad utifrån placement.endDate.
groupMembership - poster matchande group.groupMemberships.person eller group.assignmentRole.duty.person i en lista filtrerad utifrån group.groupMemberships.endDate eller group.assignmentRole.endDate.

relationship.endDate.onOrAfter

string<date>

Begränsa urvalet av personer till de som har relationer med endDate efter eller på det angivna datumet (RFC 3339-format,t.ex. "2016-10-15"). Poster med ett endDate som ej är satt, tas alltid med. För att begränsa till en viss relationtyp används parametern relationship.entity.type.

Flöjande fält/relationer används vid filtreringen:

enrolment - poster matchandes person.enrolment.endDate
duty - person poster matchandes duty.person i en lista filtrerad utifrån duty.endDate.
placement.child - person poster matchandes placement.child i en lista filtrerad utifrån placement.endDate.
placement.owner - person poster matchandes placement.owner i en lista filtrerad utifrån placement.endDate.
responsibleFor.enrolment - person poster matchandes person.responsibles i en lista filtrerad utifrån person.enrolment.endDate.
responsibleFor.placement - person poster matchandes person.responsibles i en lista med person poster som i sin tur matchar placement.child i en lista filtrerad utifrån placement.endDate.
groupMembership - poster matchande group.groupMemberships.person eller group.assignmentRole.duty.person i en lista filtrerad utifrån group.groupMemberships.endDate eller group.assignmentRole.endDate.

Detta kan kombineras med relationship.startDate.onOrBefore för att begränsa till aktiva relationer.

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:

duties,

responsibleFor,

placements,

ownedPlacements,

groupMemberships

expandReferenceNames

boolean

Returnera displayName för alla refererade objekt.

sortkey

enum<string>

Anger hur resultatet ska sorteras.

Available options:

ModifiedDesc,

DisplayNameAsc

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

object[]

required

Show child attributes

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

string

required

Förnamn.

data.familyName

string

required

Efternamn.

data.middleName

string

Mellannamn.

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

externalIdentifier · object[]

Show child attributes

data.externalIdentifiers.value

string

required

Identifierare för användaren.

data.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.externalIdentifiers.globallyUnique

boolean

required

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

data.civicNo

object

Personnummer.

Show child attributes

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

string<date>

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

data.sex

enum<string>

Biologiskt kön

Available options:

Man,

Kvinna,

Okänt

data.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

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

Email · object[]

En lista med personens epostadresser

Show child attributes

data.emails.value

string<email>

required

data.emails.type

enum<string>

required

Available options:

Privat,

Skola elev,

Skola personal,

Arbete övrigt

data.phoneNumbers

Phonenumber · object[]

En lista med telefonnummer till personen.

Show child attributes

data.phoneNumbers.value

string

required

Telefonnumret.

data.phoneNumbers.type

enum<string>

required

Available options:

Hem,

Arbete

data.phoneNumbers.mobile

boolean

default:true

required

data.addresses

object[]

En lista med personens postadresser

Show child attributes

data.addresses.streetAddress

string

required

Gatuadress.

data.addresses.locality

string

required

Postort.

data.addresses.postalCode

string

required

Postadress.

data.addresses.country

string

required

Land.

data.addresses.type

enum<string>

default:Folkbokföring

Available options:

Folkbokföring,

Särskild postadress,

Tillfällig adress,

Postadress

data.addresses.countyCode

integer

Län, kod

data.addresses.municipalityCode

integer

Kommun, kod

data.addresses.realEstateDesignation

string

Fastighetsbeteckning

data.photo

string<uri>

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

data.enrolments

Enrolment · object[]

En lista med inskrivningar för personen

Show child attributes

data.enrolments.enroledAt

OrganisationReference · object

required

Referens till ett organisationselement av typen skolenhet.

Show child attributes

data.enrolments.enroledAt.id

string<uuid>

required

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

string<date>

required

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

data.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.enrolments.endDate

string<date>

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

data.enrolments.cancelled

boolean

Inskrivningen har avbrutits i förväg.

data.enrolments.educationCode

string

Studievägskod för den aktuella inskrivningen.

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

PersonReference · object

Referens till en person

Show child attributes

data.responsibles.person.id

string<uuid>

required

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

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

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

data._embedded

object

Show child attributes

data._embedded.responsibleFor

object[]

De barn/barnen vilka personen har ansvar för.

Show child attributes

data._embedded.responsibleFor.person

PersonReference · object

Referens till en person

Show child attributes

data._embedded.responsibleFor.person.id

string<uuid>

required

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

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data._embedded.responsibleFor.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

data._embedded.placements

Placement · object[]

En lista med placeringar för personen.

Show child attributes

data._embedded.placements.id

string<uuid>

required

data._embedded.placements.meta

Meta · object

required

Show child attributes

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

string<date-time>

required

Example:

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

data._embedded.placements.placedAt

OrganisationReference · object

required

Skolenhet där barnet är placerat.

Show child attributes

data._embedded.placements.placedAt.id

string<uuid>

required

data._embedded.placements.placedAt.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.placements.child

PersonReference · object

required

Identifierare av person som placeringen avser.

Show child attributes

data._embedded.placements.child.id

string<uuid>

required

data._embedded.placements.child.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.placements.child.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data._embedded.placements.schoolType

enum<string>

required

Skolform för placeringen, förskola eller fritidshem

Available options:

FS,

FTH,

OPPFTH

data._embedded.placements.startDate

string<date>

required

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

data._embedded.placements.group

GroupReference · object

Barngrupp eller avdelning knutet till denna placering.

Show child attributes

data._embedded.placements.group.id

string<uuid>

required

data._embedded.placements.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._embedded.placements.owners

PersonReference · object[]

En lista med identifierare för de personer som äger placeringen. Används primärt för att styra vilka som skall kunna se och lägga schema.

Show child attributes

data._embedded.placements.owners.id

string<uuid>

required

data._embedded.placements.owners.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.placements.owners.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data._embedded.placements.endDate

string<date>

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

data._embedded.placements.reason

enum<string>

En kod för att beskriva orsak för placeringen.

Available options:

Omsorgsbehov,

Erbjuden tid,

Eget behov

data._embedded.placements.maxWeeklyScheduleHours

integer

Anger maximal schematid per vecka för barnets placering.

data._embedded.ownedPlacements

Placement · object[]

En lista med placeringar där personen är satt som ägare.

Show child attributes

data._embedded.ownedPlacements.id

string<uuid>

required

data._embedded.ownedPlacements.meta

Meta · object

required

Show child attributes

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

string<date-time>

required

Example:

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

data._embedded.ownedPlacements.placedAt

OrganisationReference · object

required

Skolenhet där barnet är placerat.

Show child attributes

data._embedded.ownedPlacements.placedAt.id

string<uuid>

required

data._embedded.ownedPlacements.placedAt.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.ownedPlacements.child

PersonReference · object

required

Identifierare av person som placeringen avser.

Show child attributes

data._embedded.ownedPlacements.child.id

string<uuid>

required

data._embedded.ownedPlacements.child.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.ownedPlacements.child.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data._embedded.ownedPlacements.schoolType

enum<string>

required

Skolform för placeringen, förskola eller fritidshem

Available options:

FS,

FTH,

OPPFTH

data._embedded.ownedPlacements.startDate

string<date>

required

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

data._embedded.ownedPlacements.group

GroupReference · object

Barngrupp eller avdelning knutet till denna placering.

Show child attributes

data._embedded.ownedPlacements.group.id

string<uuid>

required

data._embedded.ownedPlacements.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._embedded.ownedPlacements.owners

PersonReference · object[]

En lista med identifierare för de personer som äger placeringen. Används primärt för att styra vilka som skall kunna se och lägga schema.

Show child attributes

data._embedded.ownedPlacements.owners.id

string<uuid>

required

data._embedded.ownedPlacements.owners.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.ownedPlacements.owners.securityMarking

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

data._embedded.ownedPlacements.endDate

string<date>

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

data._embedded.ownedPlacements.reason

enum<string>

En kod för att beskriva orsak för placeringen.

Available options:

Omsorgsbehov,

Erbjuden tid,

Eget behov

data._embedded.ownedPlacements.maxWeeklyScheduleHours

integer

Anger maximal schematid per vecka för barnets placering.

data._embedded.duties

Duty · object[]

Personens aktuella tjänstgöring

Show child attributes

data._embedded.duties.id

string<uuid>

required

Ett ID för tjänsten.

data._embedded.duties.meta

Meta · object

required

Show child attributes

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

string<date-time>

required

Example:

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

data._embedded.duties.dutyAt

OrganisationReference · object

required

Referens till ett organisationselement.

Show child attributes

data._embedded.duties.dutyAt.id

string<uuid>

required

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

PersonReference · object

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

Show child attributes

data._embedded.duties.person.id

string<uuid>

required

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

enum<string>

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

Available options:

Ingen,

Sekretessmarkering,

Skyddad folkbokföring

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

GroupReference · object

required

Referens till en grupp

Show child attributes

data._embedded.duties.assignmentRole.group.id

string<uuid>

required

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

string<date>

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

data._embedded.duties.assignmentRole.endDate

string<date>

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

data._embedded.duties.description

string

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

data._embedded.duties.signature

string

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

data._embedded.duties.dutyPercent

integer

Tjänstgöringsgrad i procent

data._embedded.duties.hoursPerYear

integer

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

data._embedded.duties.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.groupMemberships

object[]

En lista med grupper där personen är medlem i

Show child attributes

data._embedded.groupMemberships.group

Group · object

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.

Show child attributes

data._embedded.groupMemberships.group.id

string<uuid>

required

Identifierare för gruppen

data._embedded.groupMemberships.group.meta

Meta · object

required

Show child attributes

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

string<date-time>

required

Example:

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

data._embedded.groupMemberships.group.displayName

string

required

Gruppens benämning.

data._embedded.groupMemberships.group.startDate

string<date>

required

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

data._embedded.groupMemberships.group.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

data._embedded.groupMemberships.group.organisation

OrganisationReference · object

required

Referens till ett organisationselement.

Show child attributes

data._embedded.groupMemberships.group.organisation.id

string<uuid>

required

data._embedded.groupMemberships.group.organisation.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.groupMemberships.group.endDate

string<date>

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

data._embedded.groupMemberships.group.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

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"
}

data._embedded.groupMemberships.startDate

string<date>

Startdatum för personens medlemskap i gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.

data._embedded.groupMemberships.endDate

string<date>

Slutdatum för personens medlemskap i gruppen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.

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