OSO:2018/Versturen Terugkoppeling

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

Overstapservice Onderwijs-symbol.png Overstapservice Onderwijs: 2018/Versturen Terugkoppeling

Actor(s) Goal(s)
Bronsysteem Ontvangen Terugkoppeling van Doelsysteem.
Doelsysteem Versturen Terugkoppeling naar Bronsysteem.

NB: Bij deze beschrijving wordt Bronsysteem gebruikt als het SWV- of RP-systeem dat een Terugkoppeling wil versturen.

  • Bronsysteem: Het SWV/RP systeem dat (voorafgaand aan deze uitwisseling) een Dossier heeft ontvangen
  • Doelsysteem: Het LAS dat de Terugkoppeling ontvangt (en voorafgaand aan deze uitwisseling een Dossier heeft verstuurd).

Dit betekent dat de richting van de Terugkoppeling wordt aangehouden en wordt afgeweken(!) van de richting van de Dossier uitwisseling .

Preconditie

  • Bronsysteem is aangesloten op OSO keten
  • Bronsysteem heeft TerugkoppelingMelding verstuurd naar Traffic Center
  • Bronsysteem heeft Dossier opgevraagd bij Doelsysteem met behulp van KoppelSleutel
  • Doelsysteem is aangesloten op OSO keten

Postconditie

  • Doelsysteem heeft Terugkoppeling ontvangen van Bronsysteem


Basis scenario

  1. Bronsysteem verstuurt Terugkoppeling naar Doelsysteem
  2. Doelsysteem stuurt bevestiging ontvangst Terugkoppeling aan Doelsysteem*
  3. Doelsysteem toont Terugkoppeling gegevens aan Eindgebruiker (Doelsysteem)**
  4. IF Doelsysteem heeft bevestiging ontvangen
    1. Bronsysteem toont bevestiging aan Eindgebruiker (Bronsysteem)
  5. ELSE
    1. Bronsysteem toont melding aan Eindgebruiker (Bronsysteem)***
  6. ENDIF

*Deze bevestiging is impliciet op basis van correct ontvangen van bericht
**Het Doelsysteem toont de informatie uit de notificatie aan de eindgebruiker bij het desbetreffende Dossier. OSO vereist compleetheid van de informatie, maar stel geen verdere eisen aan de manier waarop een Doelsysteem dit inricht.
*** Het Bronsysteem doet één poging per Terugkoppeling om deze te versturen naar het Doelsysteem; er volgen geen nieuwe (automatische) pogingen wanneer de aflevering faalt. Het Bronsysteem toont haar eindgebruiker informatie over het wel of niet succesvol versturen van de Terugkoppeling. De eindgebruiker kan dan een nieuwe poging initiëren voor het versturen van een Terugkoppeling.

Uitzonderingen en meldingen

Hieronder worden alternatieve scenario's en de bijbehorende melding opgesomd:
.

Resultaat Omschrijving Toelichting Melding aan Eindgebruiker
TerugkoppelingOntvangen De Terugkoppeling is succesvol ontvangen door het Doelsysteem. Doelsysteem toont informatie van Terugkoppeling bij overeenkomstig Dossier. Zie opmerking over gebruik bron- en doel- systeem boven.
OnbekendeKoppelsleutel Het Doelsysteem kent deze KoppelSleutel niet Doelsysteem kan Terugkoppeling niet herleiden naar Dossier omdat Doelsysteem koppelsleutel niet kent en meldt dit aan het Bronsysteem. Bronsysteem toont fout aan eindgebruiker.
NietOndersteund Het Doelsysteem ondersteunt dit type OSO uitwisseling niet. Het Doelsysteem geeft aan dat een Terugkoppeling is ontvangen, maar dat dit systeem deze functionaliteit niet ondersteund. Er vindt geen verdere verwerking plaats. De school waar de melding naar toe wordt verstuurd, heeft een systeem dat geen functie heeft voor het ontvangen van terugkoppelingen van dossiers. Neem contact op met de betreffende school.
<Geen response> Technische fout Het meldende Bronsysteem staakt de verdere Terugkoppeling en geeft de eindgebruiker hierover een foutmelding. Er kan geen verbinding gemaakt worden met het OSO systeem. Probeer het later nog eens.

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:terugkoppelingRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <ns:bronAanleverpuntIndex>100</ns:bronAanleverpuntIndex>
         <ns:doelBrin>00YY</ns:doelBrin>
         <ns:doelAanleverpuntIndex>0</ns:doelAanleverpuntIndex>
         <ns:koppelsleutel>19677A96-B737-402E-B3B8-24A3EEF32000</ns:koppelsleutel>
         <!--Optional:-->
         <ns:status>?</ns:status>
         <!--Optional:-->
         <ns:regelingsnummer>?</ns:regelingsnummer>
         <!--Optional:-->
         <ns:opmerkingen>?</ns:opmerkingen>
         <ns:datumtijd>2016-03-06T14:19:39.977+02:00</ns:datumtijd>
         <!--Optional:-->
         <ns:documenten>
            <!--1 or more repetitions:-->
            <ns:document>
               <ns:bestandsnaam>?</ns:bestandsnaam>
               <!--Optional:-->
               <ns:omschrijving>?</ns:omschrijving>
               <ns:bestandsinhoud>?</ns:bestandsinhoud>
            </ns:document>
         </ns:documenten>
      </ns:terugkoppelingRequest>
   </soapenv:Body>
</soapenv:Envelope>


Element Uitleg Opmerkingen
bronBRIN Dit is het brinnummer van het Bronsysteem dat de Terugkoppeling verstuurt. verplicht
bronAanleverpuntIndex Dit is de index van het Aanleverpunt van het Bronsysteem dat de Terugkoppeling verstuurt. verplicht
doelBrin Dit is het BRINnummer van de Bronschool dat de Terugkoppeling ontvangt verplicht
doelAanleverpuntIndex Dit is de index van het Aanleverpunt van het Doelsysteem dat de Terugkoppeling ontvangt. verplicht
KoppelSleutel De KoppelSleutel die eerder is ontvangen door Bronsysteem van het Doelsysteem via een Notificatie met KoppelSleutel. verplicht
Status Informatie over de status van de Aanvraag (vrij tekstveld) optioneel
Datum Tijdstip waarop de Terugkoppeling werd verstuurd in het Bronsysteem. verplicht
Bijlage(n) Meegeleverde document(en). Hiervoor gelden dezelfde afspraken als die voor bijlagen bij een Dossier gelden.
  • Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:terugkoppelingResponse>
         <ns:terugkoppelingResultaat>TerugkoppelingOntvangen</ns:terugkoppelingResultaat>
      </ns:terugkoppelingResponse>
   </soapenv:Body>
</soapenv:Envelope>