OSO:2017/Opvragen dossier: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
Regel 225: Regel 225:
 
<sup>***</sup>Deze melding is optioneel, niet alle systemen kennen deze toestand.<br />
  
<sup>***</sup>Deze melding is optioneel, niet alle systemen kennen deze toestand.<br />
 
<sup>****</sup>POVO overstap.<br />
  
<sup>****</sup>POVO overstap.<br />
−  
−
==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:documentRequest>
  
−
<ns:bronBrin>00YY</ns:bronBrin>
  
−
<ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
  
−
<ns:doelBrin>12SS</ns:doelBrin>
  
−
<ns:doelAanleverpuntIndex>102</ns:doelAanleverpuntIndex>
  
−
<ns:zoeksleutel>yl/xKgjcxwvxryvCveYeefn3NzZY8xCyC3UIpR62S7nVMV51q8X ... JpgyucEUAmzrXr+aEfkINN9xAZehsINL6mvvNPFskIbZzSgFUTDpI=</ns:zoeksleutel>
  
−
<ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
  
−
<ns:sessieId>fe6b2710-3fe5-468e-822d-e2b409a9f0d0</ns:sessieId>
  
−
<!--Optional:-->
  
−
<ns:pgn>
  
−
<!--You have a CHOICE of the next 2 items at this level-->
  
−
<ns:bsn>123123121</ns:bsn>
  
−
</ns:pgn>
  
−
<!--Optional:-->
  
−
<ns:aanvraagdatum>2016-03-06T14:19:39.977+02:00</ns:aanvraagdatum>
  
−
</ns:documentRequest>
  
−
</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 BRIN van de bronschool.
 
−
|
 
−  
−
|-
  
−
| bronAPindex
  
−
| Dit is de index van het aanleverpunt van het bronsysteem dat dit verzoek ontvangt.
  
−
|
 
−  
−
|-
  
−
| doelBrin
  
−
| Dit is het BRIN van de doelschool
  
−
|
 
−  
−
|-
  
−
| doelAPindex
  
−
| Dit is de index van het Aanleverpunt van het Bronsysteem dat dit verzoek indient.
  
−
|
 
−  
−
|-
  
−
| zoeksleutel
  
−
| Dit is de versleutelde PGN
  
−
| Dit moet exact overeenkomen met de zoeksleutel zoals meegegeven bij het aanvragen van een sessie (wordt door Doelsysteem gegenereerd bij aanvragen Sessie)
  
−  
−
|-
  
−
| overdrachtsoort
  
−
| Dit bepaalt om wat voor soort overdracht het gaat, een overstapdossier of overdrachtbinnenbrin.
  
−
| De overdrachtsoort wordt overeenkomen met de overdrachtsoort welke gebruikt is in het overdrachtsRequest. Het BRIN-nummer van het bron- en doelBRIN moet hetzelfde zijn voor een binnenbrin overdracht.
  
−  
−
|-
  
−
| sessieId
  
−
| De sessie-ID die verkregen is bij het Initiëren van de Sessie.
  
−
|
  
−  
−
|-
  
−
| PGN
  
−
| Het BSN of Onderwijsnummer van de leerling (verplicht)
  
−
| Dit wordt onversleuteld verstuurd in het documentRequest
 
−  
−
|-
  
−
| aanvraagdatum
  
−
| Als de optionele parameter ‘aanvraagdatum’ door het doelsysteem is ingevuld, dan vergelijkt het bronsysteem de aanvraagdatum met de verzameldatum van het dossier. De uitkomst van die vergelijking bepaalt het antwoord van het bronsysteem.
  
−
| De aanvraagdatum is optioneel
  
−
|}
  
−  
−  
−
*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:documentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.w3.org/2001/XMLSchema">
  
−
<ns1:fout>LeerlinginfoNietBeschikbaar</ns1:fout>
  
−
</ns1:documentResponse>
  
−
</SOAP-ENV:Body>
  
−
</SOAP-ENV:Envelope>
  
−
</syntaxhighlight>
  
−  
   
   

Versie van 10 feb 2017 14:32

Actor(s) Goal(s)
Doelsysteem Doelsysteem heeft dossier van specifieke leerling ontvangen
Bronsysteem Verzoek tot overhandigen specifiek dossier afgehandeld


