Изменения

Перейти к: навигация, поиск

API Documentation

397 байт добавлено, 12:37, 28 июля 2021
м
City names list
The '''''content''''' tag contains base64 encoded binary data (PDF file).
== City names list Names List ==
'''The example of the city names list query:City List Request Example'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
</source>
All elements inside The <code>townlist </code> container can either be absent empty or combineelements. The search is not case-sensitiveinsensitive. *'''auth''' — authorisation, optional. Use it if the courier service set and enabled some location restrictions. *'''codesearch''' is a search by codes. In case when When it is used, the <code>conditions </code> and <code>limit </code> containers will be are ignored. :* '''zipcode''' is a search by zip postal codes. Please, note Note that one zip postal code can be applicable to several more than one localities. In this case the system will return MeaSoft returns several records.:* '''kladrcode''' is a search by 13-digit codes code of All-Russian Classifier of Addresses.:* '''fiascode''' is a search by codes the code of Federal Information Address System (Address address system used in Russia) (AOIDAOGUID).:* '''code''' is a search by codes of the systemcode.
*'''conditions''' specifies search criteria. All enclose nested elements simultaneously impose “AND” the AND condition. :* '''city''' is a search by for all the localities of a region. :* '''namecontains''' is a search of for the localities which with names contain a specified including the search text. :* '''namestarts''' is a search of for the localities which with names start from a specified starting with the search text.:* '''name''' is a search of for the localities which with names match a specified matching the search text.:* '''fullname''' is a search of for the localities which with names and type match a specified matching the search text. :* '''country''' is a search of in the country with a the specified zip codeonly.
*'''limit''' limits result output. :* '''limitfrom''' specifies — defines the search result record number of a search result starting to start output with which a response should be given. It equals The default value is '''0 by default'''. :* '''limitcount''' specifies — defines the number quantity of search result records which should be returnedto show. It equals The default value is '''10000 by default'''.:* '''countall''' - — if '''YES indicates ''', the necessity of counting the amount total quantity of found matches foundis counted. It may might slow down the process of query request execution. In case it is If disabled, <code>totalcount </code> and <code>totalpages values won`t be indicated </code> are missing in the response.
'''The example of a response:Response Example'''
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<city>
<code>23</code>
<name>Krasnodar TerritoryKrai</name>
</city>
<name>Sochi city</name>
<shortnamefiascode>79da737a-603b-4c19-9b54-9114c96fb912</fiascode> <kladrcode>Sochi2300000700000</kladrcode> <shortname/> (not yet supported) <typename>city</typename> (not yet supported) <coords lat="43.5855" lon="39.7231" />
</town>
<town>
<city>
<code>32</code>
<name>Bryanskaya oblastBryansk District</name>
</city>
<name>Sochilov farmsteadkhutor</name> <shortnamefiascode>c9c96c67-2cc9-4f10-afde-fd32417ea216</fiascode> <kladrcode>Sochilov3201900011100</kladrcode> <shortname/> <typename/>farmstead <coords lat="52.6407" lon="33.1724" /typename>
</town>
<town>
<city>
<code>60</code>
<name>Pskov oblastDistrict</name>
</city>
<name>Sochikhino village</name>
<shortnamefiascode>10df7588-19c1-49d1-a387-9de1cf3eb26f</fiascode> <kladrcode>Sochikhino6001900015400</kladrcode> <shortname/> <typename/>village <coords lat="56.6003" lon="29.3542" /typename>
</town>
</townlist>
</source>
In a the response , the cities and towns are sorted arranged by their popularity, importance (district centers, etc.) and only after that - alphabeticallythen by alphabet.
== Region names list ==

Навигация