OSO:2018/Registreren Aanleverpunt

Uit Kennisnet Developers Documentatie
< OSO:2018
Versie door Bindadin01 (overleg | bijdragen) op 18 apr 2018 om 15:30 (Basisscenario)
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Ga naar: navigatie, zoeken

Overstapservice Onderwijs-symbol.png Overstapservice Onderwijs: 2018/Registreren Aanleverpunt

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 valideren van de invoer bij een Aanleverpunt.

Basisscenario

Registreer aanleverpunt.jpeg
  1. Een Schoolsysteem verstuurt een registreer Aanleverpunt request naar het Traffic Center.
  2. 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.
  3. If Aanleverpunt geregistreerd mag worden
    1. Het Traffic Center registreert het Aanleverpunt in het Register
  4. Else
    1. Aanleverpunt verstuur foutmelding aan Schoolsysteem
  • Request
<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>
  • Response:
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>

Overzicht meldingen

Resultaat Type flow (N, A, E) 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.