OSO:2017/Initiëren sessie

Uit Kennisnet Developers Documentatie
< OSO:2017
Versie door Vankrimpen01 (overleg | bijdragen) op 12 jan 2017 om 08:48 (Nieuwe pagina aangemaakt met '{|class="wikitable" ! style="text-align:left;"| Actor(s) ! style="text-align:left;"| Goal(s) |- | Systeem (doelschool) | Geldige sessie toegekend krijgen voor opvra...')
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Ga naar: navigatie, zoeken
Actor(s) Goal(s)
Systeem (doelschool) Geldige sessie toegekend krijgen voor opvragen specifiek dossier
Traffic Center Sessie toekennen aan systeem voor geldig verzoek van systeem voor specifiek dossier door school

Preconditie

Systeem (doelBrin) is toegelaten op OSO keten

Postconditie

Systeem (doelBrin) heeft sessie toegekend gekregen voor opvragen specifiek dossier bij aangeduide systemen

Basis scenario

  1. Doelsysteem vraagt sessie aan bij het Traffic Center voor opvragen specifiek dossier(BSN) bij specifieke Bronschool
  2. If het Doelsysteem is valide AND Doel Aanleverpunt is actief AND Bron School is actief THEN
    1. Traffic Center kent een sessie toe aan het Bronsysteem
    2. Traffic Center verstrekt lijst met te bevragen Aanleverpunten
  3. Else
    1. Traffic Center geeft foutmelding terug
    2. Doelsysteem geeft foutmelding aan Eindgebruiker *

*In dit geval kan de Sessie niet afgemeld worden.

Variant: Specifieke opvraag

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).

Alternatieve scenario's:

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