OSO:2022/Controleren Sessie: verschil tussen versies
< OSO:2022
Naar navigatie springen
Naar zoeken springen
k |
k |
||
Regel 143: | Regel 143: | ||
*Request (voorbeel van OV controle): |
*Request (voorbeel van OV controle): |
||
<syntaxhighlight lang="xml"> |
<syntaxhighlight lang="xml"> |
||
+ | <?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:sessiecontroleRequest> |
|
− | + | <ns1:bronBrin>00YY</ns1:bronBrin> |
|
+ | <ns1:bronRouteringsKenmerk>0000000700000YY00931</ns1:bronRouteringsKenmerk> |
||
− | <ns:bronAanleverpuntIndex>18</ns:bronAanleverpuntIndex> |
||
− | + | <ns1:doelBrin>00YY</ns1:doelBrin> |
|
+ | <ns1:doelRouteringsKenmerk>0000000700000YY00932</ns1:doelRouteringsKenmerk> |
||
− | <ns:doelAanleverpuntIndex>1</ns:doelAanleverpuntIndex> |
||
+ | <ns1:zoeksleutelPgnfrag> |
||
− | <!--You have a CHOICE of the next 2 items at this level--> |
||
− | + | <ns1:zoeksleutel><!-- Zoeksleutel hier --></ns1:zoeksleutel> |
|
+ | <ns1:pgnfrag>9468</ns1:pgnfrag> |
||
− | ySuoWyNIFbLFXXKEk+0THR7swVYa2K33xspMbFaL00NM62mA/bjbhPUJdTcwdHk/OnxnWvu/fYy5 |
||
+ | </ns1:zoeksleutelPgnfrag> |
||
− | 4y6Bn3hxkUf194biYk8=</ns:zoeksleutel> |
||
− | + | <ns1:overdrachtsoort>overstapdossier</ns1:overdrachtsoort> |
|
− | + | <ns1:sessieId>9cebd89c-8953-416b-a2cb-ecee939f1775</ns1:sessieId> |
|
− | + | </ns1:sessiecontroleRequest> |
|
− | + | </SOAP-ENV:Body> |
|
− | </ |
+ | </SOAP-ENV:Envelope> |
</syntaxhighlight> |
</syntaxhighlight> |
||
<br> |
<br> |
||
*Request (voorbeel van PaO controle): |
*Request (voorbeel van PaO controle): |
||
<syntaxhighlight lang="xml"> |
<syntaxhighlight lang="xml"> |
||
+ | <?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"> |
− | <soapenv:Header/> |
||
− | + | <SOAP-ENV:Body> |
|
− | + | <ns1:sessiecontroleRequest> |
|
− | + | <ns1:bronBrin>00YY</ns1:bronBrin> |
|
+ | <ns1:bronRouteringsKenmerk>0000000700000YY00931</ns1:bronRouteringsKenmerk> |
||
− | <ns:bronAanleverpuntIndex>19</ns:bronAanleverpuntIndex> |
||
− | + | <ns1:doelBrin>00YY</ns1:doelBrin> |
|
+ | <ns1:doelRouteringsKenmerk>0000000700000YY00932</ns1:doelRouteringsKenmerk> |
||
− | <ns:doelAanleverpuntIndex>19</ns:doelAanleverpuntIndex> |
||
⚫ | |||
− | <!--You have a CHOICE of the next 2 items at this level--> |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
</syntaxhighlight> |
</syntaxhighlight> |
||
<br> |
<br> |
||
Regel 193: | Regel 192: | ||
|- |
|- |
||
+ | | bronRouteringsKenmerk |
||
− | | bronAanleverpuntIndex |
||
− | | Dit is |
+ | | Dit is het routeringskenmerk van het bronsysteem dat bevraagd wordt (optioneel). |
| Deze parameter kan meegegeven worden als het doelsysteem één specifiek aanleverpunt van de school wil bevragen. |
| Deze parameter kan meegegeven worden als het doelsysteem één specifiek aanleverpunt van de school wil bevragen. |
||
|- |
|- |
||
| doelBrin |
| doelBrin |
||
− | | Dit is het brinnummer van het doelsysteem dat de sessie heeft aangevraagd met de overdrachtRequest. Het TC controleert of het doelsysteem bekend en actief is in het |
+ | | Dit is het brinnummer van het doelsysteem dat de sessie heeft aangevraagd met de overdrachtRequest. Het TC controleert of het doelsysteem bekend en actief is in het OSR. |
| |
| |
||
|- |
|- |
||
+ | | doelRouteringsKenmerk |
||
− | | doelAanleverpuntIndex |
||
− | | Dit is |
+ | | Dit is het routeringskenmerk van het doelsysteem dat de sessie heeft aangevraagd met de overdrachtRequest. |
| |
| |
||
|- |
|- |
||
Regel 227: | Regel 226: | ||
*Response |
*Response |
||
<syntaxhighlight lang="xml"> |
<syntaxhighlight lang="xml"> |
||
+ | <?xml version="1.0"?> |
||
− | < |
+ | <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> |
− | <soapenv:Header/> |
||
⚫ | |||
− | + | <SOAP-ENV:Body> |
|
⚫ | |||
+ | <sessiecontroleResponse xmlns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910"> |
||
− | + | <sectorAanvrager>VO</sectorAanvrager> |
|
− | </ns:sessiecontroleResponse> |
||
⚫ | |||
− | + | </SOAP-ENV:Body> |
|
− | </ |
+ | </SOAP-ENV:Envelope> |
+ | </syntaxhighlight> |
||
+ | |||
+ | Er is een nieuwe Sector toegevoegd: ONBEKEND. Wanneer een sector onbekend is word er "ONBEKEND" als sector worden teruggegeven |
||
+ | |||
+ | <syntaxhighlight lang="xml"> |
||
+ | <sectorAanvrager>ONBEKEND</sectorAanvrager> |
||
</syntaxhighlight> |
</syntaxhighlight> |
||
Versie van 19 jan 2022 14:16
Actor(s) | Goal(s) |
---|---|
Traffic Center | Bewaken van integriteit van sessie |
Bronsysteem | Vaststellen dat ontvangen verzoek een valide en geldig verzoek voor een specifiek dossier is |
Preconditie
- BronSysteem is toegelaten op OSO keten
- BronSysteem heeft geldig OSO certificaat
- BronSysteem heeft DossierRequest ontvangen van DoelSysteem
Postconditie
- Traffic Center heeft vastgesteld of gegevens uit verzoek voor Dossier overeenkomen met gegevens uit toegekende sessie.
- Traffic Center heeft vastgesteld dat Bron- én Doel- systeem valide en actieve systemen zijn binnen de OSO keten.
Basisvariant
- Als Doelsysteem en Bronsysteem aangesloten zijn op OSO
- Als gegevens uit verzoek (Documentrequest) van Doelsysteem overeenkomen met gegevens uit sessie en Pgnfrag gelijk is aan Pgnfrag van sessie*
- Traffic Center geeft sector van de Doelschool terug
- Bronsysteem levert Dossier aan Doelsysteem
- Als gegevens uit verzoek (Documentrequest) van Doelsysteem overeenkomen met gegevens uit sessie en Pgnfrag gelijk is aan Pgnfrag van sessie*
- Anders
- Traffic Center geeft foutmelding
- Bronsysteem geeft foutmelding door aan Doelsysteem
*Uitbreiding in OSO'18 (Link naar beschrijving).
Uitzonderingen en meldingen
Resultaat | Type flow (N, A, E*) | Omschrijving |
---|---|---|
Sessie is valide | N | De sector van het doelSysteem wordt teruggegeven als resultaat. |
SessieAfwijkend | A | De combinatie bron/doel brin, overdrachtsoort en zoeksleutel/koppelsleutel moeten hetzelfde zijn als in het overdrachtsRequest. Ook moet de PGNfrag gelijk zijn de PGNfrag van de Sessie. |
OnbekendAanleverpunt | A | Het bronaanleverpunt komt niet voor in de Sessie. Er is of een ander AP in het overdrachtsRequest aangegeven (Specifieke overdracht) of het AP zat niet in de lijst die het TC uitgaf bij de Sessie aanvraag. |
GeenRelatieMetDoel | A | Indien overdrachtsoort overdrachtbinnenbrin betreft, maar doel- en bronbrin wijken af |
VerstrekkerNietBekend | A | Bronschool (BRIN) is niet bekend bij het Traffic Center |
VerstrekkerAanleverpuntNietBekend | A | Bronaanleverpunt (BRIN + APindex) is niet bekend bij het Traffic Center |
VerstrekkerNietBeschikbaar | A | Bronsysteem is niet gerechtigd om de overstapservice te gebruiken. |
AanvragerNietBekend | A | De Doelschool (BRIN) is niet bekend bij het Traffic Center |
AanvragerAanleverpuntNietBekend | A | Doelaanleverpunt (BRIN + APindex) is niet bekend bij het Traffic Center |
AanvragerNietBeschikbaar | A | Doelsysteem (aanvragend AP) is (nog) niet gerechtigd om gebruik te maken van de overstapservice |
SessieOngeldig | E | Het sessieId komt niet overeen met een door het TC uitgedeeld sessieID |
SessieReedsAfgemeld | E | Het sessieId verwijst naar een sessie die al is afgemeld. |
SessieVerlopen | E | Het sessieId is verlopen. Na 10 minuten verloopt de sessie. |
RegistratieLeverancierOntbreekt | E | Leverancier is niet in het OSR geregistreerd. |
GeenContractLeverancier | E | Leverancier heeft geen contract in het OSR. |
LeverancierNietGekwalificeerd | E | De leverancier is niet gekwalificeerd. |
GeenMandaatLeverancier | E | De leverancier heeft geen mandaat in het OSR. |
AdministratiesysteemGeenType | E | Er is geen type voor deze leverancier geconfigureerd. |
BronBRINIncorrectRouteringskenmerk | E | Bron BRIN en bron routeringskenmerk komen niet overeen in het OSR. |
DoelBRINIncorrectRouteringskenmerk | E | Doel BRIN en doel routeringskenmerk komen niet overeen in het OSR. |
* N: Normaal, A: Alternatief, E: Exceptie (fout)
Aanroep en antwoord
- Request (voorbeel van OV controle):
<?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:sessiecontroleRequest>
<ns1:bronBrin>00YY</ns1:bronBrin>
<ns1:bronRouteringsKenmerk>0000000700000YY00931</ns1:bronRouteringsKenmerk>
<ns1:doelBrin>00YY</ns1:doelBrin>
<ns1:doelRouteringsKenmerk>0000000700000YY00932</ns1:doelRouteringsKenmerk>
<ns1:zoeksleutelPgnfrag>
<ns1:zoeksleutel><!-- Zoeksleutel hier --></ns1:zoeksleutel>
<ns1:pgnfrag>9468</ns1:pgnfrag>
</ns1:zoeksleutelPgnfrag>
<ns1:overdrachtsoort>overstapdossier</ns1:overdrachtsoort>
<ns1:sessieId>9cebd89c-8953-416b-a2cb-ecee939f1775</ns1:sessieId>
</ns1:sessiecontroleRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
- Request (voorbeel van PaO controle):
<?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:sessiecontroleRequest>
<ns1:bronBrin>00YY</ns1:bronBrin>
<ns1:bronRouteringsKenmerk>0000000700000YY00931</ns1:bronRouteringsKenmerk>
<ns1:doelBrin>00YY</ns1:doelBrin>
<ns1:doelRouteringsKenmerk>0000000700000YY00932</ns1:doelRouteringsKenmerk>
<ns1:koppelsleutel>19677A96-B737-402E-B3B8-24A3EEF32000</ns1:koppelsleutel>
<ns1:overdrachtsoort>swv-dossier</ns1:overdrachtsoort>
<ns1:sessieId>60d2909f-169f-4cb0-8256-5d1d5af1491d</ns1:sessieId>
</ns1:sessiecontroleRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Element | Uitleg | Opmerkingen | |
---|---|---|---|
bronBRIN | Dit is het brinnummer van de bronschool die het het dossier moet uitleveren. | De bronschool kan meerdere aanleverpunten hebben. | |
bronRouteringsKenmerk | Dit is het routeringskenmerk van het bronsysteem dat bevraagd wordt (optioneel). | Deze parameter kan meegegeven worden als het doelsysteem één specifiek aanleverpunt van de school wil bevragen. | |
doelBrin | Dit is het brinnummer van het doelsysteem dat de sessie heeft aangevraagd met de overdrachtRequest. Het TC controleert of het doelsysteem bekend en actief is in het OSR. | ||
doelRouteringsKenmerk | Dit is het routeringskenmerk van het doelsysteem dat de sessie heeft aangevraagd met de overdrachtRequest. | ||
zoeksleutel | De zoeksleutel wordt overgenomen uit het documentRequest. | Afhankelijk van de overdrachtsoort zal of de zoeksleutel of de koppelsleutel gevuld (moeten) zijn. | |
koppelsleutel | De koppelsleutel wordt overgenomen uit het documentRequest. | Afhankelijk van de overdrachtsoort zal of de zoeksleutel of de koppelsleutel gevuld (moeten) zijn. | |
overdrachtsoort | De overdrachtsoort moet voor alle berichten in de sessie gelijk zijn | Het brinnummer van het bron- en doelBrin moet hetzelfde zijn voor een binnenbrin overdracht. | |
sessieId |
- Response
<?xml version="1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<sessiecontroleResponse xmlns="http://xml.kennisnet.nl/schemas/Overstapservice/20200910">
<sectorAanvrager>VO</sectorAanvrager>
</sessiecontroleResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Er is een nieuwe Sector toegevoegd: ONBEKEND. Wanneer een sector onbekend is word er "ONBEKEND" als sector worden teruggegeven
<sectorAanvrager>ONBEKEND</sectorAanvrager>