Aruandesõnumi üldkirjeldus
Aruandesõnum, tervikuna ,määratud skeemiga http://www.fi.ee/schemas/x_headers.xsd, koosneb päisest ja aruandeosast, olles üldkujult 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 |
Täisarv |
Sõnumi loomise hetk |
date |
Jah |
YYYY-MM-DDThh:mm:ss |
Edastaja nimi |
sender |
Jah |
Tekst 8..30 |
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 |
Näide:
<message_header>
<from>765</from>
<date>2010-10-10T11:20:23</date>
<sender>Jaan Kask</sender>
<send_mail>jaan.kask@maapank.ee</send_mail>
<send_phone>6666666</send_phone>
<require_receipt>yes</require_receipt>
</message_header>
Aruandeosa
<report>
<report_header>
...
</report_header>
<row>
...
</row>
...
<row>
...
</row>
</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 8..30 |
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>2010-09-30</timeid>
<compiler>Jelizaveta Ivanova</compiler>
<comp_mail>liza@maapank.ee</comp_mail>
<comp_phone>7777777</comp_phone>
</report_header>
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 |
... |
... |
... |
|
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:
<?xml version="1.0" encoding="ISO-8859-1"?>
<message xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="x_aruanne162.xsd">
<message_header>
<from>765</from>
<date>2010-10-10T11:20:23</date>
<sender>Jaan Kask</sender>
<send_mail>jaan.kask@maapank.ee</send_mail>
<send_phone>6666666</send_phone>
<require_receipt>yes</require_receipt></message_header>
<report>
<report_header>
<typeid>162</typeid>
<timeid>2010-09-30</timeid>
<compiler>Jelizaveta Ivanova</compiler>
<comp_mail>liza@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>
<row><pangakaart_liik_1>1</pangakaart_liik_1>
<pangakaart_liik_2>9</pangakaart_liik_2>
<kasutussagedus>2</kasutussagedus>
<pangakaartide_arv>567</pangakaartide_arv></row>
</report>
</message>
NB! Mõned tähtsad 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 "
< kui <
> kui >
& kui &
' kui '
3. XML-dokumendi esimene rida, mis muuhulgas määrab ära sümbolite kodeerimise, peab olema 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.