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

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 barn som har en placering (placedAt) på angivet organisationselement. Detta kan kombineras med startDate.onOrBefore och endDate.onOrAfter för att begränsa till aktiva placeringar.

group
string<uuid>

Begränsa urvalet till de barn som har en placering på angiven grupp. Detta kan kombineras med startDate.onOrBefore och endDate.onOrAfter för att begränsa till aktiva placeringar.

startDate.onOrBefore
string<date>

Begränsa urvalet till placeringar 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 placeringar 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 placeringar 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 placeringar 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.

child
string<uuid>

Begränsa urvalet till ett barn. Detta kan kombineras med startDate.onOrBefore och endDate.onOrAfter för att begränsa till aktiva placeringar.

owner
string<uuid>

Begränsa urvalet till placeringar med denna ägare. Detta kan kombineras med startDate.onOrAfter och endDate.onOrBefore för att begränsa till aktiva placeringar.

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:
child,
owners
expandReferenceNames
boolean

Returnera displayName för alla refererade objekt.

sortkey
enum<string>

Anger hur resultatet ska sorteras.

Available options:
StartDateAsc,
StartDateDesc,
EndDateAsc,
EndDateDesc,
ModifiedDesc
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.

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

Response

Anropet lyckades.

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