OSO:2018/Initiëren sessie

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
Actor(s) Goal(s)
DoelSysteem Geldige sessie toegekend krijgen voor opvragen specifiek dossier. Zowel in de variant met zoeksleutel als die met een koppelsleutel geldt dat een sessie altijd over één specifiek dossier gaat.
Traffic Center Sessie toekennen aan systeem voor geldig verzoek van systeem voor specifiek dossier door school tbv overstap of aanvraag bij samenwerkingsverband

Basisvariant: Overstapdossier

Een Doelsysteem vraagt een Sessie aan om een specifiek Dossier op te vragen bij een School (BRIN(4)). Het TC verstrekt een Sessie wanneer de School bekend en actief is; er zijn actieve Aanleverpunten bij deze school die bevraagd kunnen worden. Het TC geeft de lijst met Aanleverpunten terug aan het Sessie aanvragende systeem. Het aanvragen van een Sessie voor deze variant wordt hier verder uitgewerkt.

Variant: Specifiek Aanleverpunt bevragen

Een Doelsysteem kan specifiek één Aanleverpunt bevragen door de APindex van dit Aanleverpunt mee te geven (samen met de BronBRIN). In dit geval geeft het TC geen lijst met Aanleverpunten terug, maar alleen de informatie van dit specifieke Aaneleverpunt (mits actief).

Basisvariant: Aanvraag bij Samenwerkingsverbanden

Een Doelsysteem vraag een Sessie aan na ontvangst van een Notificatie met een Koppelsleutel. De KoppelSleutel wordt gebruikt bij deze uitwisseling als aanduiding van het over te dragen Dossier. Het aanvragen van een Sessie voor deze variant wordt hier verder uitgewerkt.

Basis scenario

  1. Doelsysteem vraagt Sessie aan bij TC
  2. IF het Doelsysteem is valide* AND Doel Aanleverpunt is actief AND Bron School is actief AND (zoeksleutel is correct**** XOR koppelsleutel is gevuld) AND (Overdrachtsoort correct ingevuld) THEN
    1. Traffic Center kent een sessie toe aan het Bronsysteem
    2. Traffic Center verstrekt lijst met te bevragen Aanleverpunten **
  3. Else
    1. Traffic Center geeft foutcode terug
    2. Doelsysteem geeft foutmelding aan Eindgebruiker ***

*Valide systeem houdt oa in dat het systeem gekwalificeerd is, een correct certificaat heeft en toegelaten is op de OSO keten.
**Als specifiek aanleverpunt bevraagd wordt, dan wordt alleen de gegevens van dit aanleverpunt doorgegeven door TC.
***In dit geval kan de Sessie niet afgemeld worden.
****De zoeksleutel wordt door het TC gedecrypt en de BSN ('11 test') of het Onderwijsnummer ('DUO test') wordt gecontroleerd. Alleen als deze stappen goed doorlopen (kunnen) wordt, geeft het TC een sessie terug én worden de laatste/rechter vier karakters van het BSN of Onderwijsnummer opgeslagen in het PGNfrag voor de Sessie controle. (Link naar beschrijving)

Uitzonderingen en meldingen

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

