OSO:2018/Ping Traffic Center

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken

Context

Het Traffic Center is een essentieel onderdeel in de communicatie tussen Doel- en Bronsysteem. Voor beide partijen is het van belang om te weten of het Traffic Center online is. De operationele status van het Traffic Center kan opgevraagd worden met behulp van de ping service. Dit is een optionele service en kan ten alle tijden worden gebruikt om de status van het Traffic Center op te vragen. Indien het Traffic Center online is, wordt er een positief antwoord teruggegeven omtrent de beschikbaarheid en het versienummer van de software op het Traffic Center.

Basisscenario

Sequence Diagram Ping Service.jpeg
  1. Een Schoolsysteem verstuurt een ping request naar het Traffic Center.
  2. Het Traffic Center controleert of er op dit moment geen onderhoudswerkzaamheden plaatsvinden en het systeem beschikbaar is voor uitwisselingen
  3. Het Traffic Center geeft een positief antwoord terug omtrent de beschikbaarheid, het versienummer van de software welke op het Traffic Center draait en de huidige systeemtijd.


  • Exceptions:

Het Traffic Center geeft een negatief antwoord terug omtrent de beschikbaarheid, het versienummer van de software welke op het Traffic Center draait en de huidige systeemtijd. Het Traffic Center is niet beschikbaar en/of de omgeving waar het Traffic Center op draait is niet beschikbaar. Er wordt geen antwoord teruggegeven aan het doelSysteem. Afhankelijk van de timeout instellingen bij het doelSysteem wordt er een timeout teruggegeven.

  • 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:pingRequest/>
   </soapenv:Body>
</soapenv:Envelope>


  • Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <over:pingResponse xmlns:over="http://xml.kennisnet.nl/schemas/Overstapservice/20180404">
			<over:available>true</over:available>
			<over:applicationVersion>18.1.2-SNAPSHOT</over:applicationVersion>
			<over:systemTime>2018-04-18T15:17:47.822+02:00</over:systemTime>
		</over:pingResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sequence Diagram Ping Service

Ping service.jpeg


Overzicht meldingen

Resultaat Type flow (N, A, E) Omschrijving
True N Het Traffic Center is beschikbaar.
False A Het Traffic Center is niet beschikbaar. Er vinden op dit moment onderhoudswerkzaamheden plaats.
Timeout E Indien het Traffic Center binnen 30 seconden geen response teruggeeft, moet de initiator een time-out (fout) afhandelen (en melden aan eindgebruiker).