OSO:2018/Opvragen Aanleverpunten: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
(Request)
(Request)
 
(5 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 30: Regel 30:
 
* Zonder filterparameters
 
* Zonder filterparameters
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.eld.nl/schemas/Overstapservice/20180404">
+
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
 
<soapenv:Header/>
 
<soapenv:Header/>
 
<soapenv:Body>
 
<soapenv:Body>
Regel 43: Regel 43:
 
* Met filter op APsleutel
 
* Met filter op APsleutel
 
<syntaxhighlight lang="xml">
 
<syntaxhighlight lang="xml">
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.eld.nl/schemas/Overstapservice/20180404">
+
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
 
<soapenv:Header/>
 
<soapenv:Header/>
 
<soapenv:Body>
 
<soapenv:Body>
Regel 78: Regel 78:
 
| Unieke sleutel zoals gegenereerd in OfficeHeart/mijnOSO bij het aanmaken van een AP.
 
| Unieke sleutel zoals gegenereerd in OfficeHeart/mijnOSO bij het aanmaken van een AP.
 
| Optioneel.
 
| Optioneel.
  +
|-
  +
   
|-
 
| Actief
 
|
 
| Optioneel. Zonder een waarde aan deze parameter te geven worden alle AP's teruggegeven.
 
 
|}
 
|}
   
Regel 91: Regel 89:
 
<SOAP-ENV:Header/>
 
<SOAP-ENV:Header/>
 
<SOAP-ENV:Body>
 
<SOAP-ENV:Body>
<over:overzichtAanleverpuntResponse xmlns:over="http://xml.eld.nl/schemas/Overstapservice/20170401">
+
<over:overzichtAanleverpuntResponse xmlns:over="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
 
<over:brin>
 
<over:brin>
 
<over:aanleverpunt>
 
<over:aanleverpunt>
Regel 100: Regel 98:
 
<over:label>17PR00000 LAS PCBS De Wegwijzer</over:label>
 
<over:label>17PR00000 LAS PCBS De Wegwijzer</over:label>
 
<over:doel>OV</over:doel>
 
<over:doel>OV</over:doel>
  +
<over:actief>true</over:actief>
  +
<over:apgeregistreerd>false</over:apgeregistreerd>
 
</over:aanleverpunt>
 
</over:aanleverpunt>
 
<over:aanleverpunt>
 
<over:aanleverpunt>
Regel 108: Regel 108:
 
<over:label>00MS00000 LAS Professor Waterinkschool School voor SO</over:label>
 
<over:label>00MS00000 LAS Professor Waterinkschool School voor SO</over:label>
 
<over:doel>OV</over:doel>
 
<over:doel>OV</over:doel>
  +
<over:actief>true</over:actief>
  +
<over:apgeregistreerd>true</over:apgeregistreerd>
 
</over:aanleverpunt>
 
</over:aanleverpunt>
 
</over:brin>
 
</over:brin>
Regel 114: Regel 116:
 
</SOAP-ENV:Envelope>
 
</SOAP-ENV:Envelope>
 
</syntaxhighlight>
 
</syntaxhighlight>
'''* NB: In OSO'18 wordt 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'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.'''
   
 
== Uitzonderingen en meldingen==
 
== Uitzonderingen en meldingen==

Huidige versie van 12 jun 2018 om 13:06

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

Basisvariant: Opvragen AP 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
  • 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!.

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/20180404">
   <soapenv:Header/>
   <soapenv:Body>
      <ns:overzichtAanleverpuntRequest>
      </ns:overzichtAanleverpuntRequest>
   </soapenv:Body>
</soapenv:Envelope>


  • Met filter op APsleutel
<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>
Element Uitleg Opmerkingen
BRIN Dit is het brinnummer van de School waar de AP's 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 PaO (Passend Onderwijs) Optioneel.
APsleutel Unieke sleutel zoals gegenereerd in OfficeHeart/mijnOSO bij het aanmaken van een AP. Optioneel.

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <over:overzichtAanleverpuntResponse xmlns:over="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
         <over:brin>
            <over:aanleverpunt>
               <over:brin>17PR</over:brin>
               <over:aanleverpuntIndex>0</over:aanleverpuntIndex>
               <over:sector>PO</over:sector>
               <over:wijzigingsdatum>2013-01-01 00:00:00.0</over:wijzigingsdatum>
               <over:label>17PR00000 LAS PCBS De Wegwijzer</over:label>
               <over:doel>OV</over:doel>
               <over:actief>true</over:actief>
               <over:apgeregistreerd>false</over:apgeregistreerd>
            </over:aanleverpunt>
            <over:aanleverpunt>
               <over:brin>00MS</over:brin>
               <over:aanleverpuntIndex>0</over:aanleverpuntIndex>
               <over:sector>PO</over:sector>
               <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:Envelope>

* NB: In OSO'18 is het nieuwe element APgeregistreerd <over:apgereigstreerd>) toegevoegd aan de response. Dit veld geeft aan of een aanleverpunt geregistreerd is.

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: PaO of OV) AP's hebben of een Doel 'PaO' 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.