OSO:2022/Initiëren sessie/overstap: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met '==Overstap variant== {|class="wikitable" ! style="text-align:left;"| Actor(s) ! style="text-align:left;"| Goal(s) |- | DoelSysteem | Geldige sessie toegekend krijg...')
 
k
 
(Een tussenliggende versie door dezelfde gebruiker niet weergegeven)
Regel 24: Regel 24:
   
 
<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">
 +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
 
<soapenv:Header/>
  
<soapenv:Header/>
 
<soapenv:Body>
  
<soapenv:Body>
Regel 30: Regel 30:
 
<ns:bronBrin>00YY</ns:bronBrin>
  
<ns:bronBrin>00YY</ns:bronBrin>
 
<!--Optional:-->
  
<!--Optional:-->
−
<!--<ns:bronAanleverpuntIndex>?</ns:bronAanleverpuntIndex> -->
 +
<!--<ns:bronRouteringsKenmerk>0000000700000YY00001</ns:bronRouteringsKenmerk> -->
 
<ns:doelBrin>12SS</ns:doelBrin>
  
<ns:doelBrin>12SS</ns:doelBrin>
−
<ns:doelAanleverpuntIndex>1</ns:doelAanleverpuntIndex>
 +
<ns:doelRouteringsKenmerk>0000000700012SS00002</ns:doelRouteringsKenmerk>
 
<ns:zoeksleutel>jlmNSPuT6wLmwzBXej/VktjYp2Too3CCNdcis5xzQaZKZYoJNzsimEwt+eHUFI8TDi6hwVKvYX0EmoMRFHOOlyIjsC/36IZIUx7IFat5HU9WeUA+4MdDzQ/rbqD8jKPhhsAfl3mmn/UwuBVdmoxu1BGLxUCioAu8+RhZ5DWW3Jc=</ns:zoeksleutel>
  
<ns:zoeksleutel>jlmNSPuT6wLmwzBXej/VktjYp2Too3CCNdcis5xzQaZKZYoJNzsimEwt+eHUFI8TDi6hwVKvYX0EmoMRFHOOlyIjsC/36IZIUx7IFat5HU9WeUA+4MdDzQ/rbqD8jKPhhsAfl3mmn/UwuBVdmoxu1BGLxUCioAu8+RhZ5DWW3Jc=</ns:zoeksleutel>
 
<ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
  
<ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
Regel 54: Regel 54:
   
 
|-
  
|-
  +
| bronRouteringsKenmerk
−
| bronAanleverpuntIndex
  
−
| Dit is de index van het Aanleverpunt van het Bronsysteem dat bevraagd wordt (optioneel).
 +
| Dit is het RouteringsKenmerk van het Bronsysteem dat bevraagd wordt (optioneel).
 
| Deze parameter wordt alleen meegegeven worden wanneer het doelsysteem één specifiek Aanleverpunt van de School wil bevragen. In plaats van alle Aanleverpunten af te lopen bij een Bronschool wordt alleen het gespecificeerde Aanleverpunt bevraagd. Dit biedt Doelsystemen een mogelijkheid voor het ondersteunen van (V)SO-scholen.
 
| Deze parameter wordt alleen meegegeven worden wanneer het doelsysteem één specifiek Aanleverpunt van de School wil bevragen. In plaats van alle Aanleverpunten af te lopen bij een Bronschool wordt alleen het gespecificeerde Aanleverpunt bevraagd. Dit biedt Doelsystemen een mogelijkheid voor het ondersteunen van (V)SO-scholen.
   
Regel 64: Regel 64:
   
 
|-
  
|-
  +
| doelRouteringsKenmerk
−
| doelAanleverpuntIndex
  
−
| Dit is de index van het Aanleverpunt van het Doelsysteem dat de Sessie aanvraagt.
 +
| Dit is het RouteringsKenmerk van het Doelsysteem dat de Sessie aanvraagt.
 
|
  
|
 
|-
  
|-
Regel 84: Regel 84:
   
 
<syntaxhighlight lang="xml">
  
<syntaxhighlight lang="xml">
−
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Header/><SOAP-ENV:Body><over:overdrachtResponse xmlns:over="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
 +
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
−
<over:overdracht>
 +
<SOAP-ENV:Header/>
−
<over:aanleverpunt>
 +
