OSO:2022/Afmelden Sessie

Uit Kennisnet Developers Documentatie
< OSO:2022
Versie door Lyczba01 (overleg | bijdragen) op 19 jan 2022 om 14:59
(wijz) ← Oudere versie | Huidige versie (wijz) | Nieuwere versie → (wijz)
Naar navigatie springen Naar zoeken springen
Actor(s) Goal(s)
Doelsysteem Afronden opvraagsessie
Traffic Center Afronden opvraagsessie en vastleggen resultaat van sessie

Context

Afmelden sessie is de laatste stap in het doorlopen van een transactie voor het opvragen van een dossier of het doorgeven van een notificatie.

  • Dossier opvragen: Doelsysteem meldt sessie af bij Traffic Center en geeft 'beste resultaat': Het 'hoogste resultaat' op de resultaat tabel [resultaten] dat binnen de sessie teruggegeven is door een bevraagd endpoint.

Er kunnen meerdere endpoints bevraagd zijn. Wanneer het beste resultaat bij meerdere endpoints is behaald, dan moet het laatst bevraagde endpoint met dat resultaat worden teruggegeven.

Preconditie

  • Doelsysteem heeft een geldige sessie aangevraagd en toegekend gekregen
  • Bronsysteem heeft een verzoek voor een specifiek dossier van Systeem (doelschool) ontvangen
  • Bronsysteem heeft verzoek tegen sessie laten controleren door Traffic Center
  • Bronsysteem heeft verzoek voor dossier afgehandeld
  • Er zijn geen Bronsysteem meer beschikbaar die binnen deze sessie bevraagd kunnen worden.

Postconditie

  1. Sessie is geregistreerd als afgerond door Traffic Center
  2. 'Beste resultaat' is vastgelegd door Traffic Center

Basic Scenario

  1. Doelsysteem verzoekt Traffic Center om sessie als afgerond te registreren
  2. IF de sessie bekend is AND de sessie gegevens komen overeen met de gegevens in het verzoek
    1. Traffic Center registreert de sessie als afgerond
  3. ELSE afwijking in sessie gegevens
    1. Traffic Center geeft foutmelding
    2. Doelsysteem beëindigt Sessie (geen terugkoppeling naar eindgebruiker)
  4. ENDIF

Uitzonderingen en meldingen

Hieronder worden alternatieve scenario's en de bijbehorende melding opgesomd:
.

Resultaat Omschrijving Toelichting Melding aan Eindgebruiker
OverdrachtGeslaagd Afmelding is correct ontvangen door het Traffic Center Afmelding is correct ontvangen door het Traffic Center en zal daar verder worden verwerkt. NvT
AanvragerNietBekend Doelsysteem is niet bekend bij het Traffic Center In het Register is de combinatie van DoelBRIN en Routeringskenmerk niet aanwezig. Je systeem probeert het document overdracht af te melden met een foutieve brin + routeringskenmerk code combinatie.
AanvragerAanleverpuntNietBekend Het meegegeven routeringskenmerk is niet geregistreerd voor deze aanvrager Het routeringskenmerk is in het Register niet gekoppeld voor aan dit Doelsysteem/Leverancier Het routeringskenmerk waarmee de overdracht wordt afgemeld, is niet geregistreerd voor je school.
AanvragerNietBeschikbaar Doelsysteem (aanvragend AP) is (nog) niet gerechtigd om gebruik te maken van de overstapservice Het doelsysteem is bekend bij het TC, maar (nog) niet toegelaten op het OSO netwerk. Mogelijke oorzaken: Het routeringskenmerk is nog niet aangemaakt in de OSR. Er heeft zich een interne fout voorgedaan tijdens de overdracht. Neem contact op met je software leverancier.
OnbekendAanleverpunt Er is in 'SessiecontroleRequest' een routeringskenmerk gebruikt, dat niet in de bijbehorende 'OverdrachtResponse' verkregen is. Bij het initiëren van de Sessie geeft het TC een lijst met te bevragen routeringskenmerken terug. Dit meegestuurde routeringskenmerk was niet aanwezig in die lijst. Er heeft zich een interne fout voorgedaan tijdens de overdracht. Neem contact op met je software leverancier.
VerstrekkerNietBekend De verstrekker is niet bekend bij het Traffic Center De gemelde Bronschool (BRIN) is niet geregistreerd. Je systeem probeert de sessie af te melden met een BRIN van de bronschool dat niet bekend is in het OSO register.
VerstrekkerAanleverpuntNietBekend Het meegegeven routeringskenmerk is niet geregistreerd voor deze verstrekker De endpoint (BRIN + Routeringskenmerk) van de Bronschool is niet bekend in het Register. Je systeem probeert de sessie af te melden met een meegegeven routeringskenmerk dat niet is geregistreerd voor de verstrekker van het dossier.
VerstrekkerNietBeschikbaar De verstrekker is niet gerechtigd om de overstapservice te gebruiken Je systeem probeert de sessie af te melden met een Bronsysteem code dat niet gerechtigd om de overstapservice te gebruiken.
SessieVerlopen De sessie is verlopen; de sessie-time-out is verstreken. De sessie kan niet worden afgemeld omdat deze reeds verlopen is.
SessieNietGecontroleerd Bij de sessiecontrole is door het TC een sessiefout geconstateerd. Het bevraagde routeringskenmerk kreeg deze fout terug bij het controleren van de Sessie De sessie kon niet worden gecontroleerd en hierdoor niet worden afgemeld.
SessieOngeldig De sessie is ongeldig; het ID is nooit uitgedeeld. Het sessieId komt niet overeen met datgene wat verstrekt is in het overdrachtsResponse. De sessie is ongeldig en kan hierdoor niet worden afgemeld.
SessieReedsAfgemeld De sessie is al eerder afgemeld. De sessie kan niet worden afgemeld omdat deze al afgemeld is.
RegistratieLeverancierOntbreekt Leverancier is niet in het OSR geregistreerd. De leverancier die de sessiecontrole probeert uit te voeren is niet geregistreerd in het OSR. Leverancier is niet in het OSR geregistreerd.
GeenContractLeverancier Leverancier heeft geen contract in het OSR. De leverancier die de sessiecontrole probeert uit te voeren heeft geen contract in het OSR. Leverancier heeft geen contract in het OSR.
LeverancierNietGekwalificeerd De leverancier is niet gekwalificeerd. De leverancier die de sessiecontrole probeert uit te voeren is niet gekwalificeerd in het OSR. De leverancier is niet gekwalificeerd.
GeenMandaatLeverancier De leverancier heeft geen mandaat in het OSR. De leverancier die de sessiecontrole probeert uit te voeren heeft geen mandaat in het OSR. De leverancier heeft geen mandaat in het OSR.
AdministratiesysteemGeenType Er is geen type voor deze leverancier geconfigureerd. De leverancier heeft geen type definitie in TC admin. Er is geen type voor deze leverancier geconfigureerd.
BronBRINIncorrectRouteringskenmerk Bron BRIN en bron routeringskenmerk komen niet overeen in het OSR. Bron BRIN en bron routeringskenmerk komen wijken af in de registratie binnen het OSR. Bron BRIN en bron routeringskenmerk komen niet overeen in het OSR.
DoelBRINIncorrectRouteringskenmerk Doel BRIN en doel routeringskenmerk komen niet overeen in het OSR. Doel BRIN en doel routeringskenmerk komen wijken af in de registratie binnen het OSR. Doel BRIN en doel routeringskenmerk komen niet overeen in het OSR.
<Geen response> Het Traffic Center geeft een time out of technische fout. Het aanvragende Bronsysteem staakt de verdere aanvraag en geeft de eindgebruiker hierover een foutmelding. Het OSO systeem geeft een time out of technische fout en hierdoor kan de sessie niet afgemeld worden.

