5.18 getAddressList

Owned by Martin Tomec (Unlicensed)
Last updated: lis 23, 2016
1 min read

Výpis seznamu adres, včetně ruian kódu. Kód slouží zejména pro zadávání adresy umístění čísla (dúležitá pro tísňová volání)

VSTUP:

  • parameters
    • fulltextSearch – textové zadání adresy. Při zadání ulice a čísla popisného je hledaná adresa typicky první nebo druhá vrácená položka. Případně lze zadat přímo ruian kód.
    • detail - forma požadovaného výstupu (text/structure)
  • paginator - stránkování vrácených výsledků
    • page_from - číslo stránky (výchozí je 0 - první stránka)
    • page_size - velikost stránky (výchozí je 10)

VÝSTUP:

  • list
    • array item - jednotlivé kategorie
      • int id - kód adresy
      • string text – adresa
  • int result - kód chyby
  • string resultText - textový popis chyby


CHYBY:

  • 0 – OK
  • <0 – Interní chyba API, nebo jiného systému
  • >0 – Jiná chyba vstupních parametrů. Popis chyby je v resultText.

PŘÍKLAD XML ŽÁDOSTI

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prov="http://www.ipex/ProviderManagement.xsd1" xmlns:urn="urn:api-ipex:providermanagement">
   <soapenv:Header>
      <prov:verifyAccess>
         <accessToken>?</accessToken>
      </prov:verifyAccess>
   </soapenv:Header>
   <soapenv:Body>
      <urn:getAddressList>
         <parameters>
            <fulltextSearch>výletní 10</fulltextSearch>
         </parameters>
         <paginator>
         </paginator>
      </urn:getAddressList>
   </soapenv:Body>
</soapenv:Envelope>

PŘÍKLAD XML ODPOVĚDI
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:api-ipex:providermanagement">
   <SOAP-ENV:Body>
      <ns1:getAddressListResponse>
         <list>
            <item>
               <id>19381816</id>
               <text>Jihomoravský kraj, Brno-město, Brno, Kohoutovice, Výletní, č.p. 257/10</text>
            </item>
            <item>
               <id>21958696</id>
               <text>Hlavní město Praha, Hlavní město Praha, Praha, Písnice, Výletní, č.p. 362/10</text>
            </item>
            <item>
               <id>24869813</id>
               <text>Moravskoslezský kraj, Karviná, Havířov, Šumbark, Výletní, č.p. 126/10</text>
            </item>
            <item>
               <id>25853180</id>
               <text>Moravskoslezský kraj, Ostrava-město, Ostrava, Poruba, Výletní, č.p. 2283/10</text>
            </item>
            <item>
               <id>14080028</id>
               <text>Moravskoslezský kraj, Bruntál, Krnov, Pod Cvilínem, Výletní, č.p. 676/10</text>
            </item>
            <item>
               <id>117765</id>
               <text>Ústecký kraj, Děčín, Rumburk, Rumburk 3-Dolní Křečany, Výletní, č.p. 359/10</text>
            </item>
            <item>
               <id>12553972</id>
               <text>Moravskoslezský kraj, Ostrava-město, Vratimov, Výletní, č.p. 815/10</text>
            </item>
            <item>
               <id>14617137</id>
               <text>Středočeský kraj, Praha-východ, Brandýs nad Labem-Stará Boleslav, Brandýs nad Labem, Výletní, č.p. 819/10</text>
            </item>
            <item>
               <id>27181812</id>
               <text>Zlínský kraj, Vsetín, Valašské Meziříčí, Výletní, č.ev. 10</text>
            </item>
            <item>
               <id>11905433</id>
               <text>Karlovarský kraj, Karlovy Vary, Dalovice, Všeborovice, Výletní, č.p. 68</text>
            </item>
         </list>
         <result>0</result>
         <resultText/>
      </ns1:getAddressListResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>