Общее описание (General description)

В данном разделе приведено описание API СУЗ, взаимодействие осуществляется по протоколу HTTP, используя формат JSON.

This section describes the OMS API, the interaction is carried out using the HTTP protocol, using the JSON format.

Ниже представлена последовательность вызова методов СУЗ при создании нового бизнес заказа на эмиссию КМ (Below is the sequence of call of OMS methods when creating a new business order for issuing a IC):

  1. Проверить доступность СУЗ (см. раздел 2.2.12) (Ping OMS, see section 2.2.12);
  2. Создать бизнес-заказ на эмиссию кодов маркировки (см. раздел 2.2.1) (Create order for emission IC, see section 2.2.1);
  3. Получить статус массива КМ из бизнес-заказа (см. раздел 2.2.7) (Get IC buffer status, see section 2.2.7);
  4. Получить КМ из бизнес-заказа (см. раздел 2.2.6) (Get ICs from the order, see section 2.2.6);
  5. Отправить отчёт об использовании КМ (см. раздел 2.2.4) (Send IC utilisation report to OMS, see section 2.2.4);
  6. Отправить отчёт об агрегации КМ (см. раздел 2.2.3) (Send IC aggregation report to OMS, see section 2.2.3);
  7. Отправить отчёт о выбытии/отбраковке КМ (см. раздел 2.2.2) (Send report of dropout IC to OMS, see section 2.2.2);

Последовательности вызова методов СУЗ

API СУЗ также предоставляет вспомогательные методы (The OMS API also provides helper methods):

  • Получить статус обработки отчёта (см. раздел 2.2.10) (Get status processing report, see section 2.2.10);
  • Отправить лог файлы АСУТП (см. раздел 2.2.11) (Send Automated process control system logs files, see section 2.2.11);
  • Получить статус бизнес-заказов (см. раздел 2.2.8) (Get status orders, see section 2.2.8);
  • Получить маркер безопасности по имени пользователя и паролю (см. раздел 2.2.13) (Get a security token by username and password, see section 2.2.13);
  • Закрыть подзаказ по заданному GTIN (см. раздел 2.2.5) (Close IC array for the specified product GTIN, see section 2.2.5);
  • Получить версию СУЗ и API (см. раздел 2.2.14) (Get OMS and API versions, see section 2.2.14);
  • Получить список идентификаторов пакетов кодов маркировки (см. раздел 2.2.15) (Get identifiers of blocks of ICs, see section 2.2.15);
  • Получить повторно коды маркировки из заказа кодов маркировки (см. раздел 2.2.16) (Get ICs from the order repeatedly, see section 2.2.16);
  • Отправить отчет об использовании и об автоматическом вводе в оборот (см. раздел 2.2.17) (Send a report on the use and automatic commissioning, see section 2.2.17);
  • Запрос номера документа отчета о вводе в оборот (см. раздел 2.2.18) (Request for the document number of the report on the use and automatic commissioning, see section 2.2.18);
  • Получить информацию об агрегации (см. раздел 2.2.9) (Get aggregation, see section 2.2.9).

Примечание: при наличии неиспользованных кодов маркировки при закрытии заказа будет сформирован и отправлен отчёт об аннулировании кодов маркировки.

Note: if there are unused marking codes when closing an order, a report on annulment of marking codes will be generated and sent.