KVS:Beschikbaarheid controleren: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met '= User Story = Ik ben Deelnemer en wil een overzicht van versies van de Standaard opvragen, waartegen dossiers gevalideerd kunnen worden, zodat ik een correct valid...')
 
(add cat handleiding)
 
(4 tussenliggende versies door 2 gebruikers niet weergegeven)
Regel 1: Regel 1:
  +
Ik ben Deelnemer en wil de KVS beschikbaarheid controleren, zodat ik een validatie verzoek kan inplannen
= User Story =
 
Ik ben Deelnemer en wil een overzicht van versies van de Standaard opvragen, waartegen dossiers gevalideerd kunnen worden, zodat ik een correct validatie verzoek kan indienen.
 
   
= Beschrijving =
+
== Beschrijving ==
  +
De status van (en toegang tot) de Kennisnet Validatie Service kan via deze aanroep gecontroleerd worden. Het KVS geeft de huidige versie (release) van het KVS terug.
De Kennisnet Validatie Service biedt de service om een lijst met [[KVS:Ondersteunde_versies_van_de_EduStandaard_OSO|ondersteunde versies van de EduStandaard OSO]] op te vragen. Op basis van deze lijst kan een deelnemer een dossier valideren tegen de huidige of eerdere/afwijkende versies/implementaties van deze standaard. De validatie bestaat uit een controle van de syntax (op basis van een xsd) en een aanvullende controle op semantiek (met behulp van een xslt).
 
 
Een overzicht van door het KVS ondersteunde versies met de bijbehorende xsd en xslt bestanden is ook hier te vinden.
 
   
 
== Scenario ==
 
== Scenario ==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
|Stap 1
 
|Stap 1
|Documentbron stuurt een verzoek naar KVS voor lijst met versies.
+
|Documentbron stuurt een verzoek naar KVS voor de status.
 
|-
 
|-
 
|Stap 2
 
|Stap 2
|Het KVS retourneert de lijst met versies.
+
|Het KVS retourneert de huidige versie van de geïnstalleerde software.
 
|}
 
|}
   
Regel 26: Regel 22:
 
! style="text-align:left;"| Parameter
 
! style="text-align:left;"| Parameter
 
! style="text-align:left;"| Opmerkingen
 
! style="text-align:left;"| Opmerkingen
|-
 
|input
 
|dossier
 
|dossier (in xml formaat) inclusief attachments
 
 
|-
 
|-
 
|output
 
|output
 
|lijst met versies
 
|lijst met versies
  +
|huidige versienummer van het KVS
|versies waartegen dossiers gevalideerd kunnen worden
 
 
|}
 
|}
   
  +
== Logging ==
 
  +
{{:KVS:Logging}}
 
   
   
 
[[Categorie:Kennisnet Validatie Service]]
 
[[Categorie:Kennisnet Validatie Service]]
  +
[[Categorie:Handleiding]]

Huidige versie van 23 mei 2014 om 10:02

Ik ben Deelnemer en wil de KVS beschikbaarheid controleren, zodat ik een validatie verzoek kan inplannen

Beschrijving

De status van (en toegang tot) de Kennisnet Validatie Service kan via deze aanroep gecontroleerd worden. Het KVS geeft de huidige versie (release) van het KVS terug.

Scenario

Stap 1 Documentbron stuurt een verzoek naar KVS voor de status.
Stap 2 Het KVS retourneert de huidige versie van de geïnstalleerde software.

Preconditie

  • De betrokken leverancier van Documentbron heeft een bewerkingsovereenkomst afgesloten met Kennisnet.
  • Documentbron heeft toegang tot KVS

Aanroep parameters

I/O Parameter Opmerkingen
output lijst met versies huidige versienummer van het KVS

Logging

Het KVS registreert gebeurtenissen met betrekking tot het valideren van overstapdossiers. Deze registratie is aanvullend op de 'normale' logging van de systemen waarop het KVS is gehost. Het KVS registreert de volgende acties:

Deze registraties wordt gebruikt om een rapportage voorziening binnen Kennisnet te voorzien van gegevens om de dienst KVS de kunnen besturen en verbeteren. In deze rapportages en in de registraties worden GEEN persoonsgegevens of delen van overstapdossiers overgenomen. Alleen metagegevens over de controle (uitkomst, aanbiedend systeem, controleschema, etc.) worden gebruikt.