OSO:2018/Opvragen dossier

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

Basisvariant: Overdracht van Dossier

In deze variant wordt het Dossier aangeduid met de zoeksleutel. Deze variant wordt hier verder uitgewerkt.

Basisvariant: Aanvraag bij Samenwerkingsverbanden

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

Basisscenario

1. Doelsysteem vraag dossier op ^#
2. Bronsysteem laat Sessie Controleren bij TC^*
3. IF Sessie valide
   1. IF (overdrachtsoort='overstapdossier') OR (overdrachtsoort == 'binnenBRIN'))^**
      1. Bronsysteem slaat aanvraag gegevens (PGN , 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
      4. Bronsysteem verstuurt foutmelding^******
      5. ENDIF
   2. ELSEIF (overdrachtsoort='SWVaanvraag')
   3. IF dossier gereed is voor overdracht^*** AND DossierVersie is correct
      1. Bronsysteem verstuurt dossier
   4. ELSE
      1. Bronsysteem verstuurt foutmelding
   5. ENDIF
4. ELSE
   1. Bronsysteem verstuurt foutmelding
5. ENDIF

^# 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.
^** De 'normale' OSO verstap wordt in deze tak afgehandeld. De tweede tak is bedoelt voor de afhandeling van 'Passend Onderwijs' aanvragen.
^***Het Dossier is klaargezet en (indien van toepassing) inzage heeft plaats gevonden
^****Bij het Dossier is door de Eindgebruiker (Bronsysteem) 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 hierboven).

Uitzonderingen en meldingen vanuit de Sessie controle

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 (zie hieronder)	dossier of LeerlingNietBekend of LeerlinginfoNietOpvraagbaar of LeerlinginfoNietBeschikbaar of LeveringGeweigerd of LeveringInBehandeling of LeerlinginfoNietIngezien of LeerlingInfoNietGewijzigd of DossierVersieNietCorrect

Uitzonderingen en meldingen

Hieronder volgt een overzicht van afwijkingen van de 'normale flow' zoals die door het bronsysteem gedetecteerd moeten worden een doorgegeven aan het doelsysteem. Voor de 'SWV-aanvragen' geldt dat de uitzonderingen 2, 4 en 5 niet van toepassing zijn.

• Uitzondering #2 'LeerlingInfoNietGewijzigd': De parameter 'datum gewijzigd' wordt genegeerd bij de SWV-aanvragen.
• Uitzonderingen #4 'LeerlinginfoNietOpvraagbaar' en #5 'LeerlinginfoNietIngezien' zijn niet van toepassing bij SWV-aanvragen omdat inzage niet nodig is.

'

Rangorde*	Resultaat	Omschrijving	Stopcriterium bij aflopen aanleverpunten	Melding aan Eindgebruiker
0	<Document>	Het gevraagde document. (Let op: In het afmeldingRequest moet dan status='VerstrekkingGeslaagd' worden gebruikt)	ja	nvt
1	LeveringInBehandeling**	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	nvt
2	LeerlingInfoNietGewijzigd	De inhoud van het Dossier is sinds de opgegeven 'aanvraagdatum’ in het documentRequest niet gewijzigd.	ja
3	DossierVersieNietCorrect	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	De versies van het dossier tussen bron en doelsysteem wijken van elkaar af en kunnen niet verwerkt worden.
4	LeerlinginfoNietOpvraagbaar	Het Dossier mag niet worden verstrekt, omdat de ouders/leerling geen toestemming hebben verleend.	ja	Het dossier mag niet worden verstrekt, omdat de ouders/leerling geen toestemming hebben verleend.
5	LeerlinginfoNietIngezien	Het document mag (nog) niet worden verstrekt, omdat de ouders nog geen inzage hebben gehad.	ja	Het document mag (nog) niet worden verstrekt, omdat de ouders nog geen inzage hebben gehad in het dossier.
6	LeerlinginfoNietBeschikbaar	Het Dossier is (nog) niet klaargezet voor overdracht.	ja	Het dossier is (nog) niet klaargezet voor overdracht. Neem contact op met de betreffende school.
7	LeveringGeweigerd	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	Het dossier is niet klaargezet voor het BRIN-nummer van jouw school. Neem contact op met de betreffende school.
8	LeerlingNietBekend	De leerling met het opgegeven BSN of Koppelsleutel is niet bekend bij het leverende bronsysteem.	nee	Het BSN-nummer van de leerling is niet bekend bij de betreffende school. Controleer het BSN, of neem contact op met de betreffende school.
9	AuthenticatieVerstrekkerMislukt	Het leverende bronsysteem kon zich niet authenticeren bij het Traffic Center. Het opvragende doelsysteem hoeft hierop geen actie te ondernemen.	nee	De school waar het dossier wordt opgehaald, wordt niet herkend. Neem contact op met de betreffende school.
10	SessieAfwijkend	De overstapvraag wijkt af van die, waarmee de sessie verkregen is. Dit is het resultaat van de sessieControle.	nee	Er heeft zich een interne fout voorgedaan tijdens de overdracht. Neem contact op met je software leverancier.
11	SessieReedsAfgemeld	De sessie is al afgemeld en dus niet langer geldig. Dit is het resultaat van de sessieControle.	nee	Er heeft zich een interne fout voorgedaan tijdens de overdracht. Neem contact op met je software leverancier.
12	SessieVerlopen	De sessie is verlopen; de time-out is verstreken. Dit is het resultaat van de sessieControle.	nee	Er heeft zich een interne fout voorgedaan tijdens de overdracht. Neem contact op met je software leverancier.
13	SessieOngeldig	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	Er heeft zich een interne fout voorgedaan tijdens de overdracht. Neem contact op met je software leverancier.
14	NietOndersteund	Het bevraagde bronsysteem geeft aan geen Dossiers te kunnen leveren (Functie niet ingebouwd)	nee	De school waar het dossier wordt opgehaald, heeft een systeem dat geen functie heeft voor het versturen van dossiers. Neem contact op met de betreffende school.
15	Communicatiefout	Het leverende bronsysteem geeft geen antwoord of er treedt een (technische) fout op. Er is geen contact geweest met het leverende bronsysteem.	nee	Er treedt een (technische) fout op bij de school van herkomst.

