OSO:2017/Initiëren sessie/aanvraag: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
Regel 14: Regel 14:
   
 
# Doelsysteem vraagt Sessie aan bij TC voor Overdracht van Dossier
 
# Doelsysteem vraagt Sessie aan bij TC voor Overdracht van Dossier
# '''IF''' het Doelsysteem is valide<sup>*</sup> '''AND ''' Doel Aanleverpunt is actief ''' AND ''' Bron School is actief ''' AND '''(zoeksleutel is leeg'''AND''' koppelsleutel is gevuld) '''AND''' (Bron AP is gevuld) ''' THEN '''
+
# '''IF''' het Doelsysteem is valide<sup>*</sup> '''AND ''' Doel Aanleverpunt is actief ''' AND ''' Bron School is actief ''' AND '''(zoeksleutel is leeg'''AND''' koppelsleutel is gevuld) '''AND''' (Bron AP is gevuld) '''AND''' overdrachtsoort == 'SWVaanvraag' ''' THEN '''
 
## Traffic Center kent een sessie toe aan het Bronsysteem
 
## Traffic Center kent een sessie toe aan het Bronsysteem
 
## Traffic Center verstrekt url van het te bevragen Aanleverpunt <sup>**</sup>
 
## Traffic Center verstrekt url van het te bevragen Aanleverpunt <sup>**</sup>
Regel 26: Regel 26:
 
<sup>***</sup>In dit geval kan de Sessie niet afgemeld worden.<br />
 
<sup>***</sup>In dit geval kan de Sessie niet afgemeld worden.<br />
   
  +
==Aanroep en antwoord==
  +
MOET NOG GECHECKT!!
  +
*Request:
  +
  +
<syntaxhighlight lang="xml">
  +
<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>
  +
</syntaxhighlight>
  +
  +
  +
  +
{|class="wikitable"
  +
! style="text-align:left;"| Element
  +
! style="text-align:left;"| Uitleg
  +
! style="text-align:left;"| 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:
  +
  +
<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.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>
  +
</syntaxhighlight>
  +
  +
[[Categorie:Overstapservice Onderwijs]]
   
 
==Opvragen met Koppelsleutel ipv Zoeksleutel ==
 
==Opvragen met Koppelsleutel ipv Zoeksleutel ==

Versie van 10 feb 2017 14:39

Aanvraag (SWV) variant

Actor(s) Goal(s)
DoelSysteem 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.


  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 leegAND koppelsleutel is gevuld) AND (Bron AP is gevuld) AND overdrachtsoort == 'SWVaanvraag' THEN
    1. Traffic Center kent een sessie toe aan het Bronsysteem
    2. Traffic Center verstrekt url van het te bevragen Aanleverpunt **
    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.
**In deze variant (SWV aanvraag) mag alleen specifiek aanleverpunt bevraagd worden.
***In dit geval kan de Sessie niet afgemeld worden.

Aanroep en antwoord

MOET NOG GECHECKT!!

  • 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>

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.


Aanroep en Antwoord

NOG DOEN