OSO:2017/Opvragen dossier/aanvraag: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met '==SWV Aanvraag Variant== {|class="wikitable" ! style="text-align:left;"| Actor(s) ! style="text-align:left;"| Goal(s) |- | Doelsysteem | Doelsysteem heeft dossier...')
 
 
(11 tussenliggende versies door een andere gebruiker niet weergegeven)
Regel 14: Regel 14:
 
==Preconditie==
  
==Preconditie==
 
*Geldige sessie voor opvragen Dossier is toegekend door TC aan Doelsysteem
  
*Geldige sessie voor opvragen Dossier is toegekend door TC aan Doelsysteem
−
*Doelsysteem heeft Koppelsleutel ontvangen van Bronsysteem
 +
*Doelsysteem heeft Koppelsleutel ontvangen van Bronsysteem via Notificatie
  +
  +
* DoelSysteem is toegelaten op OSO keten
  +
* DoelSysteem heeft geldig ''OSO certificaat''
  +
* DoelSysteem heeft geldige Sessie voor opvragen Dossier
  +
* BronSysteem is toegelaten op OSO keten
  +
* BronSysteem heeft geldig ''OSO certificaat'' toegekend door TC
   
 
==Postconditie==
  
==Postconditie==
Regel 26: Regel 32:
 
## '''IF''' dossier gereed is voor overdracht<sup>**</sup> '''AND''' Dossier aan Doelsysteem overgedragen mag worden<sup>***</sup> '''AND''' DossierVersie is correct
  
## '''IF''' dossier gereed is voor overdracht<sup>**</sup> '''AND''' Dossier aan Doelsysteem overgedragen mag worden<sup>***</sup> '''AND''' DossierVersie is correct
 
### Bronsysteem verstuurt dossier
  
### Bronsysteem verstuurt dossier
  +
### Doelsysteem toont Eindgebruiker (lijst van) ontvangen Dossiers<sup>##</sup>
 
##'''Else'''
  
##'''Else'''
 
### Bronsysteem verstuurt foutmelding<sup>*****</sup>
  
### Bronsysteem verstuurt foutmelding<sup>*****</sup>
Regel 31: Regel 38:
 
## Bronsysteem verstuurt foutmelding<sup>*****</sup>
  
## Bronsysteem verstuurt foutmelding<sup>*****</sup>
   
  +
'''<sup>#</sup>Deze actie gebeurt automatisch zonder(!) tussenkomst van eindgebruiker.<br />'''
  +
'''<sup>##</sup>Na succesvolle overdracht(en) wordt Eindgebruiker lijst getoond met ontvangen Dossiers. OSO stelt geen verdre eisen aan de inrichting van de user interface van Doelsystemen. <br />'''
 
<sup>*</sup>Dit is een verplichte stap<br />
 
<sup>*</sup>Dit is een verplichte stap<br />
 
Deze controle ''moet voor'' de andere controles worden uitgevoerd door het Bronsysteem. Als de Sessie gegevens incorrect blijken, moet dit worden teruggegeven aan het Doelsysteem. Pas daarna volgen de andere stappen en controles.<br />
  
Deze controle ''moet voor'' de andere controles worden uitgevoerd door het Bronsysteem. Als de Sessie gegevens incorrect blijken, moet dit worden teruggegeven aan het Doelsysteem. Pas daarna volgen de andere stappen en controles.<br />
 
<sup>!</sup>Alleen bij het resultaat 'Sessie is valide' mag een Dossier uitgeleverd worden(!)<br />
 
<sup>!</sup>Alleen bij het resultaat 'Sessie is valide' mag een Dossier uitgeleverd worden(!)<br />
−
<sup>**</sup>Het <LINK NAAR KLAARZETTEN>Formeel geldt deze controle nog; in praktijk wordt uitwisseling op basis KoppelSleutel geinitieerd door klaar zetten Dossier.
 +
<sup>**</sup>Het [[OSO:2017/Klaarzetten_Dossier|klaar zetten van een Dossier]]. Formeel geldt deze controle nog; in de praktijk wordt deze uitwisseling op basis KoppelSleutel geinitieerd door klaar zetten Dossier en zou daarmee automatisch aan deze eis worden voldaan.
  +
  +
