OSO:2017/Opvragen Aanleverpunten: verschil tussen versies

Versie van 15 feb 2017 16:20

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	A/E^*	Omschrijving	Toelichting

^* A: Alternatief, E: Exceptie (fout)

@@ Regel 9: / Regel 9: @@
 | 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==
@@ Regel 18: / Regel 27: @@
+==Aanroep en antwoord==
-* NB: Alleen AP's van actieve scholen(!)
-* Filtering mogelijk per school, schooltype?
+{|class="wikitable"
-* Geleverde informatie (velden) van AP:
+! style="text-align:left;"| Element
-** label
+! style="text-align:left;"| Uitleg
-** BRIN(4)
+! style="text-align:left;"| Opmerkingen
-** APindex
-** wijzigingsdatum
+|-
-** sector (PO, VO, MBO(?))
+| BRIN
-*I type: (OV(overstap), SWV(samenwerkingsverband))
+| 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:<BR>
+{|class="wikitable"
+! style="text-align:left;"| Resultaat
+! style="text-align:left;"| A/E<sup>*</sup>
+! style="text-align:left;"| Omschrijving
+! style="text-align:left;"| Toelichting
+|-
+|}
+<sup>*</sup> A: Alternatief, E: Exceptie (fout)
+[[Categorie:Overstapservice Onderwijs]]
+[[Category:Book OSO|Book OSO]]