OSO:2018/Controleren Aanleverpunt

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

Overstapservice Onderwijs-symbol.png Overstapservice Onderwijs: 2018/Controleren Aanleverpunt

Context

Bij het invoeren van Aanleverpunten in Schoolsystemen kunnen eindgebruikers fouten maken bij het invoeren van de gegevens, die overeen moeten komen met de gegevens van het desbetreffende Aanleverpunt in het Register. De Aanleverpunt-sleutel (APsleutel) biedt een mogelijkheid de invoer van de gebruiker te controleren. De ‘sleutel-controle’ bewaakt de correcte combinatie van Leverancier (via het SAAS certificaat), BRIN en AP-index. De ‘sleutel-controle’ biedt geen extra beveiliging of juridische zekerheid(!).

Deze aanroep mag door een Leverancier worden toegepast, deze is niet verplicht(!).*
Als een Leverancier deze aanroep implementeert, dan moet deze worden uitgevoerd voorafgaand aan het registeren van een Aanleverpunt.

NB: In OSO'17 is de optionele parameter 'doel' aan deze aanroep toegevoegd. Als deze parameter niet wordt meegeven vanuit het schoolsysteem, wordt de waarde 'OV' veronderstelt; de waarden 'OV' of 'PaO' kunnen als geldige waarde worden meegegeven. Met deze uitbreiding is in het schoolsysteem vast te stellen of ook het doel van het Aanleverpunt correct is ingevoerd.


In OSO'16 is gekozen voor het optioneel toepassen van een AP sleutel na discussies in het Technisch Overleg en op de mailinglijst (Zie Bestand:Uitbreiding OSO functionaliteit met APvalidatie 20160210.pdf en Bestand:Uitbreiding OSO functionaliteit met APvalidatie 20160216 def.pdf voor meer informatie.) Daarbij wordt er gewerkt met een 'random' betekenisloze sleutel.

*De aanroep maakt wel onderdeel uit van de WSDl om te voorkomen dat er met meerdere WSDL's moet worden gewerkt.

Basisscenario

  1. Een Schoolsysteem verstuurt een APsleutel Controle request naar het Traffic Center.
  2. Het Traffic Center controleert of de waarden van BRIN, APindex én Doel voor het Aanleverpunt correct zijn
  3. If waarden correct
    1. Het Traffic Center controleert of Leverancier (OIN uit certificaat) overeenkomt met geregistreerde Leverancier
    2. If Leverancier (OIN uit certificaat) overeenkomt met geregistreerde Leverancier
      1. Het Traffic Center controleert of APsleutel waarde overeenkomt met waarde in Register
      2. Íf waarde correct
        1. Traffic Center geeft bevestiging dat de APsleutel is gecontroleerd
      3. Else
        1. Traffic Center verstuurt foutmelding over incorrecte APsleutel
    3. Else
      1. Traffic Center verstuurt foutmelding over niet geautoriseerde Leverancier
  4. Else
    1. Traffic Center verstuurt foutmelding over BRIN/APindex aan Schoolsysteem

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:controlerenAanleverpuntsleutelRequest>
         <ns:brin>12SS</ns:brin>
         <ns:aanleverpuntIndex>1</ns:aanleverpuntIndex>
         <ns:aanleverpuntSleutel>790F584E-59F9-449A-8BA3-77AE315721F4</ns:aanleverpuntSleutel>
         <ns:doel>PaO</ns:doel>
      </ns:controlerenAanleverpuntsleutelRequest>
   </soapenv:Body>
</soapenv:Envelope>
Element Uitleg Opmerkingen
BRIN Dit is het brinnummer van de School waar de AP's onder geregistreerd zijn. Verplicht. BRIN(4) wordt hier gebruikt (in lijn met sessie aanvraag).
aanleverpuntIndex '001', '002', etc. Verplicht. Duidt samen met BRIN het specifieke Aanleverpunt aan dat gecontroleerd wordt.
Doel OV (overstap) of PaO (Passend Onderwijs) Optioneel. Wanneer deze parameter niet wordt meegegeven wordt de waarde 'OV' toegepast door het TC.
APsleutel Unieke sleutel zoals gegenereerd in OfficeHeart/mijnOSO bij het aanmaken van een AP.


Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <over:controlerenAanleverpuntsleutelResponse xmlns:over="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
         <over:resultaat>AanleverpuntsleutelCorrect</over:resultaat>
      </over:controlerenAanleverpuntsleutelResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Overzicht meldingen

Code Resultaat Omschrijving
AanleverpuntsleutelCorrect Aanleverpunt bij APsleutel correct De validatie is succesvol
AanleverpuntsleutelIncorrect De APsleutel komt niet voor in het Register.
OngeautoriseerdAanleverpunt Het gebruikte administratiesysteem (herkend aan het OIN uit het PKIoverheid-certificaat) wijkt af het administratiesysteem dat in het register (via MijnOSO) is geregistreerd. Dit treedt bijv. op als een gebruiker een nieuw aanleverpunt (voor een nieuw type administratiesysteem) vanuit een bestaand administratiesysteem probeert te registreren.
AanleverPuntNietBekend | De opgegeven BRIN-APindex combinatie komt niet voor in het Register bij deze APsleutel
SchoolNietBekend Het BRIN komt niet voor in het register
DoelNietBekend Het opgegeven Doel heeft een afwijkende waarde (moet zijn: PaO of OV)
DoelWijktAf Het opgegeven Doel (PaO/OV) komt niet overeen met dat in het register