Preconditie

  • DoelSysteem is toegelaten op OSO keten
  • DoelSysteem heeft geldig OSO certificaat
  • DoelSysteem heeft geldige Sessie voor opvragen Dossier
  • BronSysteem is toegelaten op OSO keten
  • BronSysteem heeft geldig OSO certificaat toegekend door TC


Notificatie tbv Aanvraag naar Samenwerkingsverband

  • Doelsysteem heeft Koppelsleutel ontvangen van Bronsysteem

=== Notificatie tbv Terugkoppeling naar Samenwerkingsverband ===

  • Doelsysteem heeft Koppelsleutel verstuurd naar Bronsysteem
  • Bronsysteem heeft in eerdere transactie Dossier opgevraagd bij Doelsysteem mbv Koppelsleutel

Postconditie

Dossier is verzonden van Doelsysteem naar Bronsysteem

Basisvariant

  1. Doelsysteem vraag dossier op #
  2. Bronsysteem laat Sessie Controleren bij TC*
  3. IF Sessie valide !
    1. Bronsysteem slaat aanvraag gegevens (PGN OF koppelsleutel, sessie id, documentRequest, doel brin, doel AP index, aanvraagMoment) op ten behoeve van Notificatie**
    2. IF dossier gereed is voor overdracht*** And Dossier aan Doelsysteem overgedragen mag worden*** And verzameldatum van Dossier voldoet***** And DossierVersie is correct
      1. Bronsysteem verstuurt dossier
    3. Else
      1. Bronsysteem verstuurt foutmelding******
  4. Else
    1. Bronsysteem verstuurt foutmelding

# In OSO kan een Doelsysteem aangeven dat het alleen geínteresseerd is in een 'geactualiseerd' Dossier. Zie ook punt ****
*Dit is een verplichte stap
Deze controle moet voor de andere controles worden uitgevoerd door het Bronsysteem. Als de Sessie gegevens incorrect blijken, moet dit worden teruggegeven aan het Doelsysteem. Pas daarna volgen de andere stappen en controles.
**In geval van de 'Overdracht' variant. !Alleen bij het resultaat 'Sessie is valide' mag een Dossier uitgeleverd worden(!)
***Het <LINK NAAR GEREEED ZETTEN>Dossier is klaargezet en (indien van toepassing) inzage heeft plaats gevonden
****Bij het Dossier is door de Eindgebruiker (Bronsysteem) <LINK NAAR GEREEDZETTEN>aangegeven dat het opgevraagd mag worden door de School (BRIN).

Variant: Opvragen met AanvraagDatum

****Als de optionele parameter in het documentRequest ‘aanvraagdatum’ door het Doelsysteem is ingevuld, vergelijkt het bronsysteem deze waarde met de verzameldatum van het Dossier:

  • Als de ‘aanvraagDatum’ kleiner is dan de verzameldatum van het dossier ('na de vorige aanvraag is het dossier aangepast en ingezien'), volgt de ‘normale’ afhandeling van het request.
  • Als de ‘aanvraagDatum’ groter of gelijk is dan de verzameldatum van het dossier ('na de vorige aanvraag is het dossier niet aangepast') geeft het bronsysteem de (nieuwe) melding ‘LeerlingInfoNietGewijzigd’ (als het dossier wel klaar staat voor het bronsysteem).
  • NB: Deze parameter wordt niet toegepast bij uitwisselingen met de KoppelSleutel (zie hieronder).

Variant: Opvragen met KoppelSleutel

In deze variant wordt het gevraagde Dossier niet aangeduid met de ZoekSleutel maar met de Koppelsleutel (die eerder door het TC is afgegeven).

Mogelijk resultaat van de sessieControle bij het TrafficCenter Verstrekkingsfout (of dossier) die de bron in de documentResponse aan het doel teruggeeft
<technische fout> SessieOngeldig
SessieReedsAfgemeld SessieReedsAfgemeld
SessieAfwijkend SessieAfwijkend
SessieVerlopen SessieVerlopen
SessieOngeldig SessieOngeldig
VerstrekkerNietBekend AuthenticatieVerstrekkerMislukt
VerstrekkerNietBeschikbaar AuthenticatieVerstrekkerMislukt
VerstrekkerAanleverpuntNietBekend AuthenticatieVerstrekkerMislukt
OngeautoriseerdAanleverpunt SessieOngeldig
OnbekendAanleverpunt SessieOngeldig
AanvragerNietBekend SessieOngeldig
AanvragerAanleverpuntNietBekend SessieOngeldig
AanvragerNietBeschikbaar SessieOngeldig
GeenRelatieMetDoel SessieOngeldig
Sessie is valide dossier of

