Географические справочники
Общие сведения
Все методы из данного раздела имеют одинаковую структуру запросов и ответов. Примеры структуры запросов и ответов методов приведены ниже.
Запрос метода
Структура запроса
{
"appkey": "00000000-0000-0000-0000-000000000000"
}<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> </request>
Описание параметров
Request
| Request | |||
|---|---|---|---|
| Параметр | Обязательный | Тип | Описание |
| appkey | Да | string | Ключ приложения. Для получения ключа необходимо пройти регистрацию |
Ответ метода
Структура ответа
{
"hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4",
"url": "https://api.dellin.ru/catalog/[filename].csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434"
}<response> <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash> <url>https://api.dellin.ru/catalog/[filename].csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url> </response>
Описание параметров
Response
| Response | ||
|---|---|---|
| Параметр | Тип | Описание |
| hash | string | Хеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет |
| url | string | Ссылка на файл с данными справочника в формате csv в кодировке utf-8 (срок действия ссылки – 10 минут). Рекомендуемая частота обновления скачанного файла - раз в месяц Вместо "[filename]" значение данного параметра содержит наименование файла, совпадающее с ключевым словом в наименовании соответствующего метода. Разделителем строк в файле является символ "\n", разделителем столбцов – символ ",", а разделителем текста – символ " " ". |
Справочник населенных пунктов
Адрес метода для запроса в формате JSON: https://api.dellin.ru/v1/public/places.json
Адрес метода для запроса в формате XML: https://api.dellin.ru/v1/public/places.xml
Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:
- cityID — уникальный идентификатор города в рамках нашей системы;
- name — полное наименование населённого пункта;
- code — код КЛАДР населенного пункта;
- searchString — наименование населённого пункта, сформированное специальным образом для поиска. Например, для реализации автодополнения;
- regname — наименование региона для населённого пункта;
- regcode — код КЛАДР региона для населённого пункта;
- zonename — наименование района для населённого пункта;
- zoncode — код КЛАДР района для населённого пункта.
Справочник улиц
Адрес метода для запроса в формате JSON: https://api.dellin.ru/v1/public/streets.json
Адрес метода для запроса в формате XML: https://api.dellin.ru/v1/public/streets.xml
Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:
- code — код КЛАДР улицы;
- cityID — уникальный идентификатор города в рамках нашей системы;
- searchString — наименование улицы сформированное специальным образом для поиска, например для реализации автодополнения;
- name — полное наименование улицы.
Справочник населенных пунктов с ограничениями по оплате
Данный справочник содержит перечень городов, в которых недоступна оплата наличными/банковской картой, оплатить услуги в этих городах можно только посредством банковского перевода.
Адрес метода для запроса в формате JSON: https://api.dellin.ru/v1/public/cities_cashless_only.json
Адрес метода для запроса в формате XML: https://api.dellin.ru/v1/public/cities_cashless_only.xml
Файл, расположенный по ссылке из ответа метода, содержит следующие колонки:
- cityID — уникальный идентификатор города в рамках нашей системы;
- cityCode — код КЛАДР города.
