OSO:2017/Initiëren notificatie

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen

Overstapservice Onderwijs-symbol.png Overstapservice Onderwijs: 2017/Initiëren notificatie

Actor(s) Goal(s)
Bronsysteem Melden dat Bronsysteem Notificatie aan Doelsysteem wil versturen en adres van Aanleverpunt ontvangen.
Traffic Center Controleren of Notificatie verstuurd kan worden en zorgen dat Notificatie bij juist Aanleverpunt wordt afgeleverd.

School variant SWV variant

Basis scenario

  1. Bronsysteem verstuurt Notificatie Request naar Traffic Center
  2. IF DoelAanleverpunt is actief
    1. IF NotificatieType is 'Overstap' AND SessieID is ingevuld AND SessieID is bekend bij TC *
      1. Traffic Center registreert het Notificatie Request
      2. Traffic Center geeft url van het Doelaanleverpunt terug
    2. ELSE IF NotificatieType is 'Aanvraag' AND Koppelsleutel is leeg AND SessieID is leeg **
      1. Traffic Center genereert Koppelsleutel
      2. Traffic Center geeft Koppelsleutel en url van het Doelaanleverpunt terug
    3. ELSE IF NotificatieType is 'Terugkoppeling' AND Koppelsleutel is ingevuld AND Koppelsleutel is bekend bij TC ***
      1. Traffic Center registreert het Notificatie Request
      2. Traffic Center geeft url van het Doelaanleverpunt terug
    4. ELSE
      1. Traffic Center geeft foutmelding
  3. ELSE
    1. Traffic Center geeft foutmelding
*SessieID ingevuld
Notificatie nav eerder verzoek tot levering Dossier. SessieID wordt vergeleken met binnengekomen Sessie Controle verzoeken. Daarbij worden ook gecontroleerd dat de bron-BRIN/APindex én de doel-BRIN/APindex overeenkomen met het originele verzoek waar het sessieID aan werd toegekend.
**Beide parameters leeg
Verzoek om koppelsleutel (Notificatie tbv Aanvraag naar Samenwerkingsverband )
***Koppelsleutel ingevuld
Verzoek om Notificatie naar oorspronkelijke Bronsysteem (Notificatie tbv Terugkoppeling naar Samenwerkingsverband )

Alternatieve scenario's:

WELKE FOUTEN WILLEN WE GAAN CHECKEN MET TC!? Hieronder worden alternatieve scenario's en de bijbehorende melding opgesomd:
.

Resultaat A/E* Omschrijving Toelichting
AanvragerNietBekend E Het bronsysteem (aanleverpunt dat de notificatie meldt) is niet bekend bij het Traffic Center. De aanvrager is niet gerechtigd om de overstapservice te gebruiken. In het Traffic Center register is de combinatie van bronBrin en bronAanleverpuntIndex niet aanwezig.
AanvragerAanleverpuntNietBekend E Het bronAanleverpuntIndex is niet geregistreerd voor deze aanvrager (bronBrin).
AanvragerNietBeschikbaar E De aanvrager (bronBrin) is niet gerechtigd om de overstapservice te gebruiken.
OngeautoriseerdAanleverpunt E Het OIN van het certificaat komt niet overeen met die van de geregistreerde leverancier. Het bronsysteem (aanleverpunt dat Notificatie meldt) is in het Traffic Center register geregistreerd door een andere leverancier. Het aanleverpunt (bronBrin/bronAanleverpuntIndex) is bekend bij OSO, maar het aanleverpunt staat geregistreerd bij een andere leverancier.
VerstrekkerNietBekend E De verstrekker (het doelsysteem waar de notificatie naartoe verstuurd moet worden) is niet bekend bij het Traffic Center.
VerstrekkerAanleverpuntNietBekend E Het meegegeven aanleverpunt is niet geregistreerd voor deze verstrekker. Het opgegeven Aanleverpunt (DoelBRIN/APindex) van het Doelsysteem is niet bekend. Het opgegeven Aanleverpunt van het Doelsysteem is (nog) niet opgenomen in het Register.
VerstrekkerNietBeschikbaar A De verstrekker is niet gerechtigd om de overstapservice te gebruiken. Het opgegeven Aanleverpunt van het Doelsysteem is (nog) niet gerechtigd om de overstapservice te gebruiken. De Doelschool is bekend in het Register, maar het opgegeven Aanleverpunt is (nog) niet actief. Dit kan bijvoorbeeld veroorzaakt worden doordat de URL van dit Aanleverpunt niet (goed) is geregistreerd.
SessieIDNietBekend A Het opgegeven SessieID is niet bekend in de log van het Traffic Center. Het SessieID dat de BronSchool opgeeft is niet opgeslagen als geldig SessieID bij het Traffic Center.
<Geen response> E Technische fout Het meldende Bronsysteem staakt de verdere Notificatie en geeft de eindgebruiker hierover een foutmelding.

* A: Alternatief, E: Exceptie (fout)

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:meldenNotificatieRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
         <ns:doelBrin>12SS</ns:doelBrin>
         <ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
         <ns:sessieId>698867e4-231d-44b1-9e80-63af1a3a75b6</ns:sessieId>
         <ns:aanvraagdatum>2016-03-06T14:19:39.977+02:00</ns:aanvraagdatum>
      </ns:meldenNotificatieRequest>
   </soapenv:Body>
</soapenv:Envelope>


Element Uitleg Opmerkingen
bronBRIN Dit is het BRINnummer van de Bronschool dat het DocumentRequest heeft ontvangen en een Notificatie naar het Doelsysteem wil sturen. Verplicht
bronAanleverpuntIndex Dit is de index van het Aanleverpunt van het Bronsysteem dat het DocumentRequest naar het Bronsysteem heeft verstuurd. Verplicht
doelBrin Dit is het brinnummer van het Doelsysteem dat het documentRequest heeft ingediend bij het Bronsyteem. Verplicht
doelAanleverpuntIndex Dit is de index van het Aanleverpunt van het Doelsysteem dat de Sessie aanvraagt. Verplicht
sessieId Het sessieId van het laastste documentRequest dat het bronSysteem van het doelsysteem heeft ontvangen. Dus het sessieId dat de laatste keer gebruikt is bij het opvragen van het dossier. Verplicht
aanvraagdatum Het tijdstip van het laastste documentRequest dat door het doelssysteem is gestuurd om het dossier op te vragen. Het bronssysteem heeft dit tijdstip bewaard. Verplicht
  • Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<over:meldenNotificatieResponse xmlns:over="http://xml.eld.nl/schemas/Overstapservice/20160411">
  <over:aanleverpunt>
    <over:code>102</over:code>
    <over:url>https://aanleverpunturl.nl</over:url>
    <over:type>LAS</over:type>
    <over:label>12SS0102 LAS Testschool Triple W ICT PO</over:label>
  </over:aanleverpunt>
</over:meldenNotificatieResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>