Resultaat Omschrijving Toelichting Melding aan Eindgebruiker
AanvragerNietBekend De aanvrager (doelBrin) is niet gerechtigd om de overstapservice te gebruiken Het doelBrin is niet bekend in het register van het Traffic Center. Je school is niet aangesloten op OSO. Neem contact op met de servicedesk van OSO.
AanvragerAanleverpuntNietBekend Het aanleverpunt van het doelsysteem (aanvragend aanleverpunt) is niet bekend bij het Traffic Center In het Register is de combinatie van doelBrin en doelAanleverpuntIndex niet aanwezig. Het aanleverpunt waarop je de leerling wilt ophalen is niet (goed) geregistreerd in je LAS.
AanvragerNietBeschikbaar De aanvrager (doelBrin) is niet gerechtigd om de overstapservice te gebruiken. De Doelschool (BRIN) is niet gerechtigd gebruik te maken van OSO. Je school is niet aangesloten op OSO. Neem contact op met de servicedesk van OSO.
VerstrekkerNietBekend Het bronBrin is niet bekend bij het Traffic Center. De opgegeven bronschool is (nog) niet opgenomen in het Register van het Traffic Center. De school waar je de leerling ophaalt, is niet aangesloten op OSO. Neem contact op met de betreffende school.
VerstrekkerAanleverpuntNietBekend De bronBrin/APindex combinatie is niet bekend bij het Traffic Center. Het opgegeven aanleverpunt van de bronschool is (nog) niet opgenomen in het Register van het Traffic Center. De school waar je de leerling ophaalt, is niet aangesloten op OSO. Neem contact op met de betreffende school.
VerstrekkerNietBeschikbaar Bronsysteem is niet gerechtigd om de overstapservice te gebruiken. Voorbeeld hiervan: de URL van het bronssysteem is niet (goed) geregistreerd. De bronschool is bekend in het register, maar er zijn geen actieve aanleverpunten beschikbaar. Voorbeeld hiervan: de URL van het bronssysteem niet (goed) is geregistreerd. De school waar je de leerling ophaalt, heeft geen actieve aanleverpunten bij OSO. Neem contact op met de betreffende school.
GeenRelatieMetDoel De overdrachtSoort in het overdrachtsRequest is "overdrachtbinnenbrin" of "SWVaanvraag", maar het bronBrin en doelBrin verschillen van elkaar. Een overdracht binnenbrin mag alleen tussen systemen met eenzelfde BRIN plaats vinden. Een overdracht "binnenbrin" mag alleen tussen systemen met eenzelfde BRIN-nummer plaatsvinden.
OverdrachtReedsActief Er is reeds een sessie actief voor dezelfde parameters. Een sessie voor een identieke overdracht is nog actief. Geldt alleen voor aanvraag met zoeksleutel. Er is al een dossieroverdracht gestart. Probeer het over 10 minuten nog eens.
OVaanvraagMetKoppelsleutel De aanvraag heeft een andere waarde voor overdrachtsoort dan 'SWVaanvraag' maar wel een Koppelsleutel ipv een Zoeksleutel ingevuld. Een sessie wordt alleen toegekend bij een KoppelSleutel als de overdrachtsoort 'SWVaanvraag' is. Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
OVaanvraagMetIncorrectAPtype De aanvraag heeft een andere waarde voor overdrachtsoort dan 'SWVaanvraag' maar het Doelaanleverpunt is van type 'SWV' Een sessie wordt alleen toegekend bij een aanvraag met als doelaanleverpunt van type 'SWV' als de overdrachtsoort 'SWVaanvraag' is. Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
SWVaanvraagMetZoeksleutel De aanvraag heeft overdrachtsoort 'SWVaanvraag' maar een Zoeksleutel ipv een KoppelSleutel ingevuld. Een sessie voor een overdracht van overdrachtsoort 'SWVaanvraag' mag alleen een KoppelSleutel gebruiken. Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
SWVaanvraagNietSpecifiek De aanvraag van maakt gebruik van een Koppelsleutel maar specificeert geen Bronaanleverpunt. Een sessie voor een overdracht van overdrachtsoort 'SWVaanvraag' moet een specifiek Bronaanleverpunt bevragen. Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
SWVaanvraagMetIncorrectAPtype De aanvraag heeft als waarde voor overdrachtsoort 'SWVaanvraag' maar het Doelaanleverpunt is van type 'LAS' Een sessie wordt alleen toegekend bij een aanvraag met overdrachtsoort 'SWVaanvraag' als het doelaanleverpunt van type 'RP' of 'SWV' is. Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
KoppelSleutelNietBekend De aanvraag gebruikt een combinatie BronAP--Koppelsleutel--DoelAP die niet bekend is bij het TC. Een koppelsleutel wordt door het TC gegenereerd bij het NotificatieRequest en moet daarom bekend zijn bij het TC. Er heeft zich een interne fout voorgedaan tijdens de SWV aanvraag. Neem contact op met je software leverancier.
OngeautoriseerdAanleverpunt Het OIN van het certificaat komt niet overeen met die van de geregistreerde leverancier Het Aanleverpunt (BronBRIN/APindex) is bekend bij OSO, maar in het Register is een andere Leverancier bekend dat die deze sessie aanvraag indient. Het aanleverpunt waarop je de leerling wilt ophalen is niet (goed) geregistreerd in je LAS.
ZoeksleutelNietCorrect De Zoeksleutel is niet correct encrypt of bevat een PGN of Onderwijsnummer dat niet correct is. Het TC heeft bij het controleren van de Zoeksleutel vastgesteld dat de Zoeksleutel niet correct is versleuteld of het BSN of PGN in de Zoeksleutel blijkt niet correct. Er heeft zich een interne fout voorgedaan tijdens de OV aanvraag. Neem contact op met je software leverancier.
<Geen response> Het Traffic Center geeft een time out of technische fout. Het aanvragende Bronsysteem staakt de verdere aanvraag en geeft de eindgebruiker hierover een foutmelding. Er kan geen verbinding gemaakt worden met het OSO systeem.

