3.3 X-tee sõnumi päis

X-tee reeglite kohaselt peab sõnumites alati kirjeldama ja edastama kohustuslikud spetsiifilised X-tee päised. Päised peavad olema õige struktuuriga ja õiges nimeruumis, milleks on http://x-road.eu/xsd/identifiers. Kohustuslikud ning täiendavad päiseväljad on kirjeldatud X-tee sõnumiprotokolli spetsifikatsioonis (http://x-road.eu/docs/x-road_message_protocol_v4.0.pdf).

3.3.1 X-tee kohustuslikud päiseväljad on järgmised:

  • <client> - kohustuslik komplekstüüpi väli, mis identifitseerib päringu algatanud kliendi ning on kirjeldatud järgmiste elementidega:

xRoadInstance – välja väärtus Eesti X-tee liikmete jaoks on toodangukeskkonnas EE, testkeskkonnas ee-test ja arenduskeskkonnas ee-dev;

memberClass – väli eristab liikmeklasse (GOV – Eesti asutused, COM – Eesti äriühingud, NGO – Eesti sihtasutused ja mittetulundusühingud, NEE – teiste riikide asutused ja ettevõtted);

memberCode – välja väärtus on asutuse registrikood;

subsystemCode – välja väärtus vastab alamsüsteemi nimele.

  • <service> või <centralService> - komplekstüüpi väljad, millest ühe kasutamine on kohustuslik. Väli määrab kasutatava andmeteenuse. Välja kirjeldavad elemendid on samad nagu väljal <client> (xRoadInstance, meberClass, memberCode ja subsystemCode), millele lisanduvad väljad:

serviceCode – andmeteenuse SOAP-sõnumile vastava mähkurelemendi nimi;

serviceVersion – andmeteenuse versioon.

  • <id> - kohustuslik väli, mille väärtus on sõnumi unikaalne identifikaator. Sõnumi identifikaator peab olema igal liikmel unikaalne. <id> välja soovituslik formaat on UUID. Vaata ka  https://en.wikipedia.org/wiki/Universally_unique_identifier
  • <protocolVersion> - kohustuslik väli, mis näitab X-tee sõnumiprotokolli versiooni. Välja väärtus peab olema 4.0
  • <requestHash> – antud päise sisu on automaatselt täidetud turvaserveri poolt. Väli omab sisu ainult vastussõnumite puhul, ning sisaldab päringu räsi.
  • <requestHash/@algorithmId> – antud atribuudi sisu näitab, millist algoritmi kasutati päringu räsi arvutamisel.

3.3.2 X-tee mittekohustuslikud täiendavad päiseväljad on järgmised:

  • <userId> - mittekohustuslik väli, mille väärtus on päringu algatanud kasutaja isikukood koos kahetähelise ISO riigikoodi prefiksiga (näiteks, EE12345678901). Juhul kui lõppkasutaja on autenditud, siis peab userID väli olema kaasa pandud;
  • <issue> - mittekohustuslik väli, mille väärtus on päringu tegemise alus (päringu tegija sisemine kood tähistamaks toimikut, viidet dokumendihalduses vms).  Võimaldab viidata päringutele näiteks juhul, kui tegu on isikuandmete kasutamisega ning on vaja vastata kodaniku või Andmekaitse Inspektsiooni järelpärimistele.


Viimati muudetud: kolmapäev, 30. august 2017, 16.06