OSO:2022/Registreren Aanleverpunt: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met '==Context== In het Register wordt per School bijgehouden welke Aanleverpunten bekend zijn. Een Schoolmedewerker kan via 'MijnOSO' Aanleverpunten aanmaken en beheren...')
 
(Tekst vervangen door "Endpoints in OSO'22 worden in OSR aangemaakt. Zie OSR wiki")
Label: Vervangen
 
Regel 1: Regel 1:
  +
Endpoints in OSO'22 worden in OSR aangemaakt. Zie [[OSR:Hoofdpagina|OSR wiki]]
==Context==
 
In het Register wordt per School bijgehouden welke Aanleverpunten bekend zijn. Een Schoolmedewerker kan via 'MijnOSO' Aanleverpunten aanmaken en beheren. Als een Aanleverpunt is aangemaakt kan de Schoolmedewerker die in het Schoolsysteem registreren. Via de Aanleverpunt registratie wordt een Aanleverpunt in het Register 'gekoppeld' aan een Aanleverpunt zoals dat in een Schoolsysteem is aangemaakt. Daarnaast wordt via deze aanroep vanuit het Schoolsysteem de correct url van het Aanleverpunt ingesteld. Zowel Bron- als Doel- systemen moeten hun Aanleverpunten registreren. (Bronsystemen kunnen zonder registratie geen Notificatie ontvangen).
 
 
Leveranciers kunnen ervoor kiezen om deze aanroep te combineren met het [[OSO:2018/Controleren_Aanleverpunt|valideren van de invoer bij een Aanleverpunt]].
 
 
== Basisscenario==
 
 
[[Bestand:Registreer_aanleverpunt.jpeg|thumb|400px]]
 
 
# Een Schoolsysteem verstuurt een registreer Aanleverpunt request naar het Traffic Center.
 
# Het Traffic Center controleert of het Aanleverpunt bekend is in het Register en of het Schoolsysteem gemachtigd is om de url van dit Aanleverpunt te registreren.
 
# '''If''' Aanleverpunt geregistreerd mag worden
 
## Het Traffic Center registreert het Aanleverpunt in het Register
 
# '''Else'''
 
## Aanleverpunt verstuur foutmelding aan Schoolsysteem
 
 
*Request
 
 
<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:registrerenAanleverpuntRequest>
 
<ns:aanleverpuntIndex>0</ns:aanleverpuntIndex>
 
<ns:brin>00YY</ns:brin>
 
<ns:url>https://ott-sb.kennisnet.nl/aanleverpunt</ns:url>
 
</ns:registrerenAanleverpuntRequest>
 
</soapenv:Body>
 
</soapenv:Envelope>
 
</syntaxhighlight>
 
 
*Response:
 
 
<syntaxhighlight lang="xml">
 
Response:
 
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
 
<SOAP-ENV:Header/>
 
<SOAP-ENV:Body>
 
<over:registrerenAanleverpuntResponse xmlns:over="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
 
<over:resultaat>RegistratieGelukt</over:resultaat>
 
</over:registrerenAanleverpuntResponse>
 
</SOAP-ENV:Body>
 
</SOAP-ENV:Envelope>
 
</syntaxhighlight>
 
 
==Overzicht meldingen==
 
{|class="wikitable"
 
! style="text-align:left;"| Resultaat
 
! style="text-align:left;"| Type flow (N, A, E)
 
! style="text-align:left;"| Omschrijving
 
!
 
|-
 
| | RegistratieGelukt
 
| N
 
| | De URL is geregistreerd voor het aanleverpunt
 
|
 
|-
 
 
| | SchoolNietBekend
 
| E
 
| | Het gebruikte certificaat correspondeert met het BRIN-nummer en aanleverpunt in de registreerAanleverpuntRequest, echter het BRIN-nummer is niet bekend in het Traffic Center. Dit scenario kan voorkomen indien een school is gedeactiveerd in het Traffic Center.
 
|-
 
 
| AanleverpuntNietBekend
 
| A
 
| Aanleverpunt (BRIN + APindex) is niet bekend bij het Traffic Center
 
|-
 
 
| | OngeautoriseerdAanleverpunt
 
| E
 
| | De aanleverpuntcode in het gebruikte certificaat correspondeert niet met het aanleverpunt in het registreerAanleverpuntRequest. Het bronsysteem probeert een een URL te registreren voor een aanleverpunt met een certificaat dat bedoeld is voor een ander aanleverpunt.
 
|-
 
 
| | OngeldigeURL
 
| E
 
| | De URL die meegegeven werd in het registreerAanleverpuntRequest is niet valide.
 
|-
 
 
 
|}
 
 
 
[[Categorie:Overstapservice Onderwijs]]
 
[[Categorie:Book OSO|41]]
 

Huidige versie van 10 feb 2022 om 12:09

Endpoints in OSO'22 worden in OSR aangemaakt. Zie OSR wiki