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

API
Главная / API - Характер груза по введенной строке

Характер груза по введенной строке

Обновлено 09.07.2020
101 кб

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

Сервис предназначен для поиска значений справочников "Характер груза" по введенной строке. Предусмотрено два метода: одни - для сборных грузов, другой - для перевозок еврофурой.

Характер груза: поиск по строке (перевозка сборных грузов)

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

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

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

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "page":"2",
   "name":"коробка"
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <page>2</page>
   <name>коробка</name>
</request>

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

Request
Request
ПараметрОбязательныйТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
pageНетintegerНомер запрашиваемой страницы ответа
nameДаstringПоисковый запрос

Ответ метода

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

{  
   "metadata":{  
      "current_page":1,
      "next_page":null,
      "prev_page":null,
      "total_pages":1
   },
   "freight_types":[  
      {  
         "sqlUID":"0x960d35a065ddb1e841a8b09bf5eb42cc",
         "value":"Коробка передач",
         "order":1,
         "can_transport":"1",
         "comment":"Обязательна жесткая упаковка.Во Владивостоке и Хабаровске доступна специальная упаковка для автозапчастей-жесткий короб."
      },
      {  
         "sqlUID":"0x98086eae8b603ea911e5e1f22bb1e191",
         "value":"Кафельная плитка в коробках",
         "order":2,
         "can_transport":"1",
         "comment":""
      }
   ]
}
<response>
   <metadata>
      <current_page>1</current_page>
      <next_page />
      <prev_page />
      <total_pages>1</total_pages>
   </metadata>
   <freight_types>
      <sqlUID>0x960d35a065ddb1e841a8b09bf5eb42cc</sqlUID>
      <value>Коробка передач</value>
      <order>1</order>
      <can_transport>1</can_transport>
      <comment>Обязательна жесткая упаковка.Во Владивостоке и Хабаровске доступна специальная упаковка для автозапчастей-жесткий короб.</comment>
   </freight_types>
   <freight_types>
      <sqlUID>0x98086eae8b603ea911e5e1f22bb1e191</sqlUID>
      <value>Кафельная плитка в коробках</value>
      <order>2</order>
      <can_transport>1</can_transport>
      <comment></comment>
   </freight_types>
</response>

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

Response
Response
ПараметрТипОписание
metadataobjectИнформация о номере и количестве страниц ответа
metadata.current_pageintegerНомер текущей страницы 
metadata.next_pageintegerНомер следующей страницы (если она есть)
metadata.prev_pageintegerНомер предыдущей страницы (если она есть)
metadata.total_pagesintegerВсего страниц
freight_typesarray of Response.Fright_typesСписок элементов справочника "Характер груза"
freight_types.sqlUIDstringУникальный код характера груза
freight_types.valuestringНаименование характера груза
freight_types.orderintegerПриоритет отображения
freight_types.can_transportstringВозможность перевозки
freight_types.commentstringКомментарий 

Характер груза: поиск по строке (перевозка еврофурой)

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

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

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

{
   "appKey":"00000000-0000-0000-0000-000000000000",
   "search":"пи"
}

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

<request>
   <appKey>00000000-0000-0000-0000-000000000000</appKey>
   <search>пи</search>
</request>

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

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

Наименование груза или его часть. Минимальная длина строки - 2 символа. Поиск осуществляется с начала строки

Ответ метода

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

{
   "metadata":{
      "status":200,
      "generated_at":"2020-06-17 15:10:42"
   },
   "data":[
      {
         "uid":"3b4feeb0-cedf-11e0-99f0-001a64963cbd",
         "name":"Пиломатериалы"
      },
      {
         "uid":"eddb67f5-bdb3-11e0-ad24-001a64963cbd",
         "name":"Пищевые добавки"
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2020-06-17 15:10:42</generated_at>
   </metadata>
   <data>
      <uid>3b4feeb0-cedf-11e0-99f0-001a64963cbd</uid>
      <name>Пиломатериалы</name>
   </data>
   <data>
      <uid>eddb67f5-bdb3-11e0-ad24-001a64963cbd</uid>
      <name>Пищевые добавки</name>
   </data>
</response>

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

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusintegerЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.generated_atstring

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

dataarray of DataСписок найденных элементов справочника "Характер груза"
data.uidstringUID груза
data.namestringНаименование груза

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

В методе используются общие ошибки API, описание формата и перечень ошибок см. в документе "Ошибки методов API".