OSO:2017/Versturen Notificatie/aanvraag: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met '===Preconditie=== *BronSysteem is aangesloten op OSO keten *Bronsysteem heeft Dossier klaargezet dat opgehaald moet worden door Doelsysteem *BronSysteem heeft Notif...')
 
Regel 7: Regel 7:
 
===Postconditie===
 
===Postconditie===
 
*Doelsysteem heeft Notificatie met KoppelSleutel ontvangen van Bronsysteem
 
*Doelsysteem heeft Notificatie met KoppelSleutel ontvangen van Bronsysteem
  +
  +
==Aanroep en antwoord==
  +
*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"
  +
! style="text-align:left;"| Element
  +
! style="text-align:left;"| Uitleg
  +
! style="text-align:left;"| 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
  +
  +
<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>

Versie van 15 feb 2017 16:04

Preconditie

  • BronSysteem is aangesloten op OSO keten
  • Bronsysteem heeft Dossier klaargezet dat opgehaald moet worden door Doelsysteem
  • BronSysteem heeft Notificatie melding verstuurd naar Traffic Center én KoppelSleutel ontvangen
  • Gebruiker Bronsysteem heeft te notificeren Aanleverpunt van Doelsysteem gekozen
  • DoelSysteem is aangesloten op OSO keten

Postconditie

  • Doelsysteem heeft Notificatie met KoppelSleutel ontvangen van Bronsysteem

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>