OSO:2017/Opvragen dossier/aanvraag: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met '==SWV Aanvraag Variant== {|class="wikitable" ! style="text-align:left;"| Actor(s) ! style="text-align:left;"| Goal(s) |- | Doelsysteem | Doelsysteem heeft dossier...')
 
Regel 35: Regel 35:
 
<sup>!</sup>Alleen bij het resultaat 'Sessie is valide' mag een Dossier uitgeleverd worden(!)<br />
 
<sup>!</sup>Alleen bij het resultaat 'Sessie is valide' mag een Dossier uitgeleverd worden(!)<br />
 
<sup>**</sup>Het <LINK NAAR KLAARZETTEN>Formeel geldt deze controle nog; in praktijk wordt uitwisseling op basis KoppelSleutel geinitieerd door klaar zetten Dossier.
  
<sup>**</sup>Het <LINK NAAR KLAARZETTEN>Formeel geldt deze controle nog; in praktijk wordt uitwisseling op basis KoppelSleutel geinitieerd door klaar zetten Dossier.
  +
  +
==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/20160411">
  +
<soapenv:Header/>
  +
<soapenv:Body>
  +
<ns:documentRequest>
  +
<ns:bronBrin>00YY</ns:bronBrin>
  +
<ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
  +
<ns:doelBrin>12SS</ns:doelBrin>
  +
<ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
  +
<ns:zoeksleutel>yl/xKgjcxwvxryvCveYeefn3NzZY8xCyC3UIpR62S7nVMV51q8X ... JpgyucEUAmzrXr+aEfkINN9xAZehsINL6mvvNPFskIbZzSgFUTDpI=</ns:zoeksleutel>
  +
<ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
  +
<ns:sessieId>fe6b2710-3fe5-468e-822d-e2b409a9f0d0</ns:sessieId>
  +
<!--Optional:-->
  +
<ns:pgn>
  +
<!--You have a CHOICE of the next 2 items at this level-->
  +
<ns:bsn>123123121</ns:bsn>
  +
</ns:pgn>
  +
<!--Optional:-->
  +
<ns:aanvraagdatum>2016-03-06T14:19:39.977+02:00</ns:aanvraagdatum>
  +
</ns:documentRequest>
  +
</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 BRIN van de bronschool.
  +
|
  +
  +
|-
  +
| bronAPindex
  +
| Dit is de index van het aanleverpunt van het bronsysteem dat dit verzoek ontvangt.
  +
|
  +
  +
|-
  +
| doelBrin
  +
| Dit is het BRIN van de doelschool
  +
|
  +
  +
|-
  +
| doelAPindex
  +
| Dit is de index van het Aanleverpunt van het Bronsysteem dat dit verzoek indient.
  +
|
  +
  +
|-
  +
| zoeksleutel
  +
| Dit is de versleutelde PGN
  +
| Dit moet exact overeenkomen met de zoeksleutel zoals meegegeven bij het aanvragen van een sessie (wordt door Doelsysteem gegenereerd bij aanvragen Sessie)
  +
  +
|-
  +
| overdrachtsoort
  +
| Dit bepaalt om wat voor soort overdracht het gaat, een overstapdossier of overdrachtbinnenbrin.
  +
| De overdrachtsoort wordt overeenkomen met de overdrachtsoort welke gebruikt is in het overdrachtsRequest. Het BRIN-nummer van het bron- en doelBRIN moet hetzelfde zijn voor een binnenbrin overdracht.
  +
  +
|-
  +
| sessieId
  +
| De sessie-ID die verkregen is bij het Initiëren van de Sessie.
  +
|
  +
  +
|-
  +
| PGN
  +
| Het BSN of Onderwijsnummer van de leerling (verplicht)
  +
| Dit wordt onversleuteld verstuurd in het documentRequest
  +
  +
|-
  +
| aanvraagdatum
  +
| Als de optionele parameter ‘aanvraagdatum’ door het doelsysteem is ingevuld, dan vergelijkt het bronsysteem de aanvraagdatum met de verzameldatum van het dossier. De uitkomst van die vergelijking bepaalt het antwoord van het bronsysteem.
  +
| De aanvraagdatum is optioneel
  +
|}
  +
  +
  +
*Response
  +
  +
<syntaxhighlight lang="xml">
  +
<?xml version="1.0" encoding="UTF-8"?>
  +
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://xml.eld.nl/schemas/Overstapservice/20160411">
  +
<SOAP-ENV:Body>
  +
<ns1:documentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.w3.org/2001/XMLSchema">
  +
<ns1:fout>LeerlinginfoNietBeschikbaar</ns1:fout>
  +
</ns1:documentResponse>
  +
</SOAP-ENV:Body>
  +
