curl --request GET \
--url https://ss12000.staging.meitner.se/api/v1/placements \
--header 'Authorization: Bearer <token>'{
"data": [
null,
null
],
"pageToken": "pageToken"
}curl --request GET \
--url https://ss12000.staging.meitner.se/api/v1/placements \
--header 'Authorization: Bearer <token>'{
"data": [
null,
null
],
"pageToken": "pageToken"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
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.
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.
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").
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").
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.
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.
Begränsa urvalet till ett barn. Detta kan kombineras med startDate.onOrBefore och endDate.onOrAfter för att begränsa till aktiva placeringar.
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.
Endast poster skapade på eller före detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Inkluderande.
Endast poster skapade efter detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Exkluderande.
Endast poster modifierade på eller före detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Inkluderande.
Endast poster modifierade efter detta timestamp (RFC 3339 format, tex "2015-12-12T10:30:00+01:00"). Exkluderande.
Beskriver om expanderade data ska hämtas
child, owners Returnera displayName för alla refererade objekt.
Anger hur resultatet ska sorteras.
StartDateAsc, StartDateDesc, EndDateAsc, EndDateDesc, ModifiedDesc 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.
Antal poster som ska visas i resultatet. Utelämnas det så returnas så många poster som möjligt av servern, se pageToken.
x >= 1Anropet lyckades.
Show child attributes
Show child attributes
Datum och tid för när entiteten skapades (RFC 3339 format tex "2015-12-12T10:30:00+01:00").
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.
{
"created": "2000-01-23T04:56:07.000Z",
"modified": "2000-01-23T04:56:07.000Z"
}Identifierare av person som placeringen avser.
Show child attributes
Namn för visningsyfte för det refererade objektet. Skall endast returneras när query parametern expandReferenceNames är satt till "true".
Återspeglar värdet från folkbokföringsregistret.
Ingen, Sekretessmarkering, Skyddad folkbokföring Skolform för placeringen, förskola eller fritidshem
FS, FTH, OPPFTH Startdatum för placeringen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.
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
Namn för visningsyfte för det refererade objektet. Skall endast returneras när query parametern expandReferenceNames är satt till "true".
Återspeglar värdet från folkbokföringsregistret.
Ingen, Sekretessmarkering, Skyddad folkbokföring Slutdatum för placeringen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.
En kod för att beskriva orsak för placeringen.
Omsorgsbehov, Erbjuden tid, Eget behov Anger maximal schematid per vecka för barnets placering.
Show child attributes
Show child attributes
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).
Show child attributes
Datum och tid för när entiteten skapades (RFC 3339 format tex "2015-12-12T10:30:00+01:00").
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.
{
"created": "2000-01-23T04:56:07.000Z",
"modified": "2000-01-23T04:56:07.000Z"
}Förnamn.
Efternamn.
Mellannamn.
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]
Show child attributes
Identifierare för användaren.
Anger för vilket sammanhang användaridentifieraren ska användas. Beskriv med en URI. Värdet kan överenskommas bilateralt mellan två integrerande parter.
"http://linkoping.se/AD"
Anger om identifieraren är så utformad att den kan anses vara globalt unik.
Personnummer.
Show child attributes
Svenskt personnummer, tilldelat personnummer eller Skatteverkets samordningsnummer för personen. Ska anges med 12 siffror utan separatorer. Exempel: 200112240123
Samordningsnummer ska anges med 12 siffror utan separator. Födelsedagen adderas med talet 60, det vill säga någon född den 24 i en månad få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
Landskod för det land som personnumret härstammar från, enligt ISO 3166-1 alpha-2.
{ "nationality": "SE", "value": "value" }Födelsedatum (RFC 3339-format, t.ex. "2016-10-15")
Biologiskt kön
Man, Kvinna, Okänt Återspeglar värdet från folkbokföringsregistret.
Ingen, Sekretessmarkering, Skyddad folkbokföring Anger ifall en person har en aktiv status eller en annan status, såsom utvandrad eller avliden.
Aktiv, Utvandrad, Avliden En lista med personens postadresser
Show child attributes
Gatuadress.
Postort.
Postadress.
Land.
Folkbokföring, Särskild postadress, Tillfällig adress, Postadress Län, kod
Kommun, kod
Fastighetsbeteckning
Pekar ut en resurs med en bild på personen, specificeras som en URI enligt RFC 3986.
En lista med inskrivningar för personen
Show child attributes
Referens till ett organisationselement av typen skolenhet.
Följande värden används för att beskriva skolform:
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 Startdatum för inskrivningen (RFC 3339-format, t.ex. "2016-10-15").Inkluderande.
Värdet årskurs anger det år efter skolstarten för vilket en student följer undervisningen.
0 <= x <= 10Slutdatum för inskrivningen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.
Inskrivningen har avbrutits i förväg.
Studievägskod för den aktuella inskrivningen.
Kompletterande information angående innehåll i elevens utbildning, används som avgränsning av ett visst utbildningsalternativ för exempelvis lärlingsutbildning.
Personens vårdnadshavare eller motsvarande relationer så som familjehemsförälder. Denna relation beskriver ett officiellt ansvarsförhållande.
Show child attributes
Referens till en person
Show child attributes
Namn för visningsyfte för det refererade objektet. Skall endast returneras när query parametern expandReferenceNames är satt till "true".
Återspeglar värdet från folkbokföringsregistret.
Ingen, Sekretessmarkering, Skyddad folkbokföring Värdeförråd som skall användas för olika typer av relationer till ett barn eller en elev.
Vårdnadshavare, Annan ansvarig, God man, Utsedd behörig {
"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"
}Show child attributes
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).
Show child attributes
Datum och tid för när entiteten skapades (RFC 3339 format tex "2015-12-12T10:30:00+01:00").
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.
{
"created": "2000-01-23T04:56:07.000Z",
"modified": "2000-01-23T04:56:07.000Z"
}Förnamn.
Efternamn.
Mellannamn.
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]
Show child attributes
Identifierare för användaren.
Anger för vilket sammanhang användaridentifieraren ska användas. Beskriv med en URI. Värdet kan överenskommas bilateralt mellan två integrerande parter.
"http://linkoping.se/AD"
Anger om identifieraren är så utformad att den kan anses vara globalt unik.
Personnummer.
Show child attributes
Svenskt personnummer, tilldelat personnummer eller Skatteverkets samordningsnummer för personen. Ska anges med 12 siffror utan separatorer. Exempel: 200112240123
Samordningsnummer ska anges med 12 siffror utan separator. Födelsedagen adderas med talet 60, det vill säga någon född den 24 i en månad få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
Landskod för det land som personnumret härstammar från, enligt ISO 3166-1 alpha-2.
{ "nationality": "SE", "value": "value" }Födelsedatum (RFC 3339-format, t.ex. "2016-10-15")
Biologiskt kön
Man, Kvinna, Okänt Återspeglar värdet från folkbokföringsregistret.
Ingen, Sekretessmarkering, Skyddad folkbokföring Anger ifall en person har en aktiv status eller en annan status, såsom utvandrad eller avliden.
Aktiv, Utvandrad, Avliden En lista med personens postadresser
Show child attributes
Gatuadress.
Postort.
Postadress.
Land.
Folkbokföring, Särskild postadress, Tillfällig adress, Postadress Län, kod
Kommun, kod
Fastighetsbeteckning
Pekar ut en resurs med en bild på personen, specificeras som en URI enligt RFC 3986.
En lista med inskrivningar för personen
Show child attributes
Referens till ett organisationselement av typen skolenhet.
Följande värden används för att beskriva skolform:
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 Startdatum för inskrivningen (RFC 3339-format, t.ex. "2016-10-15").Inkluderande.
Värdet årskurs anger det år efter skolstarten för vilket en student följer undervisningen.
0 <= x <= 10Slutdatum för inskrivningen (RFC 3339-format, t.ex. "2016-10-15"). Inkluderande.
Inskrivningen har avbrutits i förväg.
Studievägskod för den aktuella inskrivningen.
Kompletterande information angående innehåll i elevens utbildning, används som avgränsning av ett visst utbildningsalternativ för exempelvis lärlingsutbildning.
Personens vårdnadshavare eller motsvarande relationer så som familjehemsförälder. Denna relation beskriver ett officiellt ansvarsförhållande.
Show child attributes
Referens till en person
Show child attributes
Namn för visningsyfte för det refererade objektet. Skall endast returneras när query parametern expandReferenceNames är satt till "true".
Återspeglar värdet från folkbokföringsregistret.
Ingen, Sekretessmarkering, Skyddad folkbokföring Värdeförråd som skall användas för olika typer av relationer till ett barn eller en elev.
Vårdnadshavare, Annan ansvarig, God man, Utsedd behörig Om värdet är null finns inget mer att hämta på det token som skickades in som query parameter.