OSO:2017/Initiëren sessie/overstap

Basis variant

1. Doelsysteem vraagt Sessie aan bij TC voor Overdracht van Dossier
2. IF het Doelsysteem is valide^* AND Doel Aanleverpunt is actief AND Bron School is actief AND (zoeksleutel is gevuld AND koppelsleutel is leeg) THEN
   1. Traffic Center kent een sessie toe aan het Bronsysteem
   2. Traffic Center verstrekt lijst met te bevragen Aanleverpunten ^**
   3. Doelsysteem start opvragen Dossier
3. Else
   1. Traffic Center geeft foutcode terug
   2. Doelsysteem geeft foutmelding aan Eindgebruiker ^***

^*Valide systeem houdt oa in dat het systeem gekwalificeerd is, een correct certificaat heeft en toegelaten is op de OSO keten.
^**Als specifiek aanleverpunt bevraagd wordt, dan wordt alleen de gegevens van dit aanleverpunt doorgegeven door TC.
^***In dit geval kan de Sessie niet afgemeld worden.

Basisvariant: Aanvraag met Zoeksleutel

Een Doelsysteem vraagt een Sessie aan om een specifiek Dossier op te vragen bij een School (BRIN(4)). Het TC verstrekt een Sessie wanneer de School bekend en actief is; er zijn actieve Aanleverpunten bij deze school die bevraagd kunnen worden. Het TC geeft de lijst met Aanleverpunten terug aan het Sessie aanvragende systeem.

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

Aanroep en antwoord

• Request: UITBREIDEN MET KOPPELSLEUTEL~!

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.eld.nl/schemas/Overstapservice/20160411">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:overdrachtRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <!-- optional bronAanleverpuntIndex-->
         <!--<ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>-->
         <ns:doelBrin>12SS</ns:doelBrin>
         <ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
         <ns:zoeksleutel>yl/xKgjcxwvxryvCveYeefn3NzZY8xCyC3UIpR62S7nVMV51q8XJpgyucE ... VtAEpVArQfJq644cxeL87GLlelkgMxNkL7nrxAZehsINL6mvvNPFskIbZzSgFUTDpI=</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.
bronAanleverpuntIndex	Dit is de index van het Aanleverpunt 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.
doelAanleverpuntIndex	Dit is de index van het Aanleverpunt 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.	Als een koppelsleutel gebruikt wordt, vervangt deze de zoeksleutel (xor). Een sessie aanvraag kan niet met beide waarden tegelijk werken.
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>
<over:overdrachtResponse xmlns:over="http://xml.eld.nl/schemas/Overstapservice/20160411">
  <over:overdracht>
    <over:aanleverpunt>
      <over:code>0</over:code>
      <over:url>https://urlvandebronschoolap0.nl</over:url>
      <over:type>LAS</over:type>
      <over:label>00YY0000 Testschool OSO</over:label>
    </over:aanleverpunt>
    <over:aanleverpunt>
      <over:code>102</over:code>
      <over:url>https://urlvandebronschoolap102.nl</over:url>
      <over:type>LAS</over:type>
      <over:label>00YY0102 Testschool OSO</over:label>
    </over:aanleverpunt>
    <over:sessieId>08758bef-5f79-46e9-9e7f-64e842785c77</over:sessieId>
  </over:overdracht>
</over:overdrachtResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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