OSO:2018/Opvragen Aanleverpunten
< OSO:2018
Naar navigatie springen
Naar zoeken springen
Overstapservice Onderwijs: 2018/Opvragen Aanleverpunten
| 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 meldingenHieronder worden alternatieve scenario's en de bijbehorende melding opgesomd:
|