<SOAP-ENV:Body>
  +
<overdrachtResponse xmlns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
−
<over:code>0</over:code>
  
  ⚫
<overdracht>
⚫
<over:url>https://ott-sb.kennisnet.nl/aanleverpunt</over:url>
  
−
<over:type>LAS</over:type>
 +
<aanleverpunt>
  +
<routeringsKenmerk>0000000700000YY00932</routeringsKenmerk>
−
<over:label>Test</over:label>
  
−
</over:aanleverpunt>
 +
<url>https://ott-t.kennisnet.nl/aanleverpunt/932</url>
  +
<type>RIS</type>
−
<over:sessieId>467c8adb-e179-4c92-b0e8-b07540b7ef33</over:sessieId>
  
  +
<label>00YY 0000000700000YY00932 RIS Testschool Kennisnet</label>
⚫
</over:overdracht>
  
  +
</aanleverpunt>
⚫
</over:overdrachtResponse>
  
  +
<aanleverpunt>
⚫
</SOAP-ENV:Body>
  
  +
<routeringsKenmerk>0000000700000YY00931</routeringsKenmerk>
  ⚫
<url>https://ott-t.kennisnet.nl/aanleverpunt/931</url>
  +
<type>RIS</type>
  +
<label>00YY 0000000700000YY00931 RIS Testschool Kennisnet</label>
  +
</aanleverpunt>
  +
<aanleverpunt>
  +
<routeringsKenmerk>0000000700000YY00144</routeringsKenmerk>
  +
<url>https://test.com</url>
  +
<type>RIS</type>
  +
<label>00YY 0000000700000YY00144 RIS Testschool Kennisnet</label>
  +
</aanleverpunt>
  +
<sessieId>8a27aa6c-6a8d-4bdd-ad1a-6dd1f5250125</sessieId>
  +
</overdracht>
  ⚫
</overdrachtResponse>
  ⚫
</SOAP-ENV:Body>
 
</SOAP-ENV:Envelope>
  
</SOAP-ENV:Envelope>
 
</syntaxhighlight>
  
</syntaxhighlight>
Regel 102: Regel 117:
   
 
==Variant: Specifieke Aanleverpunt bevragen ==
  
==Variant: Specifieke Aanleverpunt bevragen ==
−
Een Doelsysteem kan specifiek één Aanleverpunt bevragen door de APindex van dit Aanleverpunt mee te geven (samen met de BronBRIN). In dit geval geeft het TC geen lijst met
+
Een Doelsysteem kan specifiek één Aanleverpunt bevragen door de RouteringsKenmerk van dit Aanleverpunt mee te geven (samen met de BronBRIN). In dit geval geeft het TC geen lijst met
   
 
==Aanroep en antwoord==
  
==Aanroep en antwoord==
   
 
<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">
 +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
 
<soapenv:Header/>
  
<soapenv:Header/>
 
<soapenv:Body>
  
<soapenv:Body>
 
<ns:overdrachtRequest>
  
<ns:overdrachtRequest>
 
<ns:bronBrin>00YY</ns:bronBrin>
  
<ns:bronBrin>00YY</ns:bronBrin>
  +
<ns:bronRouteringsKenmerk>0000000700000YY00001</ns:bronRouteringsKenmerk>
−
<!-- optional bronAanleverpuntIndex-->
  
−
<!--<ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>-->
  
 
<ns:doelBrin>12SS</ns:doelBrin>
  
<ns:doelBrin>12SS</ns:doelBrin>
−
<ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
 +
<ns:doelRouteringsKenmerk>0000000700012SS00002</ns:doelRouteringsKenmerk>
−
<ns:zoeksleutel>yl/xKgjcxwvxryvCveYeefn3NzZY8xCyC3UIpR62S7nVMV51q8XJpgyucE ... VtAEpVArQfJq644cxeL87GLlelkgMxNkL7nrxAZehsINL6mvvNPFskIbZzSgFUTDpI=</ns:zoeksleutel>
 +
<ns:zoeksleutel>jlmNSPuT6wLmwzBXej/VktjYp2Too3CCNdcis5xzQaZKZYoJNzsimEwt+eHUFI8TDi6hwVKvYX0EmoMRFHOOlyIjsC/36IZIUx7IFat5HU9WeUA+4MdDzQ/rbqD8jKPhhsAfl3mmn/UwuBVdmoxu1BGLxUCioAu8+RhZ5DWW3Jc=</ns:zoeksleutel>
 
<ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
  
<ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
 
</ns:overdrachtRequest>
  
</ns:overdrachtRequest>
 
</soapenv:Body>
  
</soapenv:Body>
−
</soapenv:Envelope>
  
 
</syntaxhighlight>
  
</syntaxhighlight>
   
Regel 136: Regel 149:
   
 
|-
  
|-
  +
| bronRouteringsKenmerk
−
| bronAanleverpuntIndex
  
−
| Dit is de index van het Aanleverpunt van het Bronsysteem dat bevraagd wordt (optioneel).
 +
| Dit is het RouteringsKenmerk van het Bronsysteem dat bevraagd wordt (optioneel).
 
| Deze parameter wordt alleen meegegeven worden wanneer het doelsysteem één specifiek Aanleverpunt van de School wil bevragen. In plaats van alle Aanleverpunten af te lopen bij een Bronschool wordt alleen het gespecificeerde Aanleverpunt bevraagd. Dit biedt Doelsystemen een mogelijkheid voor het ondersteunen van (V)SO-scholen.
 
| Deze parameter wordt alleen meegegeven worden wanneer het doelsysteem één specifiek Aanleverpunt van de School wil bevragen. In plaats van alle Aanleverpunten af te lopen bij een Bronschool wordt alleen het gespecificeerde Aanleverpunt bevraagd. Dit biedt Doelsystemen een mogelijkheid voor het ondersteunen van (V)SO-scholen.
   
Regel 146: Regel 159:
   
 
|-
  
|-
  +
| doelRouteringsKenmerk
−
| doelAanleverpuntIndex
  
−
| Dit is de index van het Aanleverpunt van het Doelsysteem dat de Sessie aanvraagt.
 +
| Dit is het RouteringsKenmerk van het Doelsysteem dat de Sessie aanvraagt.
 
|
  
|
 
|-
  
|-
Regel 157: Regel 170:
 
| '''koppelsleutel'''
  
| '''koppelsleutel'''
 
| De koppelsleutel die door een bronsysteem aan het doelsysteem wordt doorgegeven via een Notificatie.
 
| De koppelsleutel die door een bronsysteem aan het doelsysteem wordt doorgegeven via een Notificatie.
  +
| '''De koppelsleutel mag niet voorkomen in dit type uitwisseling!'''
−
| Als een koppelsleutel gebruikt wordt, vervangt deze de zoeksleutel (xor). Een sessie aanvraag kan niet met beide waarden tegelijk werken.
  
 
|-
  
|-
 
| overdrachtsoort
  
| overdrachtsoort
Regel 168: Regel 181:
 
<syntaxhighlight lang="xml">
  
<syntaxhighlight lang="xml">
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
−
<SOAP-ENV:Header/>
 +
<SOAP-ENV:Header/>
−
<SOAP-ENV:Body>
 +
<SOAP-ENV:Body>
−
<over:overdrachtResponse xmlns:over="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
 +
<overdrachtResponse xmlns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
−
<over:overdracht>
 +
<overdracht>
−
<over:aanleverpunt>
 +
<aanleverpunt>
  +
<routeringsKenmerk>0000000700000YY00001</routeringsKenmerk>
−
<over:code>0</over:code>
  
−
<over:url>https://ott-sb.kennisnet.nl/aanleverpunt</over:url>
 +
<url>https://ott-t.kennisnet.nl/aanleverpunt/1</url>
−
<over:type>LAS</over:type>
 +
<type>RIS</type>
  +
<label>00YY 0000000700000YY00001 RIS Testschool Kennisnet</label>
−
<over:label>Test</over:label>
  
−
</over:aanleverpunt>
 +
</aanleverpunt>
−
<over:sessieId>467c8adb-e179-4c92-b0e8-b07540b7ef33</over:sessieId>
 +
<sessieId>8a27aa6c-6a8d-4bdd-ad1a-6dd1f5250125</sessieId>
−
</over:overdracht>
 +
</overdracht>
−
</over:overdrachtResponse>
 +
</overdrachtResponse>
−
</SOAP-ENV:Body>
 +
