OSO:2022/Opvragen Aanleverpunten: verschil tussen versies

Huidige versie van 9 jun 2022 om 11:58

Actor(s)	Goal(s)
BronSysteem, DoelSysteem	Overzicht opvragen van actieve Aanleverpunten/Routeringskenmerken in OSO.
Traffic Center	Leveren informatie over Aanleverpunten/Routeringskenmerken

Basisvariant: Opvragen Routeringskenmerk informatie

Met deze aanroep kan (zonder dat daar een Sessie voor nodig is) informatie over Aanleverpunten opgevraagd worden bij het TC. Deze informatie kan voor een aantal zaken gebruikt worden, zoals:

Beheren AP's in het aangesloten systeem
Voor het vullen van de keuzelijst van aanleverpunten/routeringskenmerken bij de SWV aanvragen.

NB: Alle filter parameters van deze aanroep zijn optioneel. Door geen parameter in te vullen, wordt een lijst van alle (actieve) routeringskenmerken die bij het TC bekend zijn opgevraagd. Dit is incidenteel toegestaan, maar het wordt sterk aanbevolen om 'zuinig' met deze functie om te springen én bij voorkeur een filter toe te passen!.

Preconditie

Bron/Doelsysteem is toegelaten op OSO keten
Bron/Doelsysteem heeft geldig OSO certificaat

Postconditie

TC heeft Bron/DoelSysteem overzicht van Aanleverpunten verstrekt

Request

Zonder filterparameters

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
   <soapenv:Header/>
   <soapenv:Body>
      <ns1:overzichtAanleverpuntRequest xmlns:ns1="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
         <ns1:brin>00YY</ns1:brin>
         <!-- <ns1:doel>OPTIONEEL</ns1:doel> -->
         <!-- <ns1:routeringsKenmerk>OPTIONEEL</ns1:routeringsKenmerk> -->
      </ns1:overzichtAanleverpuntRequest>
   </soapenv:Body>
</soapenv:Envelope>

Element	Uitleg	Opmerkingen
BRIN	Dit is het brinnummer van de School waar de endpoints onder geregistreerd zijn.	Optioneel. BRIN(4) wordt hier gebruikt (in lijn met sessie aanvraag).
Sector	PO, VO	Optioneel. Afgeleid van sector 'eigenaar' (school)
Doel	OV (overstap) of SWV (Passend Onderwijs)	Optioneel.

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <overzichtAanleverpuntResponse xmlns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
           <aanleverpunt>
               <brin>00YY</brin>
               <routeringsKenmerk>0000000700000YY00932</routeringsKenmerk>
               <sector>VO</sector>
               <label>00YY 0000000700000YY00932 RIS Testschool Kennisnet</label>
               <doel>OV</doel>
            </aanleverpunt>
            <aanleverpunt>
               <brin>00YY</brin>
               <routeringsKenmerk>0000000700000YY00931</routeringsKenmerk>
               <sector>VO</sector>
               <label>00YY 0000000700000YY00931 RIS Testschool Kennisnet</label>
               <doel>OV</doel>
            </aanleverpunt>
            [...]
      </overzichtAanleverpuntResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

NB 1: De aanleverpunten worden in OSR geregistreerd en beheerd.
NB 2: Het label wordt dynamisch teruggegeven.

Als in OSR het attributenlabel is gevuld is de inhoud:
<BRIN4><spatie><Routeringskenmerk><spatie><type><spatie><waarde van het OSR attributenlabel>

Zo niet, dan is de inhoud:
<BRIN4><spatie><Routeringskenmerk><spatie><type><spatie><Schoolnaam>

Uitzonderingen en meldingen

Hieronder worden alternatieve scenario's en de bijbehorende melding opgesomd:

Resultaat	Omschrijving	Toelichting
<Lijst met AP's>	TC retourneert (gefilterde) lijst met Aanleverpunten	NB: Lijst kan leeg zijn(!)
DoelNietBekend	Het opgegeven Doel heeft een afwijkende waarde (moet zijn: SWV of OV)	AP's hebben of een Doel 'SWV' of een Doel 'OV'
SectorNietBekend	De opgegeven Sector heeft een afwijkende waarde	Sector moet een geldige onderwijssector zijn (PO, VO, ..)
<Geen response>	Technische fout	Het bronsysteem staakt het opvragen van de Aanleverpunten.

@@ Regel 77: / Regel 77: @@
                <routeringsKenmerk>0000000700000YY00932</routeringsKenmerk>
                <sector>VO</sector>
-               <label>00YY 0000000700000YY00932 Testschool Kennisnet</label>
+               <label>00YY 0000000700000YY00932 RIS Testschool Kennisnet</label>
                <doel>OV</doel>
             </aanleverpunt>
@@ Regel 84: / Regel 84: @@
                <routeringsKenmerk>0000000700000YY00931</routeringsKenmerk>
                <sector>VO</sector>
-               <label>00YY 0000000700000YY00931 Testschool Kennisnet</label>
+               <label>00YY 0000000700000YY00931 RIS Testschool Kennisnet</label>
                <doel>OV</doel>
             </aanleverpunt>
@@ Regel 92: / Regel 92: @@
 </SOAP-ENV:Envelope>
 </syntaxhighlight>
-'''* NB: In OSO'22 worden de aanleverpunten in [[OSR:2019/toevoegen_en_wijzigen_van_endpoints|OSR geregistreerd en beheerd]].'''
+'''NB 1:''' De aanleverpunten worden in [[OSR:2019/toevoegen_en_wijzigen_van_endpoints|OSR geregistreerd en beheerd]].<br>
+'''NB 2:''' Het label wordt dynamisch teruggegeven.<br>
+* Als in OSR het attributenlabel is gevuld is de inhoud:<br>'''<BRIN4>'''<spatie>'''<Routeringskenmerk>'''<spatie>'''<type>'''<spatie>'''<waarde van het OSR attributenlabel>'''<br>
+<br>
+* Zo niet, dan is de inhoud:<br>'''<BRIN4>'''<spatie>'''<Routeringskenmerk>'''<spatie>'''<type>'''<spatie>'''<Schoolnaam>'''
 == Uitzonderingen en meldingen==