OSO:2017/Versturen Notificatie

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen

Overstapservice Onderwijs-symbol.png Overstapservice Onderwijs: 2017/Versturen Notificatie

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

Splitsen:

Basis scenario

  1. Bronsysteem verstuurt Notificatie naar Doelsysteem

Postconditie

  • Doelsysteem heeft Notificatie ontvangen van Bronsysteem

Basis scenario

  1. Bronsysteem verstuurt Notificatie naar Doelsysteem
  2. Als Doelsysteem Notificatietype ondersteunt AND Doelsysteem kent Koppelsleutel
    1. Doelsysteem stuurt bevestiging ontvangst Notificatie aan BronSysteem*
    2. Doelsysteem toont Notificatie gegevens aan Eindgebruiker (Doelsysteem)**
    3. If Bronsysteem heeft bevestiging ontvangen
      1. BronSysteem toont bevestiging aan Eindgebruiker (Bronsysteem)
    4. Else
      1. BronSysteem toont melding aan Eindgebruiker (Bronsysteem)***
  3. Else
    1. Doelsysteem stuurt foutcode naar Bronsysteem
    2. Bronsysteem toon foutmelding aan Eindgebruiker (Bronsysteem)


*Deze bevestiging is impliciet op basis van correct ontvangen van bericht
**Het doelsysteem toont de informatie uit de notificatie aan de eindgebruiker. De eindgebruiker kan een dossier opvraag sessie starten.
NB: De in de Notifciatie meegestuurde SessieID kan/mag NIET gebruikt worden voor het (opnieuw) opvragen van het dossier(!).
*** Het bronsysteem doet één poging per notificatie om deze te versturen na het doelsysteem; er volgen geen nieuwe pogingen wanneer de aflevering faalt. Het bronsysteem toont haar eindgebruiker informatie over het wel of niet succesvol versturen van de notificatie.

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:notificatieRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
         <ns:doelBrin>00YY</ns:doelBrin>
         <ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
         <ns:pgn>
            <!--You have a CHOICE of the next 2 items at this level-->
            <ns:bsn>123123121</ns:bsn>
            <!--ns:onderwijsnummer>?</ns:onderwijsnummer-->
         </ns:pgn>
         <ns:aanvraagdatum>2016-03-06T14:19:39.977+02:00</ns:aanvraagdatum>
      </ns:notificatieRequest>
   </soapenv:Body>
</soapenv:Envelope>
Element Uitleg Opmerkingen
bronBRIN Dit is het BRINnummer van de Bronschool dat de Notificatie wil versturen. verplicht
bronAanleverpuntIndex Dit is de index van het Aanleverpunt van het Bronsysteem dat de Notificatie wil versturen. verplicht
doelBrin Dit is het brinnummer van het Doelsysteem dat de Notificatie ontvangt. verplicht
doelAanleverpuntIndex Dit is de index van het Aanleverpunt van het Doelsysteem dat de Notificatie ontvangt. verplicht
pgn Het pgn van het betreffende Dossier (bsn of onderwijsnummer). verplicht
aanvraagdatum Het tijdstip van het laastste documentRequest dat door het bronSysteem is ontvangen over dit dossier (pgn). verplicht
  • 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:notificatieResponse>
      <ns1:resultaat>NotificatieOntvangen</ns1:resultaat>
   </ns1:notificatieResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>