OSO:2022/Initiëren sessie/aanvraag

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen

Uitwisseling tbv aanvraag bij Samenwerkingsverband (SWV) variant

Actor(s) Goal(s)
DoelSysteem (RP of SWV) Geldige sessie toegekend krijgen voor opvragen specifiek dossier. Een sessie geldt altijd voor één specifiek dossier.
Traffic Center Sessie toekennen aan systeem voor geldig verzoek van systeem voor specifiek dossier door school voor aanvraag bij samenwerkingsverband. Deze uitwisseling wordt gestart na ontvangst van een Notificatie met Koppelsleutel. De aanvraag wordt altijd gedaan bij het specifieke Aanleverpunt dat de Notificatie verzonden heeft.

Preconditie

  • Doelsysteem is toegelaten op OSO keten
  • Doelsysteem heeft geldig OSO certificaat
  • Doelsysteem heeft Notificatie ontvangen van BronSysteem met KoppelSleuutel

Postconditie

  • TC heeft DoelSysteem Sessie toegekend voor opvragen Dossier bij aangeduid Aanleverpunt van Bronsysteem.
  • Doelsysteem heeft Aanleverpunt informatie met doel 'PaO' behorend bij bronBRIN ontvangen.

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>
      <ns1:overdrachtRequest xmlns:ns1="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
         <ns1:bronBrin>00YY</ns1:bronBrin>
         <ns1:bronRouteringsKenmerk>0000000700000YY00001</ns1:bronRouteringsKenmerk>
         <ns1:doelBrin>00YY</ns1:doelBrin>
         <ns1:doelRouteringsKenmerk>0000000700000YY00931</ns1:doelRouteringsKenmerk>
         <ns1:koppelsleutel>da6cb121-f855-453b-a21b-9936de5b4809</ns1:koppelsleutel>
         <ns1:overdrachtsoort>swv-dossier</ns1:overdrachtsoort>
      </ns1: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 (verplicht).
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 mag niet voorkomen in dit type uitwisseling!
koppelsleutel De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem De koppelsleutel is verplicht voor dit type uitwisseling
overdrachtsoort De overdrachtsoort moet voor dit type uitwisseling 'SWVaanvraag' 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 0000000700000YY00932 RIS Testschool Kennisnet</label>
            </aanleverpunt>
            <sessieId>8a27aa6c-6a8d-4bdd-ad1a-6dd1f5250125</sessieId>
         </overdracht>
      </overdrachtResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • NB: type van teruggegeven AP is altijd of 'RP' of 'SWV'

Opvragen met Koppelsleutel ipv Zoeksleutel

Een Doelsysteem kan specifiek een aanvraag starten na ontvangst van een Notificatie met Koppelsleutel. In dat geval wordt de sessie aangevraagd met deze Koppelsleutel en zonder(!) een Zoeksleutel. Een tweede eis is dat alleen het Aanleverpunt dat de notificatie heeft verstuurd naar het Doelsysteem bevraagd mag worden; er is sprake van een aanvraag bij een specifiek Aanleverpunt.