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

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
k
 
(13 tussenliggende versies door een andere gebruiker niet weergegeven)
Regel 1: Regel 1:
−
==Aanvraag (SWV) variant==
 +
==Uitwisseling tbv aanvraag bij Samenwerkingsverband (SWV) variant==
   
 
{|class="wikitable"
  
{|class="wikitable"
Regel 5: Regel 5:
 
! style="text-align:left;"| Goal(s)
  
! style="text-align:left;"| Goal(s)
 
|-
  
|-
−
| DoelSysteem
 +
| DoelSysteem (RP of SWV)
 
| Geldige sessie toegekend krijgen voor opvragen specifiek dossier. Een sessie geldt altijd voor één specifiek dossier.
  
| Geldige sessie toegekend krijgen voor opvragen specifiek dossier. Een sessie geldt altijd voor één specifiek dossier.
 
|-
  
|-
 
| Traffic Center
  
| 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.
 +
| 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. De aanvraag wordt altijd gedaan bij het specifieke Aanleverpunt dat de Notificatie verzonden heeft.
 
|}
  
|}
   
  +
==Preconditie==
  +
*Doelsysteem is toegelaten op OSO keten
  +
*Doelsysteem heeft geldig ''OSO certificaat''
  +
*Doelsysteem heeft Notificatie ontvangen van BronSysteem met KoppelSleuutel
   
  +
==Postconditie==
−
# Doelsysteem vraagt Sessie aan bij TC voor Overdracht van Dossier
  
  +
*TC heeft DoelSysteem Sessie toegekend voor opvragen Dossier bij aangeduid Aanleverpunt van Bronsysteem.
−
# '''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 '''
  
  +
* Doelsysteem heeft Aanleverpunt informatie met doel 'PaO' behorend bij bronBRIN ontvangen.
−
## Traffic Center kent een sessie toe aan het Bronsysteem
  
−
## Traffic Center verstrekt url van het te bevragen Aanleverpunt <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>In deze variant (SWV aanvraag) mag alleen specifiek aanleverpunt bevraagd worden.<br />
  
−
<sup>***</sup>In dit geval kan de Sessie niet afgemeld worden.<br />
  
   
  +
==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>00AH</ns:bronBrin>
  +
<ns:bronAanleverpuntIndex>1</ns:bronAanleverpuntIndex>
  +
<ns:doelBrin>00AH</ns:doelBrin>
  +
<ns:doelAanleverpuntIndex>19</ns:doelAanleverpuntIndex>
  +
<ns:koppelsleutel>19677A96-B737-402E-B3B8-24A3EEF32000</ns:koppelsleutel>
  +
<ns:overdrachtsoort>swvaanvraag</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 (verplicht).
  +
|
  +
  +
|-
  +
| 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 mag niet voorkomen in dit type uitwisseling!'''
  +
  +
|-
  +
| koppelsleutel
  +
| De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem
  +
| De koppelsleutel is verplicht voor dit type uitwisseling
  +
  +
|-
  +
| overdrachtsoort
  +
| De overdrachtsoort moet voor dit type uitwisseling 'SWVaanvraag' 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>19</over:code>
  +
<over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
  +
<over:type>SWV</over:type>
  +
<over:label>00AH00019 SWV Het Stedelijk Lyceum locatie Kottenpark</over:label>
  +
</over:aanleverpunt>
  +
<over:sessieId>cdf5c4d1-9cca-4116-9ed6-ab575fc230a8</over:sessieId>
  +
</over:overdracht>
  +
</over:overdrachtResponse>
  +
</SOAP-ENV:Body>
  +
</SOAP-ENV:Envelope>
  +
</syntaxhighlight>
  +
*'''NB:''' type van teruggegeven AP is altijd of 'RP' of 'SWV'
  +
  +
[[Categorie:Overstapservice Onderwijs]]
  +
[[Category:Book OSO|77]]
   
 
==Opvragen met Koppelsleutel ipv Zoeksleutel ==
  
==Opvragen met Koppelsleutel ipv Zoeksleutel ==
Regel 32: Regel 107:
   
   
−
==Aanroep en Antwoord==
  
−
NOG DOEN
  
   
 
[[Categorie:Overstapservice Onderwijs]]
  
[[Categorie:Overstapservice Onderwijs]]
−
[[Category:Book OSO|74]]
  

Huidige versie van 19 mrt 2018 om 13:45

Uitwisseling tbv aanvraag bij Samenwerkingsverband (SWV) variant

Actor(s) Goal(s)
DoelSysteem (RP of SWV) 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. De aanvraag wordt altijd gedaan bij het specifieke Aanleverpunt dat de Notificatie verzonden heeft.

Preconditie

  • Doelsysteem is toegelaten op OSO keten
  • Doelsysteem heeft geldig OSO certificaat
  • Doelsysteem heeft Notificatie ontvangen van BronSysteem met KoppelSleuutel

Postconditie

  • TC heeft DoelSysteem Sessie toegekend voor opvragen Dossier bij aangeduid Aanleverpunt van Bronsysteem.
  • Doelsysteem heeft Aanleverpunt informatie met doel 'PaO' behorend bij bronBRIN ontvangen.

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>00AH</ns:bronBrin>
         <ns:bronAanleverpuntIndex>1</ns:bronAanleverpuntIndex>
         <ns:doelBrin>00AH</ns:doelBrin>
         <ns:doelAanleverpuntIndex>19</ns:doelAanleverpuntIndex>
         <ns:koppelsleutel>19677A96-B737-402E-B3B8-24A3EEF32000</ns:koppelsleutel>
         <ns:overdrachtsoort>swvaanvraag</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 (verplicht).
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 mag niet voorkomen in dit type uitwisseling!
koppelsleutel De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem De koppelsleutel is verplicht voor dit type uitwisseling
overdrachtsoort De overdrachtsoort moet voor dit type uitwisseling 'SWVaanvraag' 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>19</over:code>
               <over:url>https://hetstedelijk.swp.nl/osoverstrekker.axd</over:url>
               <over:type>SWV</over:type>
               <over:label>00AH00019 SWV Het Stedelijk Lyceum locatie Kottenpark</over:label>
            </over:aanleverpunt>
            <over:sessieId>cdf5c4d1-9cca-4116-9ed6-ab575fc230a8</over:sessieId>
         </over:overdracht>
      </over:overdrachtResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • NB: type van teruggegeven AP is altijd of 'RP' of 'SWV'

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.

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