Aruandesõnumi üldkirjeldus

Aruandesõnum on XML-dokument, mille struktuur ja sisu on määratud XML-skeemiga https://aruandlus.eestipank.ee/reports/x_headers.xsd või https://aruandlus.eestipank.ee/reports/x_headers_subrep.xsd (kui esitataval aruandel on alamaruandeid) ning konkreetse aruande skeemiga, koosnedes päisest ja aruandeosast, olles üldkujul järgmine:

<message>

<message_header>
...
</message_header>
<report>
...
</report>

</message>

Sõnumi päis

Element XML-element Kohustuslik Tüüp
Sõnumi päis message_header Jah  
Aruandesubjekti kood from Jah LEI-kood, äriregistri- või aruandja kood
Sõnumi loomise hetk date Jah YYYY-MM-DDThh:mm:ss
Edastaja nimi sender Jah Tekst 6..40
Edastaja e-mail send_mail Jah e-maili aadress
Edastaja telefon send_phone Ei Tekst 5..20
Kommentaar comment Ei Tekst
Sõnumile vastuse nõue* require_receipt Ei yes/no

* Omab tähendust, kui sõnum edastatakse e-mailiga või veebiteenusega. 

Näide:

<message_header>

<from>549300PHQZ4HL15HH975</from>
<date>2018-10-10T11:12:13</date>
<sender>Jaan Kask</sender>
<send_mail>jaan.kask [at] maapank.ee</send_mail>
<send_phone>6666666</send_phone>
<require_receipt>yes</require_receipt>

</message_header>

Aruandeosa, kui alamaruanded puuduvad

<report>

<report_header>
...
</report_header>
<row>
...
</row>
...                
<row>
...                
</row>

</report>

Aruandeosa, kui esinevad alamaruanded

<report>

<report_header>
...
</report_header>

<subreport_1>

<row>
...
</row>
...                
<row>
...
</row>

</subreport_1>

<subreport_2>

<row>
...
</row>
...                
<row>
...                
</row>

</subreport_2>

</report>

Aruande päis

Element XML-element Kohustuslik Tüüp
Aruande päis report_header Jah  
Aruande kood typeid Jah Täisarv
Aruande väärtuspäev timeid Jah YYYY-MM-DD
Aruande koostaja nimi compiler Jah Tekst 6..40
Aruande koostaja e-mail comp_mail Jah e-maili aadress
Aruande koostaja telefon comp_phone Jah Tekst 5..20

Näide:

<report_header>

<typeid>162</typeid>
<timeid>2018-09-30</timeid>
<compiler>Jelizaveta Ivanova</compiler>
<comp_mail>liza [at] maapank.ee</comp_mail>
<comp_phone>7777777</comp_phone>

</report_header>

Alamaruanne

Element XML-element Kohustuslik Tüüp
Alamaruande päis Vastavalt aruande skeemile Jah* Vastavalt aruande skeemile
Alamaruande rida row Jah*  
Alamaruande rea 1. element Vastavalt aruande skeemile Jah* Vastavalt aruande skeemile
Alamaruande rea 2. element Vastavalt aruande skeemile Jah* Vastavalt aruande skeemile
... ... ...  

* Tühja alamaruande puhul mitte. 

Näide:

<E_11>

<row>

<riik>US</riik>
<seis_eel_lopp>27304</seis_eel_lopp>
<seis_lopp>27304</seis_lopp>

</row>

<row>

<riik>DE</riik>
<seis_eel_lopp>161</seis_eel_lopp>
<seis_lopp>161</seis_lopp>

</row>

</E_11>

Aruande rida

Element XML-element Kohustuslik Tüüp
Aruande rida row Jah*  
Rea 1. element Vastavalt aruande skeemile Jah* Vastavalt aruande skeemile
Rea 2. element Vastavalt aruande skeemile Jah* Vastavalt aruande skeemile
... ... ...  

* Tühja aruande puhul mitte. 

Näide:

<row>

<pangakaart_liik_1>11</pangakaart_liik_1>
<pangakaart_liik_2>9</pangakaart_liik_2>
<kasutussagedus>1</kasutussagedus>
<pangakaartide_arv>39739</pangakaartide_arv>