</SOAP-ENV:Body>
 
</SOAP-ENV:Envelope>
  
</SOAP-ENV:Envelope>
 
</syntaxhighlight>Aanleverpunten terug, maar alleen de informatie van dit specifieke Aanleverpunt (mits actief).
  
</syntaxhighlight>Aanleverpunten terug, maar alleen de informatie van dit specifieke Aanleverpunt (mits actief).

Huidige versie van 24 jan 2022 om 10:27

Overstap variant

Actor(s) Goal(s)
DoelSysteem Geldige sessie toegekend krijgen voor opvragen specifiek dossier op basis van een zoeksleutel (Versleutelde PGN). Het betreft hier een LAS of een Regionaal Platform.
Traffic Center Sessie toekennen aan systeem voor geldig verzoek van systeem voor specifiek dossier door school tbv overstap

Preconditie

Systeem (doelBrin) is toegelaten op OSO keten

  • Doelsysteem heeft geldig OSO certificaat

Postconditie

Systeem heeft sessie toegekend gekregen voor opvragen specifiek dossier bij aangeduide systemen Systeem heeft lijst Aanleverpunten van doel 'OV' behorend bij bronBRIN ontvangen (Lijst kan leeg zijn.)

Aanroep en antwoord

  • Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:overdrachtRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <!--Optional:-->
         <!--<ns:bronRouteringsKenmerk>0000000700000YY00001</ns:bronRouteringsKenmerk> -->
         <ns:doelBrin>12SS</ns:doelBrin>
         <ns:doelRouteringsKenmerk>0000000700012SS00002</ns:doelRouteringsKenmerk>
         <ns:zoeksleutel>jlmNSPuT6wLmwzBXej/VktjYp2Too3CCNdcis5xzQaZKZYoJNzsimEwt+eHUFI8TDi6hwVKvYX0EmoMRFHOOlyIjsC/36IZIUx7IFat5HU9WeUA+4MdDzQ/rbqD8jKPhhsAfl3mmn/UwuBVdmoxu1BGLxUCioAu8+RhZ5DWW3Jc=</ns:zoeksleutel>
         <ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
      </ns:overdrachtRequest>
   </soapenv:Body>
</soapenv:Envelope>


Element Uitleg Opmerkingen
bronBRIN Dit is het brinnummer van de Bronschool waar dossier van specifieke leerling wordt opgevraagd. De Bronschool kan meerdere Aanleverpunten hebben.
bronRouteringsKenmerk Dit is het RouteringsKenmerk van het Bronsysteem dat bevraagd wordt (optioneel). Deze parameter wordt alleen meegegeven worden wanneer het doelsysteem één specifiek Aanleverpunt van de School wil bevragen. In plaats van alle Aanleverpunten af te lopen bij een Bronschool wordt alleen het gespecificeerde Aanleverpunt bevraagd. Dit biedt Doelsystemen een mogelijkheid voor het ondersteunen van (V)SO-scholen.
doelBrin Dit is het brinnummer van het Doelsysteem dat de Sessie aanvraagt. Het TC controleert of het Doelsysteem bekend en actief is in het deelnemersregister.
doelRouteringsKenmerk Dit is het RouteringsKenmerk van het Doelsysteem dat de Sessie aanvraagt.
zoeksleutel Het versleutelde pgn (bsn of onderwijsnummer) van de leerling van wie het dossier gaat worden opgevraagd. De zoeksleutel is verplicht voor dit type uitwisseling
koppelsleutel De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem De koppelsleutel mag niet voorkomen in dit type uitwisseling!
overdrachtsoort De overdrachtsoort moet voor alle berichten binnen de sessie gelijk zijn Het brinnummer van het bron- en doelBrin moet hetzelfde zijn voor een binnenbrin overdracht.
  • Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <overdrachtResponse xmlns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
         <overdracht>
            <aanleverpunt>
               <routeringsKenmerk>0000000700000YY00932</routeringsKenmerk>
               <url>https://ott-t.kennisnet.nl/aanleverpunt/932</url>
               <type>RIS</type>
               <label>00YY 0000000700000YY00932 RIS Testschool Kennisnet</label>
            </aanleverpunt>
            <aanleverpunt>
               <routeringsKenmerk>0000000700000YY00931</routeringsKenmerk>
               <url>https://ott-t.kennisnet.nl/aanleverpunt/931</url>
               <type>RIS</type>
               <label>00YY 0000000700000YY00931 RIS Testschool Kennisnet</label>
            </aanleverpunt>
            <aanleverpunt>
               <routeringsKenmerk>0000000700000YY00144</routeringsKenmerk>
               <url>https://test.com</url>
               <type>RIS</type>
               <label>00YY 0000000700000YY00144 RIS Testschool Kennisnet</label>
            </aanleverpunt>
            <sessieId>8a27aa6c-6a8d-4bdd-ad1a-6dd1f5250125</sessieId>
         </overdracht>
      </overdrachtResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Variant: Specifieke Aanleverpunt bevragen