Aanroep en antwoord

  • Request:
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
  <SOAP-ENV:Body>
    <ns1:afmeldingRequest>
      <ns1:bronBrin>00YY</ns1:bronBrin>
      <ns1:bronRouteringsKenmerk>0000000700000YY00931</ns1:bronRouteringsKenmerk>
      <ns1:doelBrin>00YY</ns1:doelBrin>
      <ns1:doelRouteringsKenmerk>0000000700000YY00932</ns1:doelRouteringsKenmerk>
      <ns1:sessieId>4a85e7ca-c53b-4674-98e2-aa0cc17ac5b3</ns1:sessieId>
      <ns1:status>VerstrekkingGeslaagd</ns1:status>
    </ns1:afmeldingRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Element Uitleg Opmerkingen
bronBrin Dit is het brinnummer van het Bronsysteem. Het TC controleert of het Bronsysteem bekend en actief is in het deelnemersregister. (Verplicht)
bronRouteringsKenmerk (Verplicht). Dit is het routeringskenmerk van het bronSysteem, dat (als laatste endpoint) het overeenkomstige resultaat (uit de de documentResponse) heeft gegeven aan het doelSysteem. Er kunnen meerdere endpoints bevraagd zijn. Wanneer de beste resultaat bij meerdere endpoints is behaald, dan moet het laatst bevraagde endpoint met dat resultaat worden teruggegeven.
doelBrin Dit is het brinnummer van het Doelsysteem. Het TC controleert of het Doelsysteem bekend en actief is in het deelnemersregister.
doelRouteringsKenmerk Dit is het routeringskenmerk van de endpoint van het Doelsysteem.
sessieId Dit is de sessieId die ontvangen is in de overdrachtsResponse en gebruikt is in de communicatie met het bronSysteem.
status Dit is het resultaatbericht dat het doelsysteem heeft ontvangen bij het aflopen van de routeringskenmerken bij het opvragen van een dossier in de documentRequest. Als het doelSysteem het dossier succesvol heeft ontvangen, dan stuurt het bronSysteem geen foutmelding en moet het doelSysteem het resultaat 'VerstrekkingGeslaagd' meegegeven in het statusveld. Bij meerdere meldingen van meerdere routeringskenmerken wordt het 'beste resultaat' doorgegeven, bepaald door de hoogste plaats in de tabel Meldingen bij opvragen Dossier.
  • Response:
<?xml version="1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <afmeldingResponse xmlns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
      <resultaat>OverdrachtGeslaagd</resultaat>
    </afmeldingResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>