Skip to main content
GET
/
persons
Hämta en lista med personer.
curl --request GET \
  --url https://ss12000.staging.meitner.se/api/v1/persons \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    null,
    null
  ],
  "pageToken": "pageToken"
}

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.

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
​
pageToken
string | null

Om värdet är null finns inget mer att hämta på det token som skickades in som query parameter.