OSO:2018/Opvragen dossier/overdracht

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

Overstap Variant

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

Preconditie

  • Dossier is klaargezet door schoolmedewerker (Bronschool) voor Doelschool
  • Geldige sessie voor opvragen Dossier is toegekend door TC aan Doelsysteem


  • DoelSysteem is toegelaten op OSO keten
  • DoelSysteem heeft geldig OSO certificaat
  • DoelSysteem heeft geldige Sessie voor opvragen Dossier
  • BronSysteem is toegelaten op OSO keten
  • BronSysteem heeft geldig OSO certificaat toegekend door TC

Postconditie

Dossier is verzonden van Doelsysteem naar Bronsysteem

Basis Scenario

  1. Doelsysteem vraag dossier op #
  2. Bronsysteem laat <LINK NAAR SESSIE CONTROLE>Sessie gegevens Controleren bij TC*
  3. If sessie gegevens valide blijken !
    1. Bronsysteem slaat aanvraag gegevens (bsn, sessie id, documentRequest, doel brin, doel ap index, aanvraagDatum) op ten behoeve van LINK NAAR NOTIFICAITE
    2. If dossier gereed is voor overdracht** And Dossier aan Doelsysteem overgedragen mag worden*** And verzameldatum van Dossier voldoet**** And DossierVersie is correct
      1. Bronsysteem verstuurt dossier
    3. Else
      1. Bronsysteem verstuurt foutmelding*****
  4. Else
    1. Bronsysteem verstuurt foutmelding*****

# Een Doelsysteem kan aangeven dat het alleen geínteresseerd is in een 'geactualiseerd' Dossier. Zie ook punt ****
*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>Dossier is klaargezet en (indien van toepassing) inzage heeft plaats gevonden
***Bij het Dossier is door de Eindgebruiker (Bronsysteem) <LINK NAAR KLAARZETTEN>aangegeven dat het opgevraagd mag worden door de School (BRIN).
****Als de optionele parameter in het documentRequest ‘aanvraagdatum’ door het Doelsysteem is ingevuld, vergelijkt het bronsysteem deze waarde met de verzameldatum van het Dossier:

  • Als de ‘aanvraagDatum’ kleiner is dan de verzameldatum van het dossier ('na de vorige aanvraag is het dossier aangepast en ingezien'), volgt de ‘normale’ afhandeling van het request.
  • Als de ‘aanvraagDatum’ groter of gelijk is dan de verzameldatum van het dossier ('na de vorige aanvraag is het dossier niet aangepast') geeft het bronsysteem de (nieuwe) melding ‘LeerlingInfoNietGewijzigd’ (als het dossier wel klaar staat voor het bronsysteem).
  • Als de parameter niet is ingevuld, volgt de ‘normale’ afhandeling van het request.

Aanroep en antwoord

  • Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
   <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/xKgjcxwvxryvCveYeefn3NzZY8xCyC3UIpR62S7nVMV51q8XJpgyucEUAmzrXr+aEfkINN9xAZehsINL6mvvNPFskIbZzSgFUTDpI=</ns:zoeksleutel>
         <ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
         <ns:sessieId>fe6b2710-3fe5-468e-822d-e2b409a9f0d0</ns:sessieId>
         <ns:pgn>
            <ns:bsn>123123121</ns:bsn>
         </ns:pgn>
         <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)
koppelsleutel De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem Dit veld moet leeg zijn bij deze variant(!)
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.kennisnet.nl/schemas/Overstapservice/20180404">
<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>