OSO:2017/Initiëren Terugkoppeling: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
Regel 3: Regel 3:
 
! style="text-align:left;"| Goal(s)
 
! style="text-align:left;"| Goal(s)
 
|-
 
|-
  +
| Doelsysteem
| Bronsysteem
 
| Melden dat Bronsysteem Terugkoppeling aan Doelsysteem wil versturen en adres van Aanleverpunt ontvangen.
+
| Melden dat Doelsysteem Terugkoppeling aan Bronsysteem wil versturen en adres van Aanleverpunt ontvangen.
 
|-
 
|-
 
| Traffic Center
 
| Traffic Center
Regel 10: Regel 10:
 
|}
 
|}
   
'''NB:''' Bij deze beschrijving wordt bronsysteem gebruikt als:
+
'''NB:''' Bij deze beschrijving wordt Doelsysteem gebruikt als:
* bronsysteem: Het SWV/RP dat de Terugkoppeling verstuurt (en voorafgaand een Notificatie met KoppelSleutel van het Bronsysteem heeft ontvangen.)
+
* Doelsysteem: Het SWV/RP systeem dat (voorafgaand aan deze uitwisseling) een Dossier heeft ontvangen
Dit betekent dat de richting van het bericht wordt gevolgd (en deze richting wijkt af van die van de uitwisseling van een Dossier(!))<br>
+
Dit betekent dat de richting van de Dossier uitwisseling wordt aangehouden en wordt afgeweken(!) van de richting van dit bericht.
   
 
==Preconditie==
 
==Preconditie==
*BronSysteem is aangesloten op OSO keten
+
*Doelsysteem is aangesloten op OSO keten
*BronSysteem heeft Koppelsleutel ontvangen via Notificatie
+
*Doelsysteem heeft Koppelsleutel ontvangen via Notificatie
*BronSysteem heeft Dossier opgevraagd bij Doelsysteem met behulp van KoppelSleutel
+
*Doelsysteem heeft Dossier opgevraagd bij Bronsysteem met behulp van KoppelSleutel
   
 
==Postconditie==
 
==Postconditie==
 
*Traffic Center heeft Terugkoppeling Melding geregistreerd
 
*Traffic Center heeft Terugkoppeling Melding geregistreerd
*BronSysteem heeft correcte url van Doelsysteem ontvangen
+
*Doelsysteem heeft correcte url van Bronsysteem ontvangen
   
 
==Basis scenario==
 
==Basis scenario==
# Bronsysteem verstuurt Terugkoppeling Melding naar Traffic Center
+
# Doelsysteem verstuurt Terugkoppeling Melding naar Traffic Center
 
# '''IF''' DoelAanleverpunt is actief AND DoelAanleverpunt heeft 'doel' ingesteld op 'PaO'
 
# '''IF''' DoelAanleverpunt is actief AND DoelAanleverpunt heeft 'doel' ingesteld op 'PaO'
 
## '''IF''' KoppelSleutel valide is<sup>*</sup>
 
## '''IF''' KoppelSleutel valide is<sup>*</sup>
Regel 46: Regel 46:
 
|-
 
|-
 
| <url van DoelAP>
 
| <url van DoelAP>
| TC geeft url van DoelAP terug naar Bronsysteem.
+
| TC geeft url van DoelAP terug naar Doelsysteem.
| Bronsysteem kan nu Terugkoppeling versturen naar Doelsysteem.
+
| Doelsysteem kan nu Terugkoppeling versturen naar Bronsysteem.
 
|
 
|
 
|-
 
|-
Regel 57: Regel 57:
   
 
|OngeautoriseerdAanleverpunt
 
|OngeautoriseerdAanleverpunt
|Bronsysteem (aanvragend AP) is in het Register geregistreerd met andere Leverancier.
+
|Doelsysteem (aanvragend AP) is in het Register geregistreerd met andere Leverancier.
 
|
 
|
 
|-
 
|-
Regel 72: Regel 72:
   
 
| AanvragerNietBeschikbaar
 
| AanvragerNietBeschikbaar
| Doelsysteem (aanvragend AP) is (nog) niet gerechtigd om gebruik te maken van de overstapservice
+
| Bronsysteem (aanvragend AP) is (nog) niet gerechtigd om gebruik te maken van de overstapservice
 
|
 
|
 
|-
 
|-
Regel 91: Regel 91:
 
|-
 
|-
 
| bronAanleverpuntIndex
 
| bronAanleverpuntIndex
| Dit is de index van het Aanleverpunt van het Bronsysteem dat bevraagd wordt (optioneel).
+
| Dit is de index van het Aanleverpunt van het Doelsysteem dat bevraagd wordt (optioneel).
| Deze parameter wordt alleen meegegeven worden wanneer het doelsysteem één specifiek Aanleverpunt van de School wil bevragen. In plaats van alle Aanleverpunten af te lopen bij een Bronschool wordt alleen het gespecificeerde Aanleverpunt bevraagd. Dit biedt Doelsystemen een mogelijkheid voor het ondersteunen van (V)SO-scholen.
+
| Deze parameter wordt alleen meegegeven worden wanneer het Bronsysteem één specifiek Aanleverpunt van de School wil bevragen. In plaats van alle Aanleverpunten af te lopen bij een Bronschool wordt alleen het gespecificeerde Aanleverpunt bevraagd. Dit biedt Doelsystemen een mogelijkheid voor het ondersteunen van (V)SO-scholen.
   
 
|-
 
|-
 
| doelBrin
 
| doelBrin
| Dit is het brinnummer van het Doelsysteem dat de Sessie aanvraagt. Het TC controleert of het Doelsysteem bekend en actief is in het deelnemersregister.
+
| Dit is het brinnummer van het Bronsysteem dat de Sessie aanvraagt. Het TC controleert of het Bronsysteem bekend en actief is in het deelnemersregister.
 
|
 
|
   
 
|-
 
|-
 
| doelAanleverpuntIndex
 
| doelAanleverpuntIndex
| Dit is de index van het Aanleverpunt van het Doelsysteem dat de Sessie aanvraagt.
+
| Dit is de index van het Aanleverpunt van het Bronsysteem dat de Sessie aanvraagt.
 
|
 
|
   
 
|-
 
|-
 
| koppelsleutel
 
| koppelsleutel
| De koppelsleutel zoals ontvangen in de Notificatie vanuit het Bronsysteem
+
| De koppelsleutel zoals ontvangen in de Notificatie vanuit het Doelsysteem
 
| De koppelsleutel is verplicht voor dit type uitwisseling
 
| De koppelsleutel is verplicht voor dit type uitwisseling
   

Versie van 9 mrt 2017 om 14:19

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

NB: Bij deze beschrijving wordt Doelsysteem gebruikt als:

  • Doelsysteem: Het SWV/RP systeem dat (voorafgaand aan deze uitwisseling) een Dossier heeft ontvangen

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

Preconditie

  • Doelsysteem is aangesloten op OSO keten
  • Doelsysteem heeft Koppelsleutel ontvangen via Notificatie
  • Doelsysteem heeft Dossier opgevraagd bij Bronsysteem met behulp van KoppelSleutel

Postconditie

  • Traffic Center heeft Terugkoppeling Melding geregistreerd
  • Doelsysteem heeft correcte url van Bronsysteem ontvangen

Basis scenario

  1. Doelsysteem verstuurt Terugkoppeling Melding naar Traffic Center
  2. IF DoelAanleverpunt is actief AND DoelAanleverpunt heeft 'doel' ingesteld op 'PaO'
    1. IF KoppelSleutel valide is*
      1. Traffic Center registreert de Notificatie Melding
      2. Traffic Center geeft url van het Doelaanleverpunt terug
    2. ELSE
      1. Traffic Center geeft foutmelding
  3. ELSE
    1. Traffic Center geeft foutmelding
  4. ENDIF

*Valide Koppelsleutel betekent dat de combinatie BronAP--KoppelSleutel--DoelAP is geregistreerd in het TC.

Uitzonderingen en meldingen

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

Resultaat Omschrijving Toelichting Melding aan Eindgebruiker
<url van DoelAP> TC geeft url van DoelAP terug naar Doelsysteem. Doelsysteem kan nu Terugkoppeling versturen naar Bronsysteem.
<url van DoelAP> OnbekendeKoppelsleutel De Koppelsleutel of de complete combinatie BronAP--KoppelSleutel-DoelAP komt niet bekend bij het TC. Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
OngeautoriseerdAanleverpunt Doelsysteem (aanvragend AP) is in het Register geregistreerd met andere Leverancier.
AanvragerNietBekend A De Doelschool (BRIN) is niet bekend bij het Traffic Center
AanvragerAanleverpuntNietBekend Doelaanleverpunt (BRIN + APindex) is niet bekend bij het Traffic Center
AanvragerNietBeschikbaar Bronsysteem (aanvragend AP) is (nog) niet gerechtigd om gebruik te maken van de overstapservice

Aanroep en antwoord

Element Uitleg Opmerkingen'
bronBRIN Dit is het brinnummer van de Bronschool waar dossier van specifieke leerling wordt opgevraagd. De Bronschool kan meerdere Aanleverpunten hebben.
bronAanleverpuntIndex Dit is de index van het Aanleverpunt van het Doelsysteem dat bevraagd wordt (optioneel). Deze parameter wordt alleen meegegeven worden wanneer het Bronsysteem één specifiek Aanleverpunt van de School wil bevragen. In plaats van alle Aanleverpunten af te lopen bij een Bronschool wordt alleen het gespecificeerde Aanleverpunt bevraagd. Dit biedt Doelsystemen een mogelijkheid voor het ondersteunen van (V)SO-scholen.
doelBrin Dit is het brinnummer van het Bronsysteem dat de Sessie aanvraagt. Het TC controleert of het Bronsysteem bekend en actief is in het deelnemersregister.
doelAanleverpuntIndex Dit is de index van het Aanleverpunt van het Bronsysteem dat de Sessie aanvraagt.
koppelsleutel De koppelsleutel zoals ontvangen in de Notificatie vanuit het Doelsysteem De koppelsleutel is verplicht voor dit type uitwisseling