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

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

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

Обновлено 25.06.2018
75 кб

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

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

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

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

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

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

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

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

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

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

Request
ПараметрR*ТипОписание
appkeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию
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
ПараметрТипОписание
metadataobjectИнформация о номере и количестве страниц ответа
freight_typesarray of Response.Fright_typesСписок элементов справочника "Характер груза"

Response.Metadata
ПараметрТипОписание
current_pageintegerНомер текущей страницы ответа
next_pageintegerНомер следующей страницы ответа (если она есть)
prev_pageintegerНомер прдыдущей страницы ответа (если она есть)
total_pagesintegerВсего страниц в ответе

Response.Freight_types
ПараметрТипОписание
sqlUIDstringУникальный код характера груза
valuestringНаименование характера груза
orderintegerПриоритет отображения
can_transportstringВозможность перевозки
commentstringКомментарий