Поиск по сайту

API
Главная / API - Прочие справочники

Прочие справочники

Обновлено 24.08.2018
133 кб

Общие сведения

Сервис позволяет получить данные прочих справочников, не упомянутых в других разделах.

Справочник ОПФ

Данный справочник содержит перечень видов организационно-правовых форм (ОПФ).

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/opf_list.json

{
   "appkey": "00000000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/public/opf_list.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

Пример ответа

{
   "hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4",
   "url": "https://api.dellin.ru/catalog/opf_list.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434"
}
<response>
   <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash>
   <url>https://api.dellin.ru/catalog/opf_list.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url>
</response>

Описание параметров

Response
ПараметрТипОписание
hashstringХеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет
urlstring

Ссылка на файл с данными справочника в формате csv в кодировке utf-8 (срок действия ссылки – 10 минут.). Разделителем строк в файле является символ "\n", разделителем столбцов – символ ",", а разделителем текста – символ " " ".

Файл содержит следующие колонки:

  • UID — уникальный идентификатор;
  • name — краткое наименование ОПФ (ООО, ОАО и т.п.);
  • juridical — признак юридического лица ("1" - да, "0" - нет);
  • fullName — полное наименование ОПФ;
  • innLength — необходимое количество цифр в ИНН;
  • countryUID — уникальный идентификатор страны.

Справочник статусов заказа груза

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/statuses.json

{
   "appkey": "00000000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/public/statuses.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

Пример ответа

{  
   "hash":"db090d4a0111cc5a7a2282716218840972a65251651a4fb2dc8f6ea34e5d2fa0",
   "url":"https://api.dellin.ru/catalog/statuses.json?sk=0k92VHh-Am_cUX6qsvdEjQ&e=1496046122"
}
<response>
   <hash>db090d4a0111cc5a7a2282716218840972a65251651a4fb2dc8f6ea34e5d2fa0</hash>
   <url>https://api.dellin.ru/catalog/statuses.json?sk=0k92VHh-Am_cUX6qsvdEjQ&e=1496046122</url>
</response>

Описание параметров

Response
ПараметрТипОписание
hashstringХеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет
urlstring

Ссылка на файл с данными справочника в формате json

Справочник параметров для статистического отчета

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/report_params.json

{
   "appkey": "00000000-0000-0000-000000000000"
}

Адрес метода: https://api.dellin.ru/v1/public/report_params.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

Ответ метода

Пример ответа

{  
   "hash":"0dd17e7c6e8e69455360f392577356ace95385b0a94f5a062ef07aeee46be4a0",
   "url":"http://api.dellin.stage/catalog/report_params.csv?sk=5iq56DseyHlaqmYO7atEpw&e=1506409060"
}
<response>
   <hash>0dd17e7c6e8e69455360f392577356ace95385b0a94f5a062ef07aeee46be4a0</hash>
   <url>http://api.dellin.stage/catalog/report_params.csv?sk=5iq56DseyHlaqmYO7atEpw&e=1506409060</url>
</response>

Описание параметров

Response
ПараметрТипОписание
hashstringХеш-код файла (MD5). Путём сравнения хеш-кодов двух файлов, полученных в разное время, можно понять, изменились данные в справочнике или нет
urlstring

Ссылка на файл с данными справочника в формате csv в кодировке utf-8 (срок действия ссылки – 10 минут.). Разделителем строк в файле является символ "\n", разделителем столбцов – символ ",", а разделителем текста – символ " " ".

Файл содержит следующие колонки:

  • name — наименование параметра (ключ; на латинице);
  • caption — название параметра (на кириллице)

Прайс-лист

Запрос метода

Пример запроса 

Адрес метода: https://api.dellin.ru/v1/public/pricelist.json

{  
   "appkey":"00000000-0000-0000-000000000000",
   "city_from_uid":"0x834f00112fdd658311da4c6326ef0e13",
   "city_to_uid":"0x834f00112fdd658311da4c6326ef0e13"
}

Адрес метода: https://api.dellin.ru/v1/public/pricelist.xml

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <city_from_uid>0x834f00112fdd658311da4c6326ef0e13</city_from_uid>
   <city_to_uid>0x834f00112fdd658311da4c6326ef0e13</city_to_uid>
</request>

Описание параметров

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
city_from_uidДа*string

UID города отправления.

Значение указывается на основании "Справочника городов из прайс-листа"

*Только если не передан параметр "city_to_uid"

city_to_uidДа*string

UID города назначения.

Значение указывается на основании "Справочника городов из прайс-листа"

*Только если не передан параметр "city_from_uid"

Ответ метода

Пример ответа

{  
   "data":{  
      "header":"Межтерминальная доставка",
      "table":{  
         "caption":"Отправка из г. Москва (7 (495) 775-55-30)",
         "header":[  
            {  
               "name":"city_to",
               "text":"направление"
            },
            {  
               "name":"min_cost",
               "text":"мин. ст-ть"
            },
            {  
               "name":"weight_cost",
               "text":"стоимость за 1 кг. (руб)",
               "value":[  
                  "5000 - 10000",
                  "3000 - 5000",
                  "2000 - 3000",
                  "1500 - 2000",
                  "800 - 1500",
                  "300 - 800",
                  "150 - 300",
                  "0 - 150"
               ]
            },
            {  
               "name":"volume_cost",
               "text":"стоимость за 1 куб.м. (руб)",
               "value":[  
                  "25 - 45",
                  "15 - 25",
                  "10 - 15",
                  "7 - 10",
                  "4 - 7",
                  "1.3 - 4",
                  "0.6 - 1.3",
                  "0 - 0.6"
               ]
            }
         ],
         "body":[  
            {  
               "city_to":"Абакан",
               "min_cost":570,
               "weight_cost":[  
                  17.9,
                  18.7,
                  19.4,
                  20,
                  20.4,
                  22.3,
                  23,
                  23.7
               ],
               "volume_cost":[  
                  4650,
                  4860,
                  5040,
                  5200,
                  5300,
                  5800,
                  5980,
                  6160
               ]
            },
            {  
               "city_to":"Адлер",
               "min_cost":450,
               "weight_cost":[  
                  11.5,
                  12.2,
                  12.6,
                  12.8,
                  13.2,
                  14.4,
                  14.8,
                  15.3
               ],
               "volume_cost":[  
                  2990,
                  3170,
                  3280,
                  3330,
                  3430,
                  3740,
                  3850,
                  3980
               ]
            },
            {  
               "city_to":"Альметьевск",
               "min_cost":500,
               "weight_cost":[  
                  8.7,
                  9.1,
                  9.4,
                  9.7,
                  10,
                  10.4,
                  10.8,
                  11.1
               ],
               "volume_cost":[  
                  2350,
                  2460,
                  2540,
                  2620,
                  2700,
                  2810,
                  2920,
                  3000
               ]
            }
         ]
      }
   }
}
<response>
   <header>Межтерминальная доставка</header>
   <table>
      <caption>Отправка из г. Москва (7 (495) 775-55-30)</caption>
      <header>
         <name>city_to</name>
         <text>направление</text>
      </header>
      <header>
         <name>min_cost</name>
         <text>мин. ст-ть</text>
      </header>
      <header>
         <name>weight_cost</name>
         <text>стоимость за 1 кг. (руб)</text>
         <value>5000 - 10000</value>
         <value>3000 - 5000</value>
         <value>2000 - 3000</value>
         <value>1500 - 2000</value>
         <value>800 - 1500</value>
         <value>300 - 800</value>
         <value>150 - 300</value>
         <value>0 - 150</value>
      </header>
      <header>
         <name>volume_cost</name>
         <text>стоимость за 1 куб.м. (руб)</text>
         <value>25 - 45</value>
         <value>15 - 25</value>
         <value>10 - 15</value>
         <value>7 - 10</value>
         <value>4 - 7</value>
         <value>1.3 - 4</value>
         <value>0.6 - 1.3</value>
         <value>0 - 0.6</value>
      </header>
      <body>
         <city_to>Абакан</city_to>
         <min_cost>570</min_cost>
         <weight_cost>17.9</weight_cost>
         <weight_cost>18.7</weight_cost>
         <weight_cost>19.4</weight_cost>
         <weight_cost>20</weight_cost>
         <weight_cost>20.4</weight_cost>
         <weight_cost>22.3</weight_cost>
         <weight_cost>23</weight_cost>
         <weight_cost>23.7</weight_cost>
         <volume_cost>4650</volume_cost>
         <volume_cost>4860</volume_cost>
         <volume_cost>5040</volume_cost>
         <volume_cost>5200</volume_cost>
         <volume_cost>5300</volume_cost>
         <volume_cost>5800</volume_cost>
         <volume_cost>5980</volume_cost>
         <volume_cost>6160</volume_cost>
      </body>
      <body>
         <city_to>Адлер</city_to>
         <min_cost>450</min_cost>
         <weight_cost>11.5</weight_cost>
         <weight_cost>12.2</weight_cost>
         <weight_cost>12.6</weight_cost>
         <weight_cost>12.8</weight_cost>
         <weight_cost>13.2</weight_cost>
         <weight_cost>14.4</weight_cost>
         <weight_cost>14.8</weight_cost>
         <weight_cost>15.3</weight_cost>
         <volume_cost>2990</volume_cost>
         <volume_cost>3170</volume_cost>
         <volume_cost>3280</volume_cost>
         <volume_cost>3330</volume_cost>
         <volume_cost>3430</volume_cost>
         <volume_cost>3740</volume_cost>
         <volume_cost>3850</volume_cost>
         <volume_cost>3980</volume_cost>
      </body>
      <body>
         <city_to>Альметьевск</city_to>
         <min_cost>500</min_cost>
         <weight_cost>8.7</weight_cost>
         <weight_cost>9.1</weight_cost>
         <weight_cost>9.4</weight_cost>
         <weight_cost>9.7</weight_cost>
         <weight_cost>10</weight_cost>
         <weight_cost>10.4</weight_cost>
         <weight_cost>10.8</weight_cost>
         <weight_cost>11.1</weight_cost>
         <volume_cost>2350</volume_cost>
         <volume_cost>2460</volume_cost>
         <volume_cost>2540</volume_cost>
         <volume_cost>2620</volume_cost>
         <volume_cost>2700</volume_cost>
         <volume_cost>2810</volume_cost>
         <volume_cost>2920</volume_cost>
         <volume_cost>3000</volume_cost>
      </body>
   </table>
</response>

Описание параметров

Response
ПараметрТипОписание

data

Response.DataДанные о тарифах

Response.Data
ПараметрТипОписание

header

string

Название таблицы
tableResponse.Data.TableТаблица с тарифами

Response.Data.Table
ПараметрТипОписание

caption

string

Информация о направлении перевозки
headerarray of Response.Data.Table.HeaderЗаголовки столбцов таблицы
bodyarray of Response.Data.Table.BodyТело таблицы

Response.Data.Table.Header
ПараметрТипОписание

name

string

Заголовок столбца (наименование параметра из блока "body"; на латинице)
textstringЗаголовок столбца (текстовое представление; на кириллице)
valuearray of stringsДиапазоны значений (заголовки столбцов в рамках данного столбца)

Response.Data.Table.Body
ПараметрТипОписание

city_to

string

Город назначения. Выводится, если в запросе метода был передан параметр "city_from_uid" без параметра "city_to_uid".

Если в запросе передается параметр "city_to_uid" без параметра "city_from_uid", то вместо этого параметра будет выведен параметр "city_from" - город отправления.

Если в запросе передаются оба параметра ("city_from_uid" и "city_to_uid"), то данный параметр будет отсутствовать в ответе

min_costintegerМинимальная стоимость, руб.
weight_costarray of floatСтоимость, руб./кг. Значения соответствующих диапазонов веса из параметра "Response.Data.Table.Header.Value" (имеющего заголовочный параметр "name" со значением "weight_cost")
volume_costarray of integerСтоимость, руб./м3. Значения соответствующих диапазонов объема из параметра "Response.Data.Table.Header.Value" (имеющего заголовочный параметр "name" со значением "volume_cost")

Обработка ошибок

Если в запросе переданы не все обязательные параметры, то будет выведено следующее сообщение об ошибке:

Пример ответа - Не переданы обязательные параметры

{  
   "errors":"Некорректный запрос"
}
<response>
   <errors>Некорректный запрос</errors>
</response>


Если в запросе обязательные параметры переданы с пустыми значениями, то будет выведено следующее сообщение об ошибке:

Пример ответа - Обязательные параметры переданы с пустым значением

{  
   "errors":{  
      "city_from_uid":"Это поле не может быть пустым."
   }
}
<response>
   <errors>
      <city_from_uid>Это поле не может быть пустым.</city_from_uid>
   </errors>
</response>

Если в запросе переданы некорректные значения параметров, то будет выведено следующее сообщение об ошибке:

Пример ответа - Переданы некорректные значения параметров

{
   "errors":{
      "city_from_uid": "Некорректный uid города",
      "city_to_uid": "Некорректный uid города"
   }
}
<response>
   <errors>
      <city_from_uid>Некорректный uid города</city_from_uid>
      <city_to_uid>Некорректный uid города</city_to_uid>
   </errors>
</response>