Skip to main content
POST
/
persons
/
lookup
Hämta många personer baserat på en lista av ID:n eller personnummer.
curl --request POST \
  --url https://ss12000.staging.meitner.se/api/v1/persons/lookup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "d544563a-747a-42d3-8d37-415a101537fa"
  ],
  "civicNos": [
    "201002037271"
  ]
}
'
[
  {
    "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"
  }
]

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
Example:
{
  "created": "2000-01-23T04:56:07.000Z",
  "modified": "2000-01-23T04:56:07.000Z"
}
​
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: [email protected]

​
externalIdentifiers
externalIdentifier · object[]
​
civicNo
object

Personnummer.

Example:
{ "nationality": "SE", "value": "value" }
​
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