* A: Alternatief, E: Exceptie (fout)


Aanroep en antwoord

  • Request (voorbeeld van OV overdrachtsRequest):
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:overdrachtRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
         <ns:doelBrin>00YY</ns:doelBrin>
         <ns:doelAanleverpuntIndex>1</ns:doelAanleverpuntIndex>
         <ns:zoeksleutel>sEdSD95Pkxji0FpSC2ZTvqSk4aHiiWuiV8NDavqrAouUOkzXLOkZVdR8WpROnMhl0QyZkMph7YZkGTPeAznajzTdT9Y0EBxGbf1HeDWjATC8yKeH9dGCiDO65uwLB0ly2hNmsZX/aZoefjdJbu7GhoWQjHoxOuSRJzvnzoXDrAI=</ns:zoeksleutel>
         <ns:overdrachtsoort>overstapdossier</ns:overdrachtsoort>
      </ns:overdrachtRequest>
   </soapenv:Body>
</soapenv:Envelope>


  • Request (voorbeeld van PaO overdrachtsRequest):
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:overdrachtRequest>
         <ns:bronBrin>00YY</ns:bronBrin>
         <ns:bronAanleverpuntIndex>0</ns:bronAanleverpuntIndex>
         <ns:doelBrin>00YY</ns:doelBrin>
         <ns:doelAanleverpuntIndex>100</ns:doelAanleverpuntIndex>
         <ns:koppelsleutel>da6cb121-f855-453b-a21b-9936de5b4809</ns:koppelsleutel>
         <ns:overdrachtsoort>swv-dossier</ns:overdrachtsoort>
      </ns:overdrachtRequest>
   </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 (optioneel). Deze parameter kan meegegeven worden als het doelsysteem één specifiek aanleverpunt van de school wil bevragen.
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.
doelAanleverpuntIndex Dit is de index van het aanleverpunt van het doelsysteem dat de sessie aanvraagt.
zoeksleutel De zoeksleutel wordt is het geencrypte pgn Afhankelijk van de overdrachtsoort zal of de zoeksleutel of de koppelsleutel gevuld (moeten) zijn.
koppelsleutel De koppelsleutel wordt overgenomen uit het notificatiebericht. Afhankelijk van de overdrachtsoort zal of de zoeksleutel of de koppelsleutel gevuld (moeten) zijn.
overdrachtsoort De overdrachtsoort is "overstapdossier", "overdrachtbinnenbrin" of "SWVaanvraag" Het brinnummer van het bron- en doelBrin moet hetzelfde zijn voor een binnenbrin overdracht en SWVaanvraag.
  • Response van een OV overdracht. PaO overdrachtResponse is hetzelfde, echter met 1 aanleverpunt.
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<over:overdrachtResponse xmlns:over="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
			<over:overdracht>
				<over:aanleverpunt>
					<over:code>0</over:code>
					<over:url>https://ott-sb.kennisnet.nl/aanleverpunt</over:url>
					<over:type>LAS</over:type>
					<over:label>Test</over:label>
				</over:aanleverpunt>
				<over:aanleverpunt>
					<over:code>1</over:code>
					<over:url>https://ott-dev.com/aanleverpunt/1</over:url>
					<over:type>LAS</over:type>
					<over:label>Test 1</over:label>
				</over:aanleverpunt>
				<over:sessieId>630060ba-aa77-41d6-8afe-5a1e34d5a84a</over:sessieId>
			</over:overdracht>
		</over:overdrachtResponse>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>