OSO:2017/Opvragen Aanleverpunten

Uit Kennisnet Developers Documentatie
< OSO:2017
Versie door Vankrimpen01 (overleg | bijdragen) op 23 feb 2017 om 12:07 (Uitzonderingen en meldingen)
Ga naar: navigatie, zoeken

Overstapservice Onderwijs-symbol.png Overstapservice Onderwijs: 2017/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 gevraagd en sterk aanbevolen om 'zuinig' met deze functie om te springen.


Preconditie

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

Postconditie

  • TC heeft Bron/DoelSysteem overzicht van Aanleverpunten verstrekt


Aanroep en antwoord

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.
Actief Optioneel. Impliciet

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(!)
AanvragerNietBekend Het bronsysteem is niet bekend bij het Traffic Center. De aanvrager is niet gerechtigd om de overstapservice te gebruiken. Er is geen OIN gevonden in het PKI certificaat met een waarde die bekend is bij het TC
<Geen response> Technische fout Het bronsysteem staakt het opvragen van de Aanleverpunten.