OSO:2017/Versturen Notificatie: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
k
 
(13 tussenliggende versies door 2 gebruikers niet weergegeven)
Regel 10: Regel 10:
 
|}
  
|}
   
  +
==Basisvariant: Notificatie na ontvangst DocumentRequest==
−
==Preconditie==
  
  +
Na een eerder verzoek tot levering wordt na het klaarzetten van een Dossier een Notificatie verstuurd naar Doelsystemen die een verzoek tot levering hebben verstuurd. Voorafgaand wordt eerst een [[OSO:2017/Initiëren_notificatie|Noficatie Melding]] naar het Traffic Center gestuurd. Deze variant wordt [[OSO:2017/Versturen_Notificatie/overstap|hier]] verder uitgewerkt.
−
*BronSysteem is aangesloten op OSO keten
  
−
*BronSysteem heeft Notificatie melding verstuurd naar Traffic Center
  
−
*DoelSysteem is aangesloten op OSO keten
  
−
*DoelSysteem heeft documentRequest verstuurd naar Bronsysteem
  
   
−
=== Notificatie tbv Aanvraag naar Samenwerkingsverband ===
 +
== Basisvariant: Notificatie voor aanvraag bij SWV==
  +
Voor het initiëren van een uitwisseling tbv een aanvraag bij een SWV wordt een Notificatie met Koppelsleutel verstuurd naar het Doelsyteem. Voorafgaand wordt eerst een [[OSO:2017/Initiëren_notificatie|Notificatie Melding]] gestuurd. Deze variant wordt [[OSO:2017/Versturen_Notificatie/aanvraag|hier]] verder uitgewerkt.
−
*BronSysteem is aangesloten op OSO keten
  
−
*BronSysteem heeft Notificatie melding verstuurd naar Traffic Center
  
−
*Gebruiker Bronsysteem heeft te notificeren Aanleverpunt van Doelsysteem gekozen
  
−
*Bronsysteem heeft Dossier klaargezet dat opgehaald moet worden door Doelsysteem
  
−
*DoelSysteem is aangesloten op OSO keten
  
−
=== Notificatie tbv Terugkoppeling naar Samenwerkingsverband ===
  
−
*BronSysteem is aangesloten op OSO keten
  
−
*BronSysteem heeft (in eerdere Sessie) Dossier succesvol opgevraagd bij DoelSysteem mbv Koppelsleutel
  
   
−
==Basis scenario==
 +
==Basisscenario==
−
# Bronsysteem verstuurt Notificatie naar Doelsysteem
  
−  
−
==Postconditie==
  
−
*Doelsysteem heeft Notificatie ontvangen van Bronsysteem
  
−  
−
==Basis scenario==
  
 
# Bronsysteem verstuurt Notificatie naar Doelsysteem
  
# Bronsysteem verstuurt Notificatie naar Doelsysteem
 
# Als Doelsysteem Notificatietype ondersteunt '''AND''' Doelsysteem kent Koppelsleutel
  
# Als Doelsysteem Notificatietype ondersteunt '''AND''' Doelsysteem kent Koppelsleutel
 
## Doelsysteem stuurt bevestiging ontvangst Notificatie aan BronSysteem<sup>*</sup>
  
## Doelsysteem stuurt bevestiging ontvangst Notificatie aan BronSysteem<sup>*</sup>
 
## Doelsysteem toont Notificatie gegevens aan Eindgebruiker (Doelsysteem)<sup>**</sup>
  
## Doelsysteem toont Notificatie gegevens aan Eindgebruiker (Doelsysteem)<sup>**</sup>
−
## '''If''' Bronsysteem heeft bevestiging ontvangen
 +
## '''IF''' Bronsysteem heeft bevestiging ontvangen
 
### BronSysteem toont bevestiging aan Eindgebruiker (Bronsysteem)
  
### BronSysteem toont bevestiging aan Eindgebruiker (Bronsysteem)
−
## '''Else'''
 +
## '''ELSE'''
 
### BronSysteem toont melding aan Eindgebruiker (Bronsysteem)<sup>***</sup>
  
### BronSysteem toont melding aan Eindgebruiker (Bronsysteem)<sup>***</sup>
  +
## '''ENDIF'''
−
# Else
  
  +
# '''ELSE'''
 
## Doelsysteem stuurt foutcode naar Bronsysteem
  
## Doelsysteem stuurt foutcode naar Bronsysteem
 
## Bronsysteem toon foutmelding aan Eindgebruiker (Bronsysteem)
  
## Bronsysteem toon foutmelding aan Eindgebruiker (Bronsysteem)
  +
# '''ENDIF'''
−  
−  
   
 
<sup>*</sup>Deze bevestiging is impliciet op basis van correct ontvangen van bericht<br />
  
<sup>*</sup>Deze bevestiging is impliciet op basis van correct ontvangen van bericht<br />
Regel 51: Regel 35:
 
