OSO:2022/Opvragen Aanleverpunten: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met '{|class="wikitable" ! style="text-align:left;"| Actor(s) ! style="text-align:left;"| Goal(s) |- | BronSysteem, DoelSysteem | Overzicht opvragen van actieve Aanlever...')
 
 
Regel 4: Regel 4:
 
|-
 
|-
 
| BronSysteem, DoelSysteem
 
| BronSysteem, DoelSysteem
| Overzicht opvragen van actieve Aanleverpunten in OSO.
+
| Overzicht opvragen van actieve Aanleverpunten/Routeringskenmerken in OSO.
 
|-
 
|-
 
| Traffic Center
 
| Traffic Center
| Leveren informatie over Aanleverpunten
+
| Leveren informatie over Aanleverpunten/Routeringskenmerken
 
|}
 
|}
   
== Basisvariant: Opvragen AP informatie==
+
== 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:
 
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
 
* Beheren AP's in het aangesloten systeem
 
* Voor het vullen van de keuzelijst van aanleverpunten/routeringskenmerken bij de SWV aanvragen.
* Bij het registren van AP's (via de APsleutel kan informatie over het specifieke AP worden opgehaald
 
* Voor het vullen van de keuzelijst van AP's 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) AP's 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!'''.
+
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==
 
==Preconditie==
Regel 30: Regel 29:
 
* Zonder filterparameters
 
* Zonder filterparameters
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
+
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
 
<soapenv:Header/>
 
<soapenv:Header/>
 
<soapenv:Body>
 
<soapenv:Body>
<ns:overzichtAanleverpuntRequest>
+
<ns1:overzichtAanleverpuntRequest xmlns:ns1="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
 
<ns1:brin>00YY</ns1:brin>
</ns:overzichtAanleverpuntRequest>
 
 
<!-- <ns1:doel>OPTIONEEL</ns1:doel> -->
  +
<!-- <ns1:routeringsKenmerk>OPTIONEEL</ns1:routeringsKenmerk> -->
 
</ns1:overzichtAanleverpuntRequest>
 
</soapenv:Body>
 
</soapenv:Body>
 
</soapenv:Envelope>
 
</soapenv:Envelope>
Regel 40: Regel 42:
 
</syntaxhighlight>
 
</syntaxhighlight>
   
 
* Met filter op APsleutel
 
<syntaxhighlight lang="xml">
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
 
<soapenv:Header/>
 
<soapenv:Body>
 
<ns:overzichtAanleverpuntRequest>
 
<ns:aanleverpuntSleutel>E7B01291-3DA0-4F68-BD17-AB74880050B6</ns:aanleverpuntSleutel>
 
</ns:overzichtAanleverpuntRequest>
 
</soapenv:Body>
 
</soapenv:Envelope>
 
 
</syntaxhighlight>
 
   
 
{|class="wikitable"
 
{|class="wikitable"
Regel 61: Regel 50:
 
|-
 
|-
 
| BRIN
 
| BRIN
| Dit is het brinnummer van de School waar de AP's onder geregistreerd zijn.
+
| Dit is het brinnummer van de School waar de endpoints onder geregistreerd zijn.
 
| Optioneel. BRIN(4) wordt hier gebruikt (in lijn met sessie aanvraag).
 
| Optioneel. BRIN(4) wordt hier gebruikt (in lijn met sessie aanvraag).
   
Regel 71: Regel 60:
 
|-
 
|-
 
| Doel
 
| Doel
| OV (overstap) of PaO (Passend Onderwijs)
+
| OV (overstap) of SWV (Passend Onderwijs)
 
| Optioneel.
 
| Optioneel.
 
|-
 
| APsleutel
 
| Unieke sleutel zoals gegenereerd in OfficeHeart/mijnOSO bij het aanmaken van een AP.
 
| Optioneel.
 
|-
 
   
   
Regel 89: Regel 72:
 
<SOAP-ENV:Header/>
 
<SOAP-ENV:Header/>
 
<SOAP-ENV:Body>
 
<SOAP-ENV:Body>
<over:overzichtAanleverpuntResponse xmlns:over="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
+
<overzichtAanleverpuntResponse xmlns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
<over:brin>
+
<aanleverpunt>
<over:aanleverpunt>
+
<brin>00YY</brin>
<over:brin>17PR</over:brin>
+
<routeringsKenmerk>0000000700000YY00932</routeringsKenmerk>
<over:aanleverpuntIndex>0</over:aanleverpuntIndex>
+
<sector>VO</sector>
<over:sector>PO</over:sector>
+
<label>00YY 0000000700000YY00932 Testschool Kennisnet</label>
<over:wijzigingsdatum>2013-01-01 00:00:00.0</over:wijzigingsdatum>
+
<doel>OV</doel>
<over:label>17PR00000 LAS PCBS De Wegwijzer</over:label>
+
</aanleverpunt>
<over:doel>OV</over:doel>
+
<aanleverpunt>
<over:actief>true</over:actief>
+
<brin>00YY</brin>
<over:apgeregistreerd>false</over:apgeregistreerd>
+
<routeringsKenmerk>0000000700000YY00931</routeringsKenmerk>
</over:aanleverpunt>
+
<sector>VO</sector>
  +
<label>00YY 0000000700000YY00931 Testschool Kennisnet</label>
<over:aanleverpunt>
 
<over:brin>00MS</over:brin>
+
<doel>OV</doel>
<over:aanleverpuntIndex>0</over:aanleverpuntIndex>
+
</aanleverpunt>
<over:sector>PO</over:sector>
+
[...]
 
</overzichtAanleverpuntResponse>
<over:wijzigingsdatum>2013-01-01 00:00:00.0</over:wijzigingsdatum>
 
<over:label>00MS00000 LAS Professor Waterinkschool School voor SO</over:label>
 
<over:doel>OV</over:doel>
 
<over:actief>true</over:actief>
 
<over:apgeregistreerd>true</over:apgeregistreerd>
 
</over:aanleverpunt>
 
</over:brin>
 
</over:overzichtAanleverpuntResponse>
 
 
</SOAP-ENV:Body>
 
</SOAP-ENV:Body>
 
</SOAP-ENV:Envelope>
 
</SOAP-ENV:Envelope>
 
</syntaxhighlight>
 
</syntaxhighlight>
'''* NB: In OSO'18 is het nieuwe element APgeregistreerd <over:apgereigstreerd>) toegevoegd aan de response. Dit veld geeft aan of een [[OSO:2018/Registreren_Aanleverpunt|aanleverpunt geregistreerd]] is.'''
+
'''* NB: In OSO'22 worden de aanleverpunten in [[OSR:2019/toevoegen_en_wijzigen_van_endpoints|OSR geregistreerd en beheerd]].'''
   
 
== Uitzonderingen en meldingen==
 
== Uitzonderingen en meldingen==
Regel 133: Regel 109:
 
|-
 
|-
 
| '''DoelNietBekend'''
 
| '''DoelNietBekend'''
| Het opgegeven Doel heeft een afwijkende waarde (moet zijn: PaO of OV)
+
| Het opgegeven Doel heeft een afwijkende waarde (moet zijn: SWV of OV)
| AP's hebben of een Doel 'PaO' of een Doel 'OV'
+
| AP's hebben of een Doel 'SWV' of een Doel 'OV'
   
 
|-
 
|-

Huidige versie van 27 jan 2022 om 12:44

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 Testschool Kennisnet</label>
               <doel>OV</doel>
            </aanleverpunt>
            <aanleverpunt>
               <brin>00YY</brin>
               <routeringsKenmerk>0000000700000YY00931</routeringsKenmerk>
               <sector>VO</sector>
               <label>00YY 0000000700000YY00931 Testschool Kennisnet</label>
               <doel>OV</doel>
            </aanleverpunt>
            [...]
      </overzichtAanleverpuntResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

* NB: In OSO'22 worden de aanleverpunten in OSR geregistreerd en beheerd.

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.