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

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
k
 
(15 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 1: Regel 1:
−
==Basis scenario==
 +
==Overstap variant==
−
# Doelsysteem vraagt Sessie aan bij TC
  
−
# '''IF''' het Doelsysteem is valide<sup>*</sup> '''AND ''' Doel Aanleverpunt is actief ''' AND ''' Bron School is actief ''' AND '''(zoeksleutel '''XOR''' koppelsleutel is gevuld) ''' THEN '''
  
−
## Traffic Center kent een sessie toe aan het Bronsysteem
  
−
## Traffic Center verstrekt lijst met te bevragen Aanleverpunten <sup>**</sup>
  
−
## Doelsysteem start opvragen Dossier
  
−
#'''Else'''
  
−
## Traffic Center geeft foutcode terug
  
−
## Doelsysteem geeft foutmelding aan Eindgebruiker <sup>***</sup>
  
−
<p>
  
−
<sup>*</sup>Valide systeem houdt oa in dat het systeem gekwalificeerd is, een correct certificaat heeft en toegelaten is op de OSO keten. <br />
  
−
<sup>**</sup>Als specifiek aanleverpunt bevraagd wordt, dan wordt alleen de gegevens van dit aanleverpunt doorgegeven door TC.<br />
  
−
<sup>***</sup>In dit geval kan de Sessie niet afgemeld worden.<br />
  
   
  +
{|class="wikitable"
−
==Basisvariant: Aanvraag met Zoeksleutel ==
  
  +
! style="text-align:left;"| Actor(s)
−
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.
  
  +
! style="text-align:left;"| Goal(s)
  +
|-
  +
| DoelSysteem
  +
| Geldige sessie toegekend krijgen voor opvragen specifiek dossier op basis van een zoeksleutel (Versleutelde PGN). Het betreft hier een LAS of een Regionaal Platform.
  +
|-
  +
| Traffic Center
  +
| Sessie toekennen aan systeem voor geldig verzoek van systeem voor specifiek dossier door school tbv overstap
  +
|}
  +
  +
==Preconditie==
  +
Systeem (doelBrin) is toegelaten op OSO keten
  +
*Doelsysteem heeft geldig ''OSO certificaat''
  +
  +
==Postconditie==
  +
Systeem heeft sessie toegekend gekregen voor opvragen specifiek dossier bij aangeduide systemen
  +
Systeem heeft lijst Aanleverpunten van doel 'OV' behorend bij bronBRIN ontvangen (Lijst kan leeg zijn.)
  +
  +
==Aanroep en antwoord==
  +
*Request:
  +
  +
<syntaxhighlight lang="xml">
  +
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.eld.nl/schemas/Overstapservice/20170401">
  +
<soapenv:Header/>
  +
<soapenv:Body>
  +
<ns:overdrachtRequest>
  +
<ns:bronBrin>00YY</ns:bronBrin>
  +
<!--Optional:-->
  +
<!--<ns:bronAanleverpuntIndex>?</ns:bronAanleverpuntIndex> -->
  +
<ns:doelBrin>12SS</ns:doelBrin>
  +
<ns:doelAanleverpuntIndex>1</ns:doelAanleverpuntIndex>
  +
<ns:zoeksleutel>jlmNSPuT6wLmwzBXej/VktjYp2Too3CCNdcis5xzQaZKZYoJNzsimEwt+eHUFI8TDi6hwVKvYX0EmoMRFHOOlyIjsC/36IZIUx7IFat5HU9WeUA+4MdDzQ/rbqD8jKPhhsAfl3mmn/UwuBVdmoxu1BGLxUCioAu8+RhZ5DWW3Jc=</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.
  +
| De zoeksleutel is verplicht voor dit type uitwisseling
  +
|-
  +
| koppelsleutel
  +
| De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem
  +
| '''De koppelsleutel mag niet voorkomen in dit type uitwisseling!'''
  +
|-
  +
| 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/20170401">
  +
<over:overdracht>
  +
<over:aanleverpunt>
  +
<over:code>0</over:code>
  +
<over:url>https://helpdesk.swp.nl/osoverstrekker.axd</over:url>
  +
<over:type>LAS</over:type>
  +
<over:label>00AH00000 LAS Het Stedelijk Lyceum locatie Kottenpark</over:label>
  +
</over:aanleverpunt>
  +
<over:aanleverpunt>
  +
<over:code>7</over:code>
  +
<over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
  +
<over:type>LAS</over:type>
  +
<over:label>00AH07007 LAS</over:label>
  +
</over:aanleverpunt>
  +
<over:aanleverpunt>
  +
<over:code>8</over:code>
  +
<over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
  +
<over:type>LAS</over:type>
  +
<over:label>00AH08008 LAS</over:label>
  +
</over:aanleverpunt>
  +
<over:aanleverpunt>
  +
<over:code>9</over:code>
  +
<over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
  +
<over:type>LAS</over:type>
  +
<over:label>00AH09009 LAS</over:label>
  +
</over:aanleverpunt>
  +
<over:aanleverpunt>
  +
<over:code>11</over:code>
  +
<over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
  +
<over:type>LAS</over:type>
  +
<over:label>00AH11011 LAS</over:label>
  +
</over:aanleverpunt>
  +
<over:aanleverpunt>
  +
<over:code>17</over:code>
  +
<over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
  +
<over:type>LAS</over:type>
  +
<over:label>00AH17017 LAS</over:label>
  +
</over:aanleverpunt>
  +
<over:aanleverpunt>
  +
<over:code>18</over:code>
  +
<over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
  +
<over:type>LAS</over:type>
  +
<over:label>00AH00018 LAS Het Stedelijk Lyceum locatie Kottenpark</over:label>
  +
</over:aanleverpunt>
  +
<over:sessieId>64fd2abc-bf28-4c2c-a084-83a394232b19</over:sessieId>
  +
</over:overdracht>
  +
</over:overdrachtResponse>
  +
</SOAP-ENV:Body>
  +
</SOAP-ENV:Envelope>
  +
  +
</syntaxhighlight>
  +
  +
[[Categorie:Overstapservice Onderwijs]]
   
 
==Variant: Specifieke Aanleverpunt bevragen ==
  
==Variant: Specifieke Aanleverpunt bevragen ==
Regel 20: Regel 145:
   
 
==Aanroep en antwoord==
  
==Aanroep en antwoord==
−
*Request: '''UITBREIDEN MET KOPPELSLEUTEL~!'''
  
   
 
<syntaxhighlight lang="xml">
  
<syntaxhighlight lang="xml">
Regel 105: Regel 229:
 
</SOAP-ENV:Body>
  
</SOAP-ENV:Body>
 
</SOAP-ENV:Envelope>
  
</SOAP-ENV:Envelope>
−
</syntaxhighlight>Aanleverpunten terug, maar alleen de informatie van dit specifieke Aaneleverpunt (mits actief).
 +
</syntaxhighlight>Aanleverpunten terug, maar alleen de informatie van dit specifieke Aanleverpunt (mits actief).
  +
'''NB:''' type van teruggegeven AP is altijd van doel 'OV' én type 'LAS' of 'RP'
   
 
[[Categorie:Overstapservice Onderwijs]]
  
[[Categorie:Overstapservice Onderwijs]]
−
[[Category:Book OSO|73]]
  

Huidige versie van 12 feb 2018 om 13:49

Overstap variant

Actor(s) Goal(s)
DoelSysteem Geldige sessie toegekend krijgen voor opvragen specifiek dossier op basis van een zoeksleutel (Versleutelde PGN). Het betreft hier een LAS of een Regionaal Platform.
Traffic Center Sessie toekennen aan systeem voor geldig verzoek van systeem voor specifiek dossier door school tbv overstap

Preconditie

Systeem (doelBrin) is toegelaten op OSO keten

  • Doelsysteem heeft geldig OSO certificaat

Postconditie

Systeem heeft sessie toegekend gekregen voor opvragen specifiek dossier bij aangeduide systemen Systeem heeft lijst Aanleverpunten van doel 'OV' behorend bij bronBRIN ontvangen (Lijst kan leeg zijn.)

Aanroep en antwoord

  • Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.eld.nl/schemas/Overstapservice/20170401">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:overdrachtRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <!--Optional:-->
         <!--<ns:bronAanleverpuntIndex>?</ns:bronAanleverpuntIndex> -->
         <ns:doelBrin>12SS</ns:doelBrin>
         <ns:doelAanleverpuntIndex>1</ns:doelAanleverpuntIndex>
         <ns:zoeksleutel>jlmNSPuT6wLmwzBXej/VktjYp2Too3CCNdcis5xzQaZKZYoJNzsimEwt+eHUFI8TDi6hwVKvYX0EmoMRFHOOlyIjsC/36IZIUx7IFat5HU9WeUA+4MdDzQ/rbqD8jKPhhsAfl3mmn/UwuBVdmoxu1BGLxUCioAu8+RhZ5DWW3Jc=</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. De zoeksleutel is verplicht voor dit type uitwisseling
koppelsleutel De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem De koppelsleutel mag niet voorkomen in dit type uitwisseling!
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/20170401">
         <over:overdracht>
            <over:aanleverpunt>
               <over:code>0</over:code>
               <over:url>https://helpdesk.swp.nl/osoverstrekker.axd</over:url>
               <over:type>LAS</over:type>
               <over:label>00AH00000 LAS Het Stedelijk Lyceum locatie Kottenpark</over:label>
            </over:aanleverpunt>
            <over:aanleverpunt>
               <over:code>7</over:code>
               <over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
               <over:type>LAS</over:type>
               <over:label>00AH07007 LAS</over:label>
            </over:aanleverpunt>
            <over:aanleverpunt>
               <over:code>8</over:code>
               <over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
               <over:type>LAS</over:type>
               <over:label>00AH08008 LAS</over:label>
            </over:aanleverpunt>
            <over:aanleverpunt>
               <over:code>9</over:code>
               <over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
               <over:type>LAS</over:type>
               <over:label>00AH09009 LAS</over:label>
            </over:aanleverpunt>
            <over:aanleverpunt>
               <over:code>11</over:code>
               <over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
               <over:type>LAS</over:type>
               <over:label>00AH11011 LAS</over:label>
            </over:aanleverpunt>
            <over:aanleverpunt>
               <over:code>17</over:code>
               <over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
               <over:type>LAS</over:type>
               <over:label>00AH17017 LAS</over:label>
            </over:aanleverpunt>
            <over:aanleverpunt>
               <over:code>18</over:code>
               <over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
               <over:type>LAS</over:type>
               <over:label>00AH00018 LAS Het Stedelijk Lyceum locatie Kottenpark</over:label>
            </over:aanleverpunt>
            <over:sessieId>64fd2abc-bf28-4c2c-a084-83a394232b19</over:sessieId>
         </over:overdracht>
      </over:overdrachtResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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

<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 Aanleverpunt (mits actief).

NB: type van teruggegeven AP is altijd van doel 'OV' én type 'LAS' of 'RP'

Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSO:2017/Initiëren_sessie/overstap&oldid=8121"