OSO:2017/Initiëren sessie

Actor(s)	Goal(s)
Systeem (doelschool)	Geldige sessie toegekend krijgen voor opvragen specifiek dossier. Zowel in de variant met zoeksleutel als die met een koppelsleutel geldt dat een sessie altijd over één specifiek dossier gaat.
Traffic Center	Sessie toekennen aan systeem voor geldig verzoek van systeem voor specifiek dossier door school

Preconditie

• Doelsysteem is toegelaten op OSO keten
• Doelsysteem heeft geldig OSO certificaat

Postconditie

• TC heeft DoelSysteem (doelBrin) Sessie toegkend voor opvragen Dossier bij aangeduide Aanleverpunt(en) van Bronsyste(e)m(en).

Basis scenario

1. Doelsysteem vraagt Sessie aan bij TC
2. IF het Doelsysteem is valide^* AND Doel Aanleverpunt is actief AND Bron School is actief AND (zoeksleutel XOR koppelsleutel is gevuld) 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 Aanleverpunten terug, maar alleen de informatie van dit specifieke Aaneleverpunt (mits actief).

Variant: 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.

Alternatieve scenario's:

Koppelsleutel geldt tussen twee systemen en kan vaker gebruikt worden (opvragen, terugkoppeling). Kan dus ook meerdere sessies aanvragen met deze sleutel!?].

Hieronder worden alternatieve scenario's en de bijbehorende melding opgesomd:
.

Resultaat	A/E*	Omschrijving	Toelichting
AanvragerNietBekend	A	De aanvrager (doelBrin) is niet gerechtigd om de overstapservice te gebruiken	Het doelBrin is niet bekend in het register van het Traffic Center.
AanvragerAanleverpuntNietBekend	A	Het aanleverpunt van het doelsysteem (aanvragend aanleverpunt) is niet bekend bij het Traffic Center	In het Register is de combinatie van doelBrin en doelAanleverpuntIndex niet aanwezig.
AanvragerNietBeschikbaar	A	De aanvrager (doelBrin) is niet gerechtigd om de overstapservice te gebruiken.	De Doelschool (BRIN) is niet gerechtigd gebruik te maken van OSO.
VerstrekkerNietBekend	A	Het bronBrin is niet bekend bij het Traffic Center.	De opgegeven bronschool is (nog) niet opgenomen in het Register van het Traffic Center.
VerstrekkerNietBeschikbaar	A	Bronsysteem is niet gerechtigd om de overstapservice te gebruiken. Voorbeeld hiervan: de URL van het bronssysteem is niet (goed) geregistreerd.	De bronschool is bekend in het register, maar er zijn geen actieve aanleverpunten beschikbaar. Voorbeeld hiervan: de URL van het bronssysteem niet (goed) is geregistreerd.
GeenRelatieMetDoel	A	De overdrachtSoort in het overdrachtsRequest is "overdrachtbinnenbrin", maar het bronBrin en doelBrin verschillen van elkaar.	Een overdracht binnenbrin mag alleen tussen systemen met eenzelfde BRIN plaats vinden.
OverdrachtReedsActief	E	Er is reeds een sessie actief voor dezelfde parameters.	Een sessie voor een identieke overdracht is nog actief. Geldt alleen voor aanvraag met zoeksleutel.
AanvraagSleutelNietCorrect	E	De aanvraag heeft geen zoeksleutel of koppelsleutel of beiden zijn ingevuld.	Een sessie moet ofwel een dossier via een zoeksleutel ofwel via een koppelsleutel aanvragen.
AanvraagSleutelNietBekend	E	De aanvraag gebruikt een Koppelsleutel die niet bekend is bij het TC.	Een koppelsleutel wordt door het TC gegenereerd bij het NotificatieRequest en moet daarom bekend zijn bij het TC.
AanvraagNietSpecifiek	E	De aanvraag maakt gebruik van een zoeksleutel maar specificeert geen Aanleverpunt.	Een aanvraag met een zoeksleutel moet een specifiek aanleverpunt bevragen.
OngeautoriseerdAanleverpunt	E	Het OIN van het certificaat komt niet overeen met die van de geregistreerde leverancier	Het Aanleverpunt (BronBRIN/APindex) is bekend bij OSO, maar in het Register is een andere Leverancier bekend dat die deze sessie aanvraag indient.
<Geen response>	E	Het Traffic Center geeft een time out of technische fout.	Het aanvragende Bronsysteem staakt de verdere aanvraag en geeft de eindgebruiker hierover een foutmelding.

^* A: Alternatief, E: Exceptie (fout)

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>