</row>

Näide terviklikust xml-dokumendina vormindatud aruandesõnumist (alamaruanneteta variant)

<?xml version="1.0" encoding="UTF-8"?>
<message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="x_aruanne162.xsd">

<message_header>

<from>549300PHQZ4HL15HH975</from>
<date>2018-10-10T11:12:13</date>
<sender>Jaan Kask</sender>
<send_mail>jaan.kask [at] maapank.ee</send_mail>
<send_phone>6666666</send_phone>
<require_receipt>yes</require_receipt>

</message_header>

<report>

<report_header>
<typeid>162</typeid>
<timeid>2018-09-30</timeid>
<compiler>Jelizaveta Ivanova</compiler>
<comp_mail>liza [at] maapank.ee</comp_mail>
<comp_phone>7777777</comp_phone>
</report_header>

<row>

<pangakaart_liik_1>2</pangakaart_liik_1>
<pangakaart_liik_2>1</pangakaart_liik_2>
<kasutussagedus>2</kasutussagedus>
<pangakaartide_arv>1520</pangakaartide_arv>

</row>
<row>

<pangakaart_liik_1>1</pangakaart_liik_1>
<pangakaart_liik_2>1</pangakaart_liik_2>
<kasutussagedus>2</kasutussagedus>
<pangakaartide_arv>1231</pangakaartide_arv>

</row>

</report>

</message>

Näide terviklikust xml-dokumendina vormindatud aruandesõnumist (alamaruannetega variant)

<?xml version="1.0" encoding="UTF-8"?>
<message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="x_aruanne1020.xsd">

<message_header>

<from>549300PHQZ4HL15HH975</from>
<date>2018-10-10T11:12:13</date>
<sender>Jaan Kask</sender>
<send_mail>jaan.kask [at] maapank.ee</send_mail>
<send_phone>6666666</send_phone>
<require_receipt>yes</require_receipt>

</message_header>

<report>

<report_header>

<typeid>1020</typeid>
<timeid>2018-09-30</timeid>
<compiler>Jelizaveta Ivanova</compiler>
<comp_mail>liza [at] maapank.ee</comp_mail>
<comp_phone>7777777</comp_phone>

</report_header>

<E_11>

<row>

<riik>GB</riik>
<seis_eel_lopp>273043</seis_eel_lopp>
<seis_lopp>273043</seis_lopp>

</row>

<row>

<riik>NZ</riik>
<seis_eel_lopp>1618</seis_eel_lopp>
<seis_lopp>1618</seis_lopp>

 </row>

</E_11>

<E_27>

<row>

<riik>FR</riik>
<seis_eel_lopp>1381</seis_eel_lopp>
<seis_lopp>125994</seis_lopp>

</row>

</E_27>

</report>

</message>

NB! Mõned olulised märkused aruandesõnumite kohta

1. Sõnumites viidatud e-maili aadressid peavad olema reaalselt toimivad!

2. Elementide väärtustes ei tohi esineda nn. keelatud sümboleid  "<>&'. 
Näiteks selline rida on vigane:
<reitinguagentuur>S & P</reitinguagentuur>

Vastavaid sümboleid saab esitada, asendades neid alljärgnevalt:
" kui &quot;
< kui &lt;
> kui &gt;
& kui &amp;
' kui &apos;

3. XML-dokumendi esimene rida, mis muuhulgas määrab sümbolite kodeerimise, peab olema järgnevale sisule vastav ja kujul (jutumärkide asemel võib kasutada ka ülakomasid):

<?xml version="1.0" encoding="ISO-8859-1"?>  või
<?xml version="1.0" encoding="UTF-8"?>  või
<?xml version="1.0" ?>

4. Element 'message' tuleb esitada kujul:

<message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="x_aruanneZZZZ.xsd">, kus ZZZZ tähistab aruande koodi.

5. Sõnumi päise ’comment’-elementi tuleks kasutada sihipäraselt. Antud element, kui see on väärtustatud, algatab portaalis automaatselt sama tekstiga suhtluse.

6. Väga soovitav on aruandesõnumid enne nende edastamist kohapeal valideerida!