Introduktion
Importservice bruges til at oprette, opdatere og slette materialer i Materialeplatformen.
Formålet med servicen er at understøtte udveksling af data om materialer mellem en producents eller et forlags eget system og Materialeplatformen.
Servicen udstilles gennem STIL's integrationsplatform IP-Ung. Du kan læse mere om platformen IP-Ung via dette link.
Operationer
Herunder er en beskrivelse af de forskellige operationer, der findes i importservicen. En mere detaljeret beskrivelse af de forskellige operationer findes længere nede på siden.
Operation | Beskrivelse |
---|---|
CreateMateriale | Opretter et nyt materiale |
DeleteMateriale | Sletter et materiale |
GetAllMateriales | Henter alle materialer, der er oprettet af producenten |
GetKlassifikations | Henter alle klassifikationskoder og -navne |
UpdateMateriale | Opdaterer et allerede oprettet materiale |
Ping | Pinger servicen |
Alle operationer undtagen Ping indeholder et Identifier-tag, som har to underliggende tags, der kan bruges til at angive et systemnavn og en unik nøgle for kaldet.
<v1:Identifier> <v1:SystemName>En tekststreng der identificerer det kaldende system (dit system)</v1:SystemName> <v1:SystemTransactionID>En tekststreng der unikt identificerer det enkelte kald, f.eks. en GUID/UUID</v1:SystemTransactionID> </v1:Identifier>
CreateMateriale
Denne operation bruges til at oprette nye materialer.
Tag | Niveau | Type | Obligatorisk | Beskrivelse |
---|---|---|---|---|
Materiale | 1 | - | Ja | Overordnet tag for materialet |
Titel | 2 | 500 tegn | Ja | Materialets titel |
Beskrivelse | 2 | 4000 tegn | Ja | Beskrivelse af materialet |
EmneordListe | 2 | - | Ja | Overordnet tag til liste af emneord |
Emneord | 3 | 50 tegn | Ja, min. 1 | Tag til emneord for materialet |
BidragyderListe | 2 | - | Ja | Overordnet tag til liste af bidragydere |
Bidragyder | 3 | - | Ja, min. 1 | Overordnet tag til bidragyder |
Navn | 4 | 600 tegn | Ja | Navn på bidragyder |
Rolle | 4 | Faste værdier | Ja | Typen af bidragyder, fast liste jf. DK-LOM v1.1, f.eks. ”forfatter”, ”illustrator” mv. |
MaterialetypeListe | 2 | - | Ja | Overordnet tag til materialetyper |
Materialetype | 3 | Faste værdier | Ja, min. 1 | Materialetype, fast liste jf. DK-LOM v1.1, f.eks. ”bog”, ”av-materiale” mv. |
IndholdstypeListe | 2 | - | Ja | Overordnet tag til indholdstype |
Indholdstype | 3 | Faste værdier | Ja | Indholdstype, fast liste jf. DK-LOM v1.1, f.eks. ”fagligt indlæg”, ”spil” mv. |
EksterntLinkListe | 2 | - | Ja | Overordnet tag til liste af links for materialet |
EksterntLink | 3 | - | Ja, min. 1 | Overordnet tag til et link |
Titel | 4 | 500 tegn | Nej | Linkets titel |
WebAdresse | 4 | 500 tegn | Ja | URL for linket |
KlassifikationListe | 2 | - | Ja | Overordnet tag til liste af klassifikationskoder |
Klassifikation | 3 | - | Ja, min. 1 | Overordnet tag for en klassifikation |
Kode | 4 | 100 tegn | Ja | Klassifikationskode, tilladte klassifikationer kan findes med operationen GetKlassifikations |
Navn | 4 | 1000 tegn | Ja | Klassifikationsnavn, tilladte klassifikationer kan findes med operationen GetKlassifikations |
Undervisningstid | 2 | integer | Nej | Antal lektioner af 60 minutters varighed |
KommentarTilUndervisning | 2 | 4000 tegn | Nej | Kommentar til lærer/underviser vedrørende undervisningen |
ErGratis | 2 | ja/nej | Ja | Er materialet gratis? |
HarYderligereBrugsrettigheder | 2 | ja/nej | Ja | Er der yderligere brugsrettigheder for materialet (Creative Commons)? |
YderligereBrugsrettigheder | 2 | Faste værdier | Nej | Angivelse af yderligere brugsrettighed, f.eks. "Creative Commons Navngivelse-DelPåSammeVilkår 4.0 (CC BY-SA 4.0)" |
ISBN | 2 | 500 tegn | Nej | ISBN for materialet |
Version | 2 | 100 tegn | Nej | Version af materialet |
Udgiver | 2 | 600 tegne | Ja | Udgiver af materialet |
Udgivelsesdato | 2 | YYYY-MM-DD | Ja | Udgivelsesdato for materialet |
Serietitel | 2 | 500 tegn | Nej | Serietitel, hvis materialet er en del af en serie af materialer |
Seriebeskrivelse | 2 | 4000 tegn | Nej | Seriebeskrivelse, hvis materialet er en del af en serie af materialer |
ReadWriteAccess | 2 | ja/nej | Nej | Tillader det digitale læremiddel anvendelsen af læse- og skriveteknologi? |
LixSum | 2 | positiveInteger | Nej | Lix-tal for materialet |
FuiKatalogListe | 2 | - | Nej | Overordnet tag til liste af FUI-katalogklassifikationer |
FuiKatalog | 3 | - | - | Overordnet tag for FUI-katalogklassifikation |
Kode | 4 | 100 tegn | Ja | Klassifikationskode (FUI) |
Navn | 4 | 1000 tegn | Ja | Navn for klassifikation (FUI) |
Distributionstype | 2 | Faste værdier | Nej | Del af Informationsaftalen. Skal kun udfyldes hvis anvender er del af aftalen. |
Distributionsuge | 2 | Ugenr. | Nej | Del af Informationsaftalen. Skal kun udfyldes hvis anvender er del af aftalen. |
Fakturering | 2 | Faste værdier | Nej | Del af Informationsaftalen. Skal kun udfyldes hvis anvender er del af aftalen. |
Status | 2 | Faste værdier | Ja | Status for materialet. Kan være "offentlig", "kladde" eller "slettet". |
DeleteMateriale
Denne operation bruges til at slette et materiale.
Tag | Niveau | Type | Obligatorisk | Beskrivelse |
MaterialeId | 1 | long | Ja | Materiale-ID, der skal slettes. |
GetAllMateriales
Denne operation bruges til at hente alle materialer, der er oprettet af en producent.
GetKlassifikations
Denne operation bruges til at hente alle gyldige klassifikationer.
UpdateMateriale
Denne operation bruges til at opdatere et allerede oprettet materiale. Operationen har samme input som OpretMateriale, men har derudover et MaterialeID-tag, som angiver det materiale, der skal opdateres.