LeerlingNietBekend of
LeerlinginfoNietOpvraagbaar of
LeerlinginfoNietBeschikbaar of
LeveringGeweigerd of
LeveringInBehandeling of
LeerlinginfoNietIngezien of
LeerlingInfoNietGewijzigd of
DossierVersieNietCorrect

Scenario's

Rangorde* Resultaat Type flow (N, A, E**) Omschrijving Stopcriterium bij aflopen aanleverpunten
0 <Document> N Het gevraagde document. (Let op: In het afmeldingRequest moet dan status='VerstrekkingGeslaagd' worden gebruikt) ja
1 LeveringInBehandeling*** A Het leverende systeem (bron) kan niet bepalen of het dossier al beschikbaar is of dat de leerling bij de bron bekend is. Het aanvragende systeem (doel) gaat verder met het opvragen van het dossier bij de andere aanleverpunten. nee
2 LeerlingInfoNietGewijzigd**** A De inhoud van het Dossier is sinds de opgegeven 'aanvraagdatum’ in het documentRequest niet gewijzigd. ja
3 DossierVersieNietCorrect A De versie van het dossier dat klaar staat wijkt af van de huidige versie (en kan daardoor niet correct geïmporteerd worden door het doelsysteem). ja
4 LeerlinginfoNietOpvraagbaar A Het Dossier mag niet worden verstrekt, omdat de ouders/leerling geen toestemming hebben verleend. ja
5 LeerlinginfoNietIngezien A Het document mag (nog) niet worden verstrekt, omdat de ouders nog geen inzage hebben gehad. ja
6 LeerlinginfoNietBeschikbaar A Het Dossier is (nog) niet klaargezet voor overdracht. ja
7 LeveringGeweigerd A Het verstrekkende bronsysteem had het dossier klaargezet voor een specifiek BRIN-nummer. Het verstrekkende bronsysteem heeft het dossier niet uitgeleverd aan het opvragende doelsysteem, omdat het BRIN van het opvragende doelsysteem niet overeenkomt met het BRIN waarvoor het dossier was klaargezet. nee
8 LeerlingNietBekend A De leerling met het opgegeven BSN is niet bekend bij het leverende bronsysteem. nee
9 AuthenticatieVerstrekkerMislukt E Het leverende bronsysteem kon zich niet authenticeren bij het Traffic Center. Het opvragende doelsysteem hoeft hierop geen actie te ondernemen. nee
10 SessieAfwijkend E De overstapvraag wijkt af van die, waarmee de sessie verkregen is. Dit is het resultaat van de sessieControle. nee
11 SessieReedsAfgemeld E De sessie is al afgemeld en dus niet langer geldig. Dit is het resultaat van de sessieControle. nee
12 SessieVerlopen E De sessie is verlopen; de time-out is verstreken. Dit is het resultaat van de sessieControle. nee
13 SessieOngeldig E De sessie is ongeldig; bij het controleren van de Sessie gegevens door het Traffic Center is een fout geconstateerd. (Bijvoorbeeld: Het SessieID is nooit uitgedeeld, het SessieID was leeg, de aanvrager heeft geen geldige status). Deze foutcode moet doorgegeven worden wanneer andere foutmeldingen niet van toepassing zijn. nee
14 Communicatiefout E Het leverende bronsysteem geeft geen antwoord of er treedt een (technische) fout op. Er is geen contact geweest met het leverende bronsysteem. nee

* De rangorde geeft de 'mate van succes' van de overdracht aan, hoe hoger hoe beter. Bronsystemen moeten de 'laagste toestand' teruggeven aan het Doelsysteem; het Doelsysteem moet het 'hoogste resultaat' binnen één Sessie terugrapporteren bij het afsluiten van de Sessie.
** N: Normaal, A: Alternatief, E: Exceptie (fout)
***Deze melding is optioneel, niet alle systemen kennen deze toestand.
****POVO overstap.

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