==Aanroep en antwoord==
  +
  +
*Request
  +
  +
<syntaxhighlight lang="xml">
  +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
  +
<soapenv:Header/>
  +
<soapenv:Body>
  +
<ns:documentRequest>
  +
<ns:bronBrin>00YY</ns:bronBrin>
  +
<ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
  +
<ns:doelBrin>12SS</ns:doelBrin>
  +
<ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
  +
<ns:koppelsleutel>86e3d7fb-e907-4c42-872a-9e63ff67d9e3</ns:koppelsleutel>
  +
<ns:overdrachtsoort>swv_aanvraag</ns:overdrachtsoort>
  +
<ns:sessieId>fe6b2710-3fe5-468e-822d-e2b409a9f0d0</ns:sessieId>
  +
<!--Optional:-->
  +
<!--Optional:-->
  +
<ns:aanvraagdatum>2016-03-06T14:19:39.977+02:00</ns:aanvraagdatum>
  +
</ns:documentRequest>
  +
</soapenv:Body>
  +
</soapenv:Envelope>
  +
</syntaxhighlight>
  +
  +
  +
  +
{|class="wikitable"
  +
! style="text-align:left;"| Element
  +
! style="text-align:left;"| Uitleg
  +
! style="text-align:left;"| Opmerkingen
  +
  +
|-
  +
| bronBrin
  +
| Dit is het BRIN van de bronschool.
  +
|
  +
  +
|-
  +
| bronAPindex
  +
| Dit is de index van het aanleverpunt van het bronsysteem dat dit verzoek ontvangt.
  +
|
  +
  +
|-
  +
| doelBrin
  +
| Dit is het BRIN van de doelschool
  +
|
  +
  +
|-
  +
| doelAPindex
  +
| Dit is de index van het Aanleverpunt van het Bronsysteem dat dit verzoek indient.
  +
|
  +
  +
|-
  +
| zoeksleutel
  +
| Dit is de versleutelde PGN
  +
| '''Dit veld mag niet meegestuurd bij deze overdrachtsoort(!).'''
  +
  +
|-
  +
| koppelsleutel
  +
| De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem
  +
| '''De koppelsleutel is verplicht voor deze overdrachtsoort.'''
  +
  +
  +
  +
|-
  +
| overdrachtsoort
  +
| Voor dit type overdracht moet 'SWVaanvraag' gebruikt wordt bij overdrachtsoort.
  +
|
  +
  +
|-
  +
| sessieId
  +
| De sessie-ID die verkregen is bij het Initiëren van de Sessie.
  +
|
  +
  +
|-
  +
| PGN
  +
| Het BSN of Onderwijsnummer van de leerling (verplicht)
  +
| Dit wordt onversleuteld verstuurd in het documentRequest
  +
  +
|-
  +
| aanvraagdatum
  +
| De aanvraag datum wordt genegeerd bij dit type overdracht(!)
  +
| De aanvraagdatum is optioneel
  +
|}
  +
  +
  +
*Response
  +
  +
<syntaxhighlight lang="xml">
  +
<?xml version="1.0" encoding="UTF-8"?>
  +
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
  +
<SOAP-ENV:Body>
  +
<ns1:documentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.w3.org/2001/XMLSchema">
  +
<ns1:fout>LeerlinginfoNietBeschikbaar</ns1:fout>
  +
</ns1:documentResponse>
  +
</SOAP-ENV:Body>
  +
</SOAP-ENV:Envelope>
  +
</syntaxhighlight>
  +
  +
[[Categorie:Overstapservice Onderwijs]]

Huidige versie van 26 apr 2018 om 12:38

SWV Aanvraag Variant

Actor(s) Goal(s)
Doelsysteem Doelsysteem heeft dossier van specifieke leerling ontvangen
Bronsysteem Verzoek tot overhandigen specifiek dossier afgehandeld