^* 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.
^**Deze melding is optioneel, niet alle systemen kennen deze toestand.

Aanroep en antwoord

• Request (voorbeel van OV documentRequest):

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
	<soapenv:Header/>
	<soapenv:Body>
		<ns:documentRequest>
			<ns:bronBrin>00YY</ns:bronBrin>
			<ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
			<ns:doelBrin>00YY</ns:doelBrin>
			<ns:doelAanleverpuntIndex>3</ns:doelAanleverpuntIndex>
			<ns:pgn>
				<ns:bsn>111222333</ns:bsn>
			</ns:pgn>
			<ns:zoeksleutel>xz/Zn95R9aSdJ/BeNSQs231pogl9evDlUO8NIuAEKhfHWjVhMZQb1cvo6RsntkTiy37rGCrfqjUgSFwTxZouMBVqb5gt4kHbZRSBhwc/aZhcftHWvAwHabKvoV4dahKWu/gwuzr6zzLskytoxUHdT4BA7MkT3EBuYUEtPcRtBXX=</ns:zoeksleutel>
			<ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
			<ns:sessieId>60d2909f-169f-4cb0-8256-5d1d5af1491d</ns:sessieId>
		</ns:documentRequest>
	</soapenv:Body>
</soapenv:Envelope>

• Request (voorbeel van PaO documentRequest):

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
	<soapenv:Header/>
	<soapenv:Body>
		<ns:documentRequest>
			<ns:bronBrin>00YY</ns:bronBrin>
			<ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
			<ns:doelBrin>00YY</ns:doelBrin>
			<ns:doelAanleverpuntIndex>100</ns:doelAanleverpuntIndex>
			<ns:koppelsleutel>19677A96-B737-402E-B3B8-24A3EEF32000</ns:koppelsleutel>
			<ns:overdrachtsoort>swv-dossier</ns:overdrachtsoort>
			<ns:sessieId>60d2909f-169f-4cb0-8256-5d1d5af1491d</ns:sessieId>
		</ns:documentRequest>
	</soapenv:Body>
</soapenv:Envelope>

Element	Uitleg	Opmerkingen
bronBRIN	Dit is het brinnummer van de bronschool die het het dossier moet uitleveren.	De bronschool kan meerdere aanleverpunten hebben.
bronAanleverpuntIndex	Dit is de index van het aanleverpunt van het bronsysteem dat bevraagd wordt.
doelBrin	Dit is het brinnummer van het doelsysteem dat de sessie heeft aangevraagd met de overdrachtRequest.
doelAanleverpuntIndex	Dit is de index van het aanleverpunt van het doelsysteem dat de sessie heeft aangevraagd met de overdrachtRequest.
zoeksleutel	De zoeksleutel wordt overgenomen uit het documentRequest.	Afhankelijk van de overdrachtsoort zal of de zoeksleutel of de koppelsleutel gevuld (moeten) zijn.
koppelsleutel	De koppelsleutel wordt overgenomen uit het documentRequest.	Afhankelijk van de overdrachtsoort zal of de zoeksleutel of de koppelsleutel gevuld (moeten) zijn.
overdrachtsoort	De overdrachtsoort moet voor alle berichten in de sessie gelijk zijn	Het brinnummer van het bron- en doelBrin moet hetzelfde zijn voor een binnenbrin overdracht.
sessieId	De sessieId wordt overgenomen uit het documentRequest.

• Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns:documentResponse>
			<!--You have a CHOICE of the next 2 items at this level-->
			<ns:fout>?</ns:fout>
			<ns:dossier>
				<!--You may enter ANY elements at this point-->
			</ns:dossier>
		</ns:documentResponse>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>