OSO:2022/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...')
 
Regel 43: Regel 43:
 
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 [[OSO:2018/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.
 +
<sup>**</sup>Het [[OSO:2022/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==
  
==Aanroep en antwoord==
Regel 50: Regel 50:
   
 
<syntaxhighlight lang="xml">
  
<syntaxhighlight lang="xml">
  +
⚫
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
  
  +
<?xml version="1.0" encoding="UTF-8"?>
−
<soapenv:Header/>
  
  ⚫
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
−
<soapenv:Body>
 +
<SOAP-ENV:Body>
−
<ns:documentRequest>
 +
<ns1:documentRequest>
−
<ns:bronBrin>00YY</ns:bronBrin>
 +
<ns1:bronBrin>00YY</ns1:bronBrin>
−
<ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
  
  +
<ns1:bronRouteringsKenmerk>0000000700000YY00931</ns1:bronRouteringsKenmerk>
−
<ns:doelBrin>12SS</ns:doelBrin>
 +
<ns1:doelBrin>00YY</ns1:doelBrin>
−
<ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
  
  +
<ns1:doelRouteringsKenmerk>0000000700000YY00932</ns1:doelRouteringsKenmerk>
−
<ns:koppelsleutel>86e3d7fb-e907-4c42-872a-9e63ff67d9e3</ns:koppelsleutel>
 +
<ns1:koppelsleutel>19677A96-B737-402E-B3B8-24A3EEF32000</ns1:koppelsleutel>
−
<ns:overdrachtsoort>swv_aanvraag</ns:overdrachtsoort>
 +
<ns1:overdrachtsoort>swv-dossier</ns1:overdrachtsoort>
−
<ns:sessieId>fe6b2710-3fe5-468e-822d-e2b409a9f0d0</ns:sessieId>
 +
<ns1:sessieId>7c086457-e5e4-4f52-b3b0-11942edf28dc</ns1:sessieId>
−
<ns:aanvraagdatum>2016-03-06T14:19:39.977+02:00</ns:aanvraagdatum>
  
−
</ns:documentRequest>
 +
</ns1:documentRequest>
−
</soapenv:Body>
 +
</SOAP-ENV:Body>
−
</soapenv:Envelope>
 +
</SOAP-ENV:Envelope>
 
</syntaxhighlight>
  
</syntaxhighlight>
   
Regel 80: Regel 80:
   
 
|-
  
|-
  +
| bronRouteringsKenmerk
−
| bronAPindex
  
−
| Dit is de index van het aanleverpunt van het bronsysteem dat dit verzoek ontvangt.
 +
| Dit is het RouteringsKenmerk van het aanleverpunt van het bronsysteem dat dit verzoek ontvangt.
 
|
 
|
   
Regel 90: Regel 90:
   
 
|-
  
|-
  +
| doelRouteringsKenmerk
−
| doelAPindex
  
−
| Dit is de index van het Aanleverpunt van het Bronsysteem dat dit verzoek indient.
 +
| Dit is het RouteringsKenmerk van het aanleverpunt van het Bronsysteem dat dit verzoek indient.
 
|
 
|
   
Regel 131: Regel 131:
   
 
<syntaxhighlight lang="xml">
  
<syntaxhighlight lang="xml">
  +
<?xml version="1.0" encoding="UTF-8"?>
−
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
 +
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
−
<soapenv:Header/>
  
−
<soapenv:Body>
 +
<SOAP-ENV:Body>
−
<ns:documentResponse>
 +
<ns1:documentResponse>
  +
<!--You have a CHOICE of the next 2 items at this level-->
−
<ns:fout>LeerlingInfoNietBeschikbaar</ns:fout>
 +
<ns1:fout>LeerlingInfoNietBeschikbaar</ns1:fout>
⚫
</ns:documentResponse>
  
−
</soapenv:Body>
 +
<ns1:dossier>
  +
<!-- Hier zal dossier data staan -->
⚫
</soapenv:Envelope>
  
  +
</ns1:dossier>
  ⚫
</ns1:documentResponse>
  +
</SOAP-ENV:Body>
  ⚫
</SOAP-ENV:Envelope>
 
</syntaxhighlight>
  
</syntaxhighlight>
   

Versie van 7 feb 2022 10:31

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
<?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/20200910">
  <SOAP-ENV:Body>
    <ns1:documentRequest>
      <ns1:bronBrin>00YY</ns1:bronBrin>
      <ns1:bronRouteringsKenmerk>0000000700000YY00931</ns1:bronRouteringsKenmerk>
      <ns1:doelBrin>00YY</ns1:doelBrin>
      <ns1:doelRouteringsKenmerk>0000000700000YY00932</ns1:doelRouteringsKenmerk>
      <ns1:koppelsleutel>19677A96-B737-402E-B3B8-24A3EEF32000</ns1:koppelsleutel>
      <ns1:overdrachtsoort>swv-dossier</ns1:overdrachtsoort>
      <ns1:sessieId>7c086457-e5e4-4f52-b3b0-11942edf28dc</ns1:sessieId>
    </ns1:documentRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


Element Uitleg Opmerkingen
bronBrin Dit is het BRIN van de bronschool.
bronRouteringsKenmerk Dit is het RouteringsKenmerk van het aanleverpunt van het bronsysteem dat dit verzoek ontvangt.
doelBrin Dit is het BRIN van de doelschool
doelRouteringsKenmerk Dit is het RouteringsKenmerk 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/20200910">
  <SOAP-ENV:Body>
    <ns1:documentResponse>
      <!--You have a CHOICE of the next 2 items at this level-->
      <ns1:fout>LeerlingInfoNietBeschikbaar</ns1:fout>
      <ns1:dossier>
        <!-- Hier zal dossier data staan -->           
      </ns1:dossier>
    </ns1:documentResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSO:2022/Opvragen_dossier/aanvraag&oldid=12244"