</SOAP-ENV:Envelope>
  +
</syntaxhighlight>

Versie van 10 feb 2017 14:33

SWV Aanvraag Variant

Actor(s) Goal(s)
Doelsysteem Doelsysteem heeft dossier van specifieke leerling ontvangen
Bronsysteem Verzoek tot overhandigen specifiek dossier afgehandeld

Preconditie

  • Geldige sessie voor opvragen Dossier is toegekend door TC aan Doelsysteem
  • Doelsysteem heeft Koppelsleutel ontvangen van Bronsysteem

Postconditie

Dossier is verzonden van Doelsysteem naar Bronsysteem


SWV Aanvraag Scenario

  1. Doelsysteem vraagt dossier op mbv KoppelSleutel #
  2. Bronsysteem laat <LINK NAAR SESSIE CONTROLE>Sessie gegevens Controleren]] bij TC*
  3. IF sessie gegevens valide blijken !
    1. IF dossier gereed is voor overdracht** AND Dossier aan Doelsysteem overgedragen mag worden*** AND DossierVersie is correct
      1. Bronsysteem verstuurt dossier
    2. Else
      1. Bronsysteem verstuurt foutmelding*****
  4. Else
    1. Bronsysteem verstuurt foutmelding*****

*Dit is een verplichte stap
Deze controle moet voor de andere controles worden uitgevoerd door het Bronsysteem. Als de Sessie gegevens incorrect blijken, moet dit worden teruggegeven aan het Doelsysteem. Pas daarna volgen de andere stappen en controles.
!Alleen bij het resultaat 'Sessie is valide' mag een Dossier uitgeleverd worden(!)
**Het <LINK NAAR KLAARZETTEN>Formeel geldt deze controle nog; in praktijk wordt uitwisseling op basis KoppelSleutel geinitieerd door klaar zetten Dossier.

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:documentRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
         <ns:doelBrin>12SS</ns:doelBrin>
         <ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
         <ns:zoeksleutel>yl/xKgjcxwvxryvCveYeefn3NzZY8xCyC3UIpR62S7nVMV51q8X ... JpgyucEUAmzrXr+aEfkINN9xAZehsINL6mvvNPFskIbZzSgFUTDpI=</ns:zoeksleutel>
         <ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
         <ns:sessieId>fe6b2710-3fe5-468e-822d-e2b409a9f0d0</ns:sessieId>
         <!--Optional:-->
         <ns:pgn>
            <!--You have a CHOICE of the next 2 items at this level-->
            <ns:bsn>123123121</ns:bsn>
         </ns:pgn>
         <!--Optional:-->
         <ns:aanvraagdatum>2016-03-06T14:19:39.977+02:00</ns:aanvraagdatum>
      </ns:documentRequest>
   </soapenv:Body>
</soapenv:Envelope>


Element Uitleg Opmerkingen
bronBrin Dit is het BRIN van de bronschool.
bronAPindex Dit is de index van het aanleverpunt van het bronsysteem dat dit verzoek ontvangt.
doelBrin Dit is het BRIN van de doelschool
doelAPindex Dit is de index van het Aanleverpunt van het Bronsysteem dat dit verzoek indient.
zoeksleutel Dit is de versleutelde PGN Dit moet exact overeenkomen met de zoeksleutel zoals meegegeven bij het aanvragen van een sessie (wordt door Doelsysteem gegenereerd bij aanvragen Sessie)
overdrachtsoort Dit bepaalt om wat voor soort overdracht het gaat, een overstapdossier of overdrachtbinnenbrin. De overdrachtsoort wordt overeenkomen met de overdrachtsoort welke gebruikt is in het overdrachtsRequest. Het BRIN-nummer van het bron- en doelBRIN moet hetzelfde zijn voor een binnenbrin overdracht.
sessieId De sessie-ID die verkregen is bij het Initiëren van de Sessie.
PGN Het BSN of Onderwijsnummer van de leerling (verplicht) Dit wordt onversleuteld verstuurd in het documentRequest
aanvraagdatum Als de optionele parameter ‘aanvraagdatum’ door het doelsysteem is ingevuld, dan vergelijkt het bronsysteem de aanvraagdatum met de verzameldatum van het dossier. De uitkomst van die vergelijking bepaalt het antwoord van het bronsysteem. De aanvraagdatum is optioneel


  • Response
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://xml.eld.nl/schemas/Overstapservice/20160411">
<SOAP-ENV:Body>
<ns1:documentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.w3.org/2001/XMLSchema">
   <ns1:fout>LeerlinginfoNietBeschikbaar</ns1:fout>
</ns1:documentResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSO:2017/Opvragen_dossier/aanvraag&oldid=6567"