Skip to content

Commit 59da79a

Browse files
committed
Added API documentation
1 parent eeab61e commit 59da79a

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

description.md

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,17 +38,21 @@ has_children: false
3838

3939
[3.9 Brugergrænsefladen](#brugergrænsefladen)
4040

41-
[3.10 Årsrul](#årsrul)
41+
[3.10 API'er](#apier)
42+
[3.10.1 Import API](#Import-API)
43+
[3.10.2 API til primært tilhørsforhold](#API-til-primært-tilhørsforhold)
4244

43-
[3.11 Grupper](#grupper)
45+
[3.11 Årsrul](#årsrul)
4446

45-
[3.12 Logning](#logning-1)
47+
[3.12 Grupper](#grupper)
4648

47-
[3.13 Dokumentation](#dokumentation)
49+
[3.13 Logning](#logning-1)
4850

49-
[3.14 Udviklings- og leverancemodel](#udviklings--og-leverancemodel)
51+
[3.14 Dokumentation](#dokumentation)
5052

51-
[3.15 Migrering fra eksisterende løsning](#migrering-fra-eksisterende-løsning)
53+
[3.15 Udviklings- og leverancemodel](#udviklings--og-leverancemodel)
54+
55+
[3.16 Migrering fra eksisterende løsning](#migrering-fra-eksisterende-løsning)
5256

5357
# Indledning
5458

@@ -357,6 +361,23 @@ I brugergrænsefladen kan man
357361

358362
- Kunstige institutioner. Hvis denne er slået til, er der mulighed for at oprette kunstige institutioner via brugergrænsefladen. Det vil sige institutioner, der ikke eksisterer i STIL og derfor ikke indgår i STIl sync'en. Disse kunstige institutioner kan fx bruges til at placere apiOnly brugere fra import-API'et på.
359363

364+
- Primære institutioner. Det er muligt for administratorer at tilgå siden, og vælge en primær institution for brugere, der er tilknyttet flere institutioner. At en institution er primær, betyder at brugeren vil blive placeret under den institution.
365+
366+
## API'er
367+
Der findes en række api'er til OS2skoledata. De fleste er til intern brug til klienterne/integrationerne.
368+
369+
### Import API
370+
ImportAPI kan bruges af kommunerne til at indlæse data i OS2skoledata for at supplere data fra STIL. Dokumentation for det API kan findes på kommunens OS2skoledata side https://kommune.os2skoledata.dk/swagger-ui/index.html. For at anvende API'et skal Digital Identity kontaktes, da kommunens konfiguration skal ændres, så den er klar til at modtage data via API'et
371+
372+
### API til primært tilhørsforhold
373+
Derudover er der et API til at sætte primært tilhørsforhold. Der findes to post endpoints. Et hvor man kan hente primær institution på en bruger og et hvor man kan sætte det.
374+
375+
Hent primært tilhørsforhold:
376+
POST https://kommune.os2skoledata.dk/api/primaryinstitution/lookup med body {"cpr" : "0123456789"}
377+
378+
Sæt primært tilhørsforhold:
379+
POST https://kommune.os2skoledata.dk/api/primaryinstitution med body {"cpr" : "0123456789", "institutionNumber" : "R01234"}
380+
360381
## Årsrul
361382

362383
Ved årsrul beholdes enheder, grupper, drev og teams så vidt muligt. Der laves et decideret rul, så hvis OS2skoledata kan matche den gamle klasse med en ny klasse, vil navnet bare blive ændret - fx 2A i 23/24 til 3A i 24/25.\

0 commit comments

Comments
 (0)