OSO:2018/Initiëren notificatie

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

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

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

Basisvariant: Notificatie voor Dossier overdracht

Een Notificatie wordt verstuurd door Bronsystemen op het moment dat een Dossier klaar wordt gezet, waarvoor eerder een verzoek tot levering van een (of meerdere) Doelsyste(e)men is ontvangen. Een Notificatie wordt altijd naar het specifieke Aanleverpunt dat een verzoek heeft verstuurd geadresseerd. Het versturen van de Notificatie wordt hier verder uitgewerkt.

Basisvariant: Notificatie voor aanvraag bij Samenwerkingsverband

In dit geval wordt de Notificatie gebruikt voor het initiëren van een aanvraag bij een Samenwerkingsverband. Het Dossier wordt ook klaar gezet in het Bronsysteem (maar er is geen eerder verzoek nodig), waarna een specifiek Aanleverpunt door de eindgebruiker moet worden gekozen. De Notificatie wordt alleen naar dit Aanleverpunt verstuurd. Het versturen van de Notificatie wordt hier verder uitgewerkt.

Basis scenario

  1. Bronsysteem verstuurt Notificatie Request naar Traffic Center
  2. IF overdrachtdoel is 'overstapdossier'
    1. IF DoelAanleverpunt is actief AND DoelAanleverpunt heeft 'doel' ingesteld op 'OV'
      1. IF SessieID is gezet AND SessieID is bekend bij TC *
        1. Traffic Center registreert het Notificatie Request
        2. Traffic Center geeft url van het Doelaanleverpunt terug
      2. ELSE
        1. Traffic Center geeft foutmelding
      3. ENDIF
    2. ELSE
      1. Traffic Center geeft foutmelding
    3. ENDIF
  1. ELSEIF overdrachtdoel is 'swv-aanvraag'
    1. IF DoelAanleverpunt is actief AND DoelAanleverpunt heeft 'doel' ingesteld op 'PaO'
      1. IF SessieID is leeg **
        1. IF (BRIN van DoelAP == BRIN van BronAP)
          1. Traffic Center genereert Koppelsleutel
          2. Traffic Center geeft Koppelsleutel en url van het Doelaanleverpunt terug
        2. ELSE
          1. Traffic Center geeft foutmelding
        3. ENDIF
      2. ELSE
        1. Traffic Center geeft foutmelding
      3. ENDIF
    2. ELSE
      1. Traffic Center geeft foutmelding
    3. ENDIF
  2. ENDIF
*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 )

Uitzonderingen en meldingen

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

Resultaat Omschrijving Toelichting Melding aan Eindgebruiker
AanvragerNietBekend 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. De aanvrager is niet gerechtigd om de overstapservice te gebruiken. Neem contact op met je leverancier.
AanvragerAanleverpuntNietBekend Het bronAanleverpuntIndex is niet geregistreerd voor deze aanvrager (bronBrin). Het bron aanleverpunt is niet bekend in het OSO systeem, hierdoor kan geen notificatie melding worden aangevraagd.
AanvragerNietBeschikbaar De aanvrager (bronBrin) is niet gerechtigd om de overstapservice te gebruiken. Je school is niet aangesloten op OSO. Neem contact op met de servicedesk van OSO.
OngeautoriseerdAanleverpunt 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. Interne fout bij OSO systeem. Neem contact op met de servicedesk van OSO.
VerstrekkerNietBekend De verstrekker (het doelsysteem waar de notificatie naartoe verstuurd moet worden) is niet bekend bij het Traffic Center. Het aanleverpunt van de school waarmee je wilt uitwisselen, is nog niet bekend bij OSO. Neem contact op met de betreffende school.
VerstrekkerAanleverpuntNietBekend 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. Het aanleverpunt van de school waarmee je wilt uitwisselen, is nog niet bekend bij OSO. Neem contact op met de betreffende school.
VerstrekkerNietBeschikbaar 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 De school waarmee je wilt uitwisselen, heeft geen actieve aanleverpunten bij OSO. Neem contact op met de betreffende school.
SessieIDNietBekend 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. Er heeft zich een interne fout voorgedaan tijdens het melden van de notificatie. Neem contact op met je software leverancier.
OVnotificatieIncorrect De overdrachtdoel is 'overstapdossier' maar SessieID en/of Aanvraagdatum zijn niet ingevuld. Voor een Notificatie zijn een eerder toegekend SessieID en Aanvraagdatum nodig. Er heeft zich een interne fout voorgedaan tijdens het melden van de notificatie. Neem contact op met je software leverancier.
OVnotificatieAPIncorrect Het doel is 'OV' ('overstapdossier') maar de bronAP heeft als doel 'PaO' of de doelAP heeft als doel 'PaO' ('Samenwerkingsverband') Een Notificatie met als doel 'overstapdossier' gespecificeerd mag niet naar AP's van type 'OV' worden verstuurd, maar kan alleen naar AP's van type 'LAS' of 'RP' worden verstuurd. Er heeft zich een interne fout voorgedaan tijdens het melden van de notificatie. Neem contact op met je software leverancier.
SWVnotificatieAPIncorrect Het doel is 'PaO' maar de de bron AP heeft als doel 'LAS" of de doelAP heeft als doel 'LAS' Een Notificatie met doel 'overstapdossier' kan alleen naar AP's van type 'PaO' of 'RP' verstuurd. Er heeft zich een interne fout voorgedaan tijdens het melden van de notificatie. Neem contact op met je software leverancier.
SWVnotificatieIncorrect Het doel is 'PaO' maar SessieID en/of Aanvraagdatum zijn ingevuld. Een Notificatie met doel'overstapdossier' kent geen SessieID of Aanvraagdatum. Er heeft zich een interne fout voorgedaan tijdens het melden van de notificatie. Neem contact op met je software leverancier.
SWVnotificatieGeenRelatieMetDoel Het doel is 'PaO' maar de BRIN van de DoelAP wijkt af van de BRIN van de BronAP. Een Notificatie van het overdrachtdoel 'overstapdossier' mag alleen naar AP's van dezelfde BRIN (school) verzonden worden. Er heeft zich een interne fout voorgedaan tijdens het melden van de notificatie. Neem contact op met je software leverancier.
<Geen response> Technische fout Het meldende Bronsysteem staakt de verdere Notificatie en geeft de eindgebruiker hierover een foutmelding. Er kan geen verbinding gemaakt worden met het OSO systeem. Probeer het later nog eens.