E-arvete vastuvõtjate päring

Päringu nimi: arireg.earveRegistriParing_v1
Selgitus: info e-arvete vastuvõtjate kohta
Lisainfo: kasutusel alates 01.05.2017.
XSD: http://www2.rik.ee/schemas/xtee6/arireg/live/xroad6_earve.xsd

Sisendparameetrid ja otsingutingimused:

Nimetus

Tähendus

Märkused

tagasta_nimed

Kas vastuses tagastada ka ettevõtjate nimed (TRUE/FALSE)

Vaikimisi väärtus “FALSE”.

tulemuste_lk

Loetelu lehekülje number, vaikimisi 1

registrikoodid

Loetelu registrikoodidest, kelle kohta infot soovitakse

(kohustuslik) Maksimaalne vahemik, mis on lubatud vahemikuna kasutada: 1 nädal.

Väljundandmed:

  • lehekylgi – vastuse kogu loetelu lehekülgede arv
  • kliendid – loetelu leitud klientidest
  • klient – üks kliendirida
  • registrikood – kliendi registrikood
  • nimi – kliendi nimi. Tagastatakse, kui päringus oli väärtustatud tagasta_nimed. Puudub, kui päringu sisendiks registrikoodid ja vastaval registrikoodil aktiivne seos puudub/registrikood on vigane.
  • teenusepakkuja – teenusepakkuja tunnus. Ei ole kohustuslik. Puudub, kui päringu sisendiks registrikoodid ja vastaval registrikoodil aktiivne seos puudub/registrikood on vigane.
  • staatus – töötluse tulemus. Võimalikud väärtused: OK – kliendil on kehtiv seos, MR – registrikoodi ei leitud, vigane registrikood, päritud registrikoodil puudub aktiivne seos.

Näitepäring:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xro="http://x-road.eu/xsd/xroad.xsd" xmlns:iden="http://x-road.eu/xsd/identifiers" xmlns:prod="http://arireg.x-road.eu/producer/">
 <soapenv:Body>
 <prod:earveRegistriParing_v1>
 <prod:keha>
 <prod:tagasta_nimed>TRUE</prod:tagasta_nimed>
 <prod:tulemuste_lk>1</prod:tulemuste_lk>
 <prod:registrikoodid>
 <prod:registrikood>70000310</prod:registrikood>
 </prod:registrikoodid>
 </prod:keha>
 </prod:earveRegistriParing_v1>
 </soapenv:Body>
</soapenv:Envelope>

Näitevastus:

<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ZSI="http://www.zolera.com/schemas/ZSI/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <SOAP-ENV:Header/>
 <SOAP-ENV:Body xmlns:ns1="http://arireg.x-road.eu/producer/">
 <ns1:earveRegistriParing_v1Response>
 <ns1:paring>
 <ns1:tagasta_nimed>true</ns1:tagasta_nimed>
 <ns1:tulemuste_lk>1</ns1:tulemuste_lk>
 <ns1:registrikoodid>
 <ns1:registrikood>70000310</ns1:registrikood>
 </ns1:registrikoodid>
 </ns1:paring>
 <ns1:keha>
 <ns1:lehekylgi>1</ns1:lehekylgi>
 <ns1:kliendid>
 <ns1:klient>
 <ns1:registrikood>70000310</ns1:registrikood>
 <ns1:nimi>Registrite ja Infosüsteemide Keskus</ns1:nimi>
 <ns1:teenusepakkuja>Fitek</ns1:teenusepakkuja>
 <ns1:staatus>OK</ns1:staatus>
 </ns1:klient>
 </ns1:kliendid>
 </ns1:keha>
 </ns1:earveRegistriParing_v1Response>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>