Preconditie

  • Geldige sessie voor opvragen Dossier is toegekend door TC aan Doelsysteem
  • Doelsysteem heeft Koppelsleutel ontvangen van Bronsysteem via Notificatie
  • DoelSysteem is toegelaten op OSO keten
  • DoelSysteem heeft geldig OSO certificaat
  • DoelSysteem heeft geldige Sessie voor opvragen Dossier
  • BronSysteem is toegelaten op OSO keten
  • BronSysteem heeft geldig OSO certificaat toegekend door TC

Postconditie

Dossier is verzonden van Doelsysteem naar Bronsysteem


SWV Aanvraag Scenario

  1. Doelsysteem vraagt dossier op mbv KoppelSleutel #
  2. Bronsysteem laat <LINK NAAR SESSIE CONTROLE>Sessie gegevens Controleren]] bij TC*
  3. IF sessie gegevens valide blijken !
    1. IF dossier gereed is voor overdracht** AND Dossier aan Doelsysteem overgedragen mag worden*** AND DossierVersie is correct
      1. Bronsysteem verstuurt dossier
      2. Doelsysteem toont Eindgebruiker (lijst van) ontvangen Dossiers##
    2. Else
      1. Bronsysteem verstuurt foutmelding*****
  4. Else
    1. Bronsysteem verstuurt foutmelding*****

#Deze actie gebeurt automatisch zonder(!) tussenkomst van eindgebruiker.
 ##Na succesvolle overdracht(en) wordt Eindgebruiker lijst getoond met ontvangen Dossiers. OSO stelt geen verdre eisen aan de inrichting van de user interface van Doelsystemen.
*Dit is een verplichte stap
Deze controle moet voor de andere controles worden uitgevoerd door het Bronsysteem. Als de Sessie gegevens incorrect blijken, moet dit worden teruggegeven aan het Doelsysteem. Pas daarna volgen de andere stappen en controles.
!Alleen bij het resultaat 'Sessie is valide' mag een Dossier uitgeleverd worden(!)
**Het klaar zetten van een Dossier. Formeel geldt deze controle nog; in de praktijk wordt deze uitwisseling op basis KoppelSleutel geinitieerd door klaar zetten Dossier en zou daarmee automatisch aan deze eis worden voldaan.

Aanroep en antwoord

  • Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:documentRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
         <ns:doelBrin>12SS</ns:doelBrin>
         <ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
     	 <ns:koppelsleutel>86e3d7fb-e907-4c42-872a-9e63ff67d9e3</ns:koppelsleutel>
         <ns:overdrachtsoort>swv_aanvraag</ns:overdrachtsoort>
         <ns:sessieId>fe6b2710-3fe5-468e-822d-e2b409a9f0d0</ns:sessieId>
         <!--Optional:-->
         <!--Optional:-->
         <ns:aanvraagdatum>2016-03-06T14:19:39.977+02:00</ns:aanvraagdatum>
      </ns:documentRequest>
   </soapenv:Body>
</soapenv:Envelope>


Element Uitleg Opmerkingen
bronBrin Dit is het BRIN van de bronschool.
bronAPindex Dit is de index van het aanleverpunt van het bronsysteem dat dit verzoek ontvangt.
doelBrin Dit is het BRIN van de doelschool
doelAPindex Dit is de index van het Aanleverpunt van het Bronsysteem dat dit verzoek indient.
zoeksleutel Dit is de versleutelde PGN Dit veld mag niet meegestuurd bij deze overdrachtsoort(!).
koppelsleutel De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem De koppelsleutel is verplicht voor deze overdrachtsoort.


overdrachtsoort Voor dit type overdracht moet 'SWVaanvraag' gebruikt wordt bij overdrachtsoort.
sessieId De sessie-ID die verkregen is bij het Initiëren van de Sessie.
PGN Het BSN of Onderwijsnummer van de leerling (verplicht) Dit wordt onversleuteld verstuurd in het documentRequest
aanvraagdatum De aanvraag datum wordt genegeerd bij dit type overdracht(!) De aanvraagdatum is optioneel


  • Response
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
<SOAP-ENV:Body>
<ns1:documentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.w3.org/2001/XMLSchema">
   <ns1:fout>LeerlinginfoNietBeschikbaar</ns1:fout>
</ns1:documentResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSO:2017/Opvragen_dossier/aanvraag&oldid=8393"