Skip to main content
POST
Hämta många personer baserat på en lista av ID:n eller personnummer.

Authorizations

Authorization
string
header
required

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

Query Parameters

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.

Body

application/json

En lista med personnummer och / eller uuid:n på personer.

ids
string<uuid>[]
civicNos
string[]

Personnummer, samordningsnummer eller tillfälliga personnummer, och motsvarande för andra länder. För svenska personnummner ska formatet 12 tecken utan divis användas. Se exempel.

Response

Anropet lyckades.

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

meta
Meta · object
required
read-only
Example:
givenName
string
required

Förnamn.

familyName
string
required

Efternamn.

middleName
string

Mellannamn.

eduPersonPrincipalNames
string[]

De identifierare som ska användas för att identifiera användaren i skilda e-tjänster. Identifieraren ska vara en spårbar, persistent och globalt unik sträng. Den ska bestå av en lokalt unik användaridentifierare, ett '@' och en domän. En domän är ofta, men inte nödvändigtvis, samma som organisationens internet-domännamn. Exempel: kalko@edu.goteborg.se

externalIdentifiers
externalIdentifier · object[]
civicNo
object

Personnummer.

Example:
birthDate
string<date>

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

sex
enum<string>

Biologiskt kön

Available options:
Man,
Kvinna,
Okänt
securityMarking
enum<string>

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

Available options:
Ingen,
Sekretessmarkering,
Skyddad folkbokföring
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
emails
Email · object[]

En lista med personens epostadresser

phoneNumbers
Phonenumber · object[]

En lista med telefonnummer till personen.

addresses
object[]

En lista med personens postadresser

photo
string<uri>

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

enrolments
Enrolment · object[]

En lista med inskrivningar för personen

responsibles
object[]

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

_embedded
object