Een Doelsysteem kan specifiek één Aanleverpunt bevragen door de RouteringsKenmerk van dit Aanleverpunt mee te geven (samen met de BronBRIN). In dit geval geeft het TC geen lijst met

Aanroep en antwoord

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:overdrachtRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <ns:bronRouteringsKenmerk>0000000700000YY00001</ns:bronRouteringsKenmerk>
         <ns:doelBrin>12SS</ns:doelBrin>
         <ns:doelRouteringsKenmerk>0000000700012SS00002</ns:doelRouteringsKenmerk>
         <ns:zoeksleutel>jlmNSPuT6wLmwzBXej/VktjYp2Too3CCNdcis5xzQaZKZYoJNzsimEwt+eHUFI8TDi6hwVKvYX0EmoMRFHOOlyIjsC/36IZIUx7IFat5HU9WeUA+4MdDzQ/rbqD8jKPhhsAfl3mmn/UwuBVdmoxu1BGLxUCioAu8+RhZ5DWW3Jc=</ns:zoeksleutel>
         <ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
      </ns:overdrachtRequest>
   </soapenv:Body>


Element Uitleg Opmerkingen
bronBRIN Dit is het brinnummer van de Bronschool waar dossier van specifieke leerling wordt opgevraagd. De Bronschool kan meerdere Aanleverpunten hebben.
bronRouteringsKenmerk Dit is het RouteringsKenmerk van het Bronsysteem dat bevraagd wordt (optioneel). Deze parameter wordt alleen meegegeven worden wanneer het doelsysteem één specifiek Aanleverpunt van de School wil bevragen. In plaats van alle Aanleverpunten af te lopen bij een Bronschool wordt alleen het gespecificeerde Aanleverpunt bevraagd. Dit biedt Doelsystemen een mogelijkheid voor het ondersteunen van (V)SO-scholen.
doelBrin Dit is het brinnummer van het Doelsysteem dat de Sessie aanvraagt. Het TC controleert of het Doelsysteem bekend en actief is in het deelnemersregister.
doelRouteringsKenmerk Dit is het RouteringsKenmerk van het Doelsysteem dat de Sessie aanvraagt.
zoeksleutel Het versleutelde pgn (bsn of onderwijsnummer) van de leerling van wie het dossier gaat worden opgevraagd.
koppelsleutel De koppelsleutel die door een bronsysteem aan het doelsysteem wordt doorgegeven via een Notificatie. De koppelsleutel mag niet voorkomen in dit type uitwisseling!
overdrachtsoort De overdrachtsoort moet voor alle berichten binnen de sessie gelijk zijn Het brinnummer van het bron- en doelBrin moet hetzelfde zijn voor een binnenbrin overdracht.
  • Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <overdrachtResponse xmlns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
         <overdracht>
            <aanleverpunt>
               <routeringsKenmerk>0000000700000YY00001</routeringsKenmerk>
               <url>https://ott-t.kennisnet.nl/aanleverpunt/1</url>
               <type>RIS</type>
               <label>00YY 0000000700000YY00001 RIS Testschool Kennisnet</label>
            </aanleverpunt>
            <sessieId>8a27aa6c-6a8d-4bdd-ad1a-6dd1f5250125</sessieId>
         </overdracht>
      </overdrachtResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Aanleverpunten terug, maar alleen de informatie van dit specifieke Aanleverpunt (mits actief).

NB: type van teruggegeven AP is altijd van doel 'OV' én type 'LAS' of 'RP'

Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSO:2022/Initiëren_sessie/overstap&oldid=12204"