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

API
Главная / API - Манипуляционные знаки

Манипуляционные знаки

Обновлено 20.01.2023
Скачать в PDF
135 кб
Содержание:

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

Сервис позволяет получить информацию о существующих этикетках с манипуляционными знаками, а также сформировать файлы с этикетками для печати. Сервис доступен только авторизованным пользователям.

Справочник этикеток с манипуляционными знаками

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

Структура запроса

Адрес метода: https://api.dellin.ru/v1/references/marking/handling_marks.json

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

Адрес метода: https://api.dellin.ru/v1/references/marking/handling_marks.xml

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

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

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

Ответ метода

Структура ответа

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "name":"fragile_cargo",
         "format":"a4",
         "type":"image/jpeg",
         "base64":"hgrkhgkjtrhukthi..."
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <name>fragile_cargo</name>
      <format>a4</format>
      <type>image/jpeg</type>
      <base64>hgrkhgkjtrhukthi...</base64>
   </data>
</response>

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

Response
Response
ПараметрТипОписание
metadataobjectСистемная информация
metadata.statusinteger

Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (Success)

metadata.generated_atstring

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

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

dataarray of DataИнформация о манипуляционных знаках
data.namestring

Идентификатор манипуляционного знака.

Возможные значения:

  • fragile_cargo - "хрупкий груз";
  • this_way_up - "верх";
  • stack_forbidden - "штабелирование запрещено";
  • beacon - "радиоизлучение"
data.formatstring

Размер этикетки.

Возможные значения: 80x50, a4

data.typestring

MIME-тиф файла.

Возможные значения: image/jpeg, application/pdf, image/png

data.base64stringBase64-код файла, содержащего этикетку

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

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

Получение этикеток с манипуляционными знаками

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

Структура запроса

Адрес метода: https://api.dellin.ru/v1/references/marking/handling_marks/get.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "type":"jpg",
   "oneFile":false,
   "per":10,
   "page":1,
   "handlingMarks":[
      {
         "name":"fragile_cargo",
         "format":"a4",
         "count":2
      }
   ]
}

Адрес метода: https://api.dellin.ru/v1/references/marking/handling_marks/get.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <type>jpg</type>
   <oneFile>false</oneFile>
   <per>10</per>
   <page>1</page>
   <handlingMarks>
      <name>fragile_cargo</name>
      <format>a4</format>
      <count>2</count>
   </handlingMarks>
</request>

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

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

sessionID

ДаstringID сессии. Для получения сессии необходимо воспользоваться методом "Авторизация пользователя"
typeНетstring

Тип файла с этикетками.

Доступные значения: jpg, pdf, png.

Значение по умолчанию - pdf

oneFileНетboolean

Флаг, позволяющий выбрать, сформировать один многостраничный документ (по одной этикетке на страницу) или сформировать отдельные файлы.

Доступные значения:

  • true - cформировать один многостраничный документ. Передача значения возможна, только если значение параметра "type" - "pdf";
  • false - сформировать отдельные файлы. 

Значение по умолчанию - false

perНетinteger

Количество ссылок на файлы с этикетками на странице (1). Максимальное значение - 50.

Значение по умолчанию - 30

pageНетinteger

Номер страницы со ссылками на файлы с этикетками (1). 

Значение по умолчанию - 1

handlingMarksДаarray of HandlingMarksПараметры массива этикеток
handlingMarks.nameДаstring

Идентификатор манипуляционного знака.

Доступные значения:

  • fragile_cargo - "хрупкий груз";
  • this_way_up - "верх";
  • stack_forbidden - "штабелирование запрещено";
  • beacon - "радиоизлучение"
handlingMarks.formatНетstring

Размер этикетки.

Доступные значения: 80x50, a4.

Значение по умолчанию - 80х50

handlingMarks.countДаintegerКоличество этикеток

Примечания:

  1. При формировании отдельных файлов (то есть если значение параметра  "type" - "jpg" или "png") список ссылок для скачивания файлов размещается на нескольких страницах по 30 ссылок на страницу. При необходимости можно изменить количество ссылок на странице (см. описание параметра "per"), а также передать номер конкретной страницы, данные которой необходимо получить в ответе (см. описание параметра "page")

Ответ метода

Структура ответа

{
   "metadata":{
      "status":200,
      "current_page":2,
      "next_page":3,
      "prev_page":1,
      "total_pages":6,
      "generated_at":"2022-03-16 16:29:47"
   },
   "data":[
      {
         "name":"fragile_cargo",
         "format":"a4",
         "type":"image/jpeg",
         "base64":"JVBERi0xLjMKJf////8KMSAw..."
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <current_page>2</current_page>
      <next_page>3</next_page>
      <prev_page>1</prev_page>
      <total_pages>6</total_pages>
      <generated_at>2022-03-16 16:29:47</generated_at>
   </metadata>
   <data>
      <name>fragile_cargo</number>
      <format>a4</format>
      <type>image/jpeg</type>
      <base64>JVBERi0xLjMKJf////8KMSAw...</base64>
   </data>
</response>

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

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

Номер текущей страницы со ссылками.

Значение номера будет отличаться от 1, только если было выбрано формирование отдельных файлов и были запрошены данные по конкретной странице (1)

metadata.next_pageinteger

Номер следующей страницы.

При формировании отдельных файлов значение будет отличаться от 2, только если были запрошены данные по конкретной странице (1). При формировании многостраничного документа (2) выводится значение "null"

metadata.prev_pageinteger

Номер предыдущей страницы.

Значение будет отличаться от "null", только если были запрошены данные по конкретной странице (1)

metadata.total_pagesinteger

Общее количество страниц со ссылками.

При формировании многостраничного документа (2) значение всегда равно 1

metadata.generated_atstring

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

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

dataarray of DataДанные по этикеткам
data.namestring

Идентификатор манипуляционного знака.

Доступные значения:

  • fragile_cargo - "хрупкий груз";
  • this_way_up - "верх";
  • stack_forbidden - "штабелирование запрещено";
  • beacon - "радиоизлучение";
  • result - выводится при формировании многостраничного документа (2)
data.formatstring

Размер этикеток.

Возможные значение: 80x50, a4.

При формировании многостраничного документа (2) выводится пустое значение

data.typestring

MIME-тиф файла.

Возможные значения: image/jpeg, application/pdf, image/png

data.base64stringBase64-код файла, содержащего этикетку

Примечания:

  1. Значение параметра запроса "type" - "jpg" или "png" и в запросе был передан параметр "page" со значением, отличным от 1.
  2. Значение параметра запроса "type" - "pdf", а параметра "oneFile" - "true"

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

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