<sup>***</sup> 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.
  
<sup>***</sup> 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==
 +
== Uitzonderingen en meldingen==
−
*Request:
  
−  
−
<syntaxhighlight lang="xml">
  
−
<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>
  
−
</syntaxhighlight>
  
   
 
{|class="wikitable"
  
{|class="wikitable"
−
! style="text-align:left;"| Element
 +
! style="text-align:left;"| Resultaat
−
! style="text-align:left;"| Uitleg
 +
! style="text-align:left;"| A/E<sup>*</sup>
−
! style="text-align:left;"| Opmerkingen
 +
! style="text-align:left;"| Omschrijving
  +
! style="text-align:left;"| Toelichting
−  
 
|-
  
|-
−
| bronBRIN
  
−
| Dit is het BRINnummer van de Bronschool dat de Notificatie wil versturen.
  
−
| verplicht
  
   
  +
| NotificatieOntvangen
  +
| Response door het Doelsysteem
  +
| De Notificatie wordt ontvangen door het Doelsysteem.
  +
| In het Doelsysteem wordt op basis van de ZoekSleutel in de Notificatie een Dossier opgevraagd bij het BronSysteem.
 
|-
  
|-
−
| bronAanleverpuntIndex
  
−
| Dit is de index van het Aanleverpunt van het Bronsysteem dat de Notificatie wil versturen.
  
−
| verplicht
  
   
  +
| NietOndersteund
  ⚫
|
  +
| Het Doelsysteem ondersteunt dit type OSO uitwisseling niet.
  +
| Het Doelsysteem geeft aan dat een Notificatie van overdrachtsoort 'swv-aanvraag' is ontvangen, maar dat dit systeem deze functionaliteit niet ondersteund. Er vindt geen verdere verwerking plaats.
 
|-
  
|-
−
| doelBrin
  
−
| Dit is het brinnummer van het Doelsysteem dat de Notificatie ontvangt.
  
−
| verplicht
  
   
  +
| <Geen response>
⚫
|-
  
  +
| E
−
| doelAanleverpuntIndex
  
  +
| Technische fout
−
| Dit is de index van het Aanleverpunt van het Doelsysteem dat de Notificatie ontvangt.
  
  +
| Het meldende Bronsysteem staakt de verdere Notificatie en geeft de eindgebruiker hierover een foutmelding.
−
| 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
  
   
 
|}
  
|}
  +
<sup>*</sup> A: Alternatief, E: Exceptie (fout)
   
−
*Response
  
−  
−
<syntaxhighlight lang="xml">
  
−
<?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>
  
−
</syntaxhighlight>
  
   
 
[[Categorie:Overstapservice Onderwijs]]
  
[[Categorie:Overstapservice Onderwijs]]
−
[[Category:Book OSO|64]]
  

Huidige versie van 19 mrt 2018 om 10:17

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

Basisvariant: Notificatie na ontvangst DocumentRequest

Na een eerder verzoek tot levering wordt na het klaarzetten van een Dossier een Notificatie verstuurd naar Doelsystemen die een verzoek tot levering hebben verstuurd. Voorafgaand wordt eerst een Noficatie Melding naar het Traffic Center gestuurd. Deze variant wordt hier verder uitgewerkt.

Basisvariant: Notificatie voor aanvraag bij SWV

Voor het initiëren van een uitwisseling tbv een aanvraag bij een SWV wordt een Notificatie met Koppelsleutel verstuurd naar het Doelsyteem. Voorafgaand wordt eerst een Notificatie Melding gestuurd. Deze variant wordt hier verder uitgewerkt.

Basisscenario

  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)***
    5. ENDIF
  3. ELSE
    1. Doelsysteem stuurt foutcode naar Bronsysteem
    2. Bronsysteem toon foutmelding aan Eindgebruiker (Bronsysteem)
  4. ENDIF

*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.

Uitzonderingen en meldingen

Resultaat A/E* Omschrijving Toelichting
NotificatieOntvangen Response door het Doelsysteem De Notificatie wordt ontvangen door het Doelsysteem. In het Doelsysteem wordt op basis van de ZoekSleutel in de Notificatie een Dossier opgevraagd bij het BronSysteem.
NietOndersteund Het Doelsysteem ondersteunt dit type OSO uitwisseling niet. Het Doelsysteem geeft aan dat een Notificatie van overdrachtsoort 'swv-aanvraag' is ontvangen, maar dat dit systeem deze functionaliteit niet ondersteund. Er vindt geen verdere verwerking plaats.
<Geen response> E Technische fout Het meldende Bronsysteem staakt de verdere Notificatie en geeft de eindgebruiker hierover een foutmelding.

* A: Alternatief, E: Exceptie (fout)

Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSO:2017/Versturen_Notificatie&oldid=8211"