spesielle datatyper fellesklasser og regler - Utdanningsdirektoratet/KL06-LK20-public GitHub Wiki

Denne siden er en del av Mer i dybden

Her har vi samlet det vi har kalt spesielle datatyper, fellesklasser og regler for å kunne effektivisere REST-dokumentasjonen som du finner listet opp i venstre kolonne på siden Liste over alle typene i Grep, slik at vi ikke trenger å gjenta dette over alt. Vi tenker dette også forenkler lesingen av dokumentene.

Hvis du har forslag til en enda bedre måte å organisere denne dokumentasjonen på, er vi takknemlig om du tar kontakt med oss.

2. Spesielle datatyper, fellesklasser og regler

2.1. Språkkoder

Beskrivelse

Språkkoder er i henhold til ISO 639-2 og ISO 639-3, alfa-3-kode (tre bokstaver).

2.2. Tidsstempel

Beskrivelse

Tidsstempel er i henhold til ISO 8601 ("yyyy-mm-ddThh:mm:ss[.mmmmmmm]").

2.3. Språkversjonert tekst

Beskrivelse

Språkversjonert tekst.

Attributter
Attributt Type Beskrivelse Multiplisitet
spraak URI/String ... 1
verdi String ... 1
Eksempel
{
	"spraak": "default",
	"verdi": "Læreplan i matematikk fellesfag"
},
{
	"spraak": "http://data.udir.no/kl06/nob",
	"verdi": "Læreplan i matematikk fellesfag"
}

2.4. Forskriftstekst

Beskrivelse

Språkversjonert forskriftstekst.
Det boolske attributtet (når det er satt til "true") angir at objektet det forekommer i har status som forskrift i læreplandokumentene. Læreplanene i Kunnskapsløftet KL06 og LK20, samt LK06S og LK20S (samisk) har status som forskrift til Opplæringsloven. De tekstobjektene som ikke har denne merkingen, er ikke en del av forskriften, men er redaksjonell hjelp og støtte til å forså læreplanen. Disse har ikke merking med boolsk "false" – vi merker kun de objektene med boolsk "true".
Se også "Forskrift" fra Ordliste.

Attributter
Attributt Type Beskrivelse Multiplisitet
tekst Array av Språkversjonert tekst ... 1..*
forskrift Boolean ... 1
Eksempel
{
	"tekst": [
		{
			"spraak": "default",
			"verdi": "Læreplan i matematikk fellesfag"
		},
		{
			"spraak": "http://data.udir.no/kl06/nob",
			"verdi": "Læreplan i matematikk fellesfag"
		}
	],
	"forskrift": true
}

2.5. Referanse

Beskrivelse

...

Attributter
Attributt Type Beskrivelse Multiplisitet
kode String Lokalt unik identifikator 1
uri URI Unik URL-basert identifikator 1
url-data URI Unik URL-basert lenke til detaljert informasjon om objektet det refereres til 1
tittel Array av Språkversjonert tekst/String Tittel 1..*
gyldighet gyldighet Objekt med "gydlig-fra" og "gyldig-til" som angir gyldighet for referansen/koblingen 1
id UUID eller URI Globalt unik identifikator 1
grep-type URI Angir hvilken type i Greps datamodell det refererte objektet er 1
status URI Angir om det refererte objektet er "publisert" (er gjeldende/gyldig) eller "utgått". 1
Merk at noen referanseobjekter kan mangle "gyldighet" der den ikke er aktuell.
Eksempel
{
	"kode": "K1",
	"uri": "http://test-psi.udir.no/kl06/K1",
	"url-data": "http://test-data.udir.no/kl06/K1",
	"tittel": [
		{
			"spraak": "default",
			"verdi": "ordne og sortere gjenstandar ut frå ulike eigenskapar og diskutere om dette kan gjerast på fleire måtar"
		},
		{
			"spraak": "http://test-data.udir.no/kl06/nob",
			"verdi": "ordne og sortere gjenstandar ut frå ulike eigenskapar og diskutere om dette kan gjerast på fleire måtar"
		}
	]
}

{
	"kode": "KE2",
	"uri": "http://test-psi.udir.no/kl06/KE2",
	"url-data": "http://test-data.udir.no/kl06/KE2",
	"tittel": "Utforsking og problemløsing"
}

2.5.1 Referansevariant uten egentlig type

Beskrivelse

Noen referanser ligner på referanser i avsnittet over ved at de har egenkapene uri og grep-type, men mangler ulr-data. Disse kjennestegnes også ved at de mangler uri-oppslag. I stedet er det som ville vært forventet som verdien til foekomsten av typen, erstattet med et språkversjonert tekstobjekt (array med objekter med egenskapene spraak og verdi). Se eksempelet nedenfor.

Attributter
Attributt Type Beskrivelse Multiplisitet
tittel Array av Språkversjonert tekst/String beskrivelse 1..*
uri URI Unik URL-basert identifikator 1
grep-type URI Angir en URI til grep-type 1
Eksempel fra programomraade, programomraade-type
"programomraade-type": {
	"beskrivelse": [
		{
			"spraak": "nob",
			"verdi": "Bedrift(Lærling)"
		},
		{	"spraak": "default",
			"verdi": "Bedrift(Lærling)"
		}
	],
	"uri": "http://psi.udir.no/kl06/programomraadetype_bedrift",
	"grep-type": "http://psi.udir.no/ontologi/kl06/programomraadetype"
},

2.6. Gyldighet

Beskrivelse

...

Attributter
Attributt Type Beskrivelse Multiplisitet
gyldig-fra Tidsstempel ... 1
gyldig-til Tidsstempel ... 0..1
Eksempel
{
	"gyldig-fra": "2015-08-01T00:00:00",
	"gyldig-til": "2018-08-01T00:00:00"
}
⚠️ **GitHub.com Fallback** ⚠️