"123456789012345678900"
]
}
]
}
],
"rejectedSntins": [
{
"sntin":"123456789012345678911",
"rejectionType":"REJECTED"
},
{
"sntin":"123456789012345678912",
"rejectionType":"DROPPED_OUT"
}
],
"verifiedSntins": [
"123456789012345678921",
"123456789012345678922",
"123456789012345678923",
"123456789012345678924",
"123456789012345678925"
],
"printedSntins": [
"123456789012345678931",
"123456789012345678932",
"123456789012345678933",
"123456789012345678934",
"123456789012345678935"
]
}
Структура JSON-ответа на запрос по передаче в СУЗ отчета об использовании КМ
Формат ответа
Поле | Описание | Тип | Обязательность |
success | Признак успешного приема отчета | Логический (true/false) | Да |
errors | Описание ошибок при success=false | JSON Array of Strings | Нет |
Пример JSON-ответа
{"success":true}
Получение из СУЗ отчета об использовании КМ
Метод предназначен для выгрузки в учетную систему отчета по сделанным заказам на эмиссию КМ и об утилизации КМ из заказов. Метод принимает токен, и параметры, содержащие дату и время начала выборки данных для отчета, дату и время окончания выборки (далее возможно расширения списка параметров запроса отчета), передача периода обязательна, если не указан производственный заказ, идентификатор производственного заказа – фильтр по производственному заказу. Токен генерируется СУЗ при регистрации клиента СУЗ. Токен передается на сервер в заголовке HTTP-запроса с именем "clientToken". Метод возвращает структуру данных за выбранный период либо, если не указан период, то все заказы на КМ в рамках заданного производственного заказа.
Структура запроса на получение из СУЗ отчета об использовании КМ
Параметры REST-запроса
URL: [:server-port]/api/codeUsage?">http://[:server-port]/api/codeUsage?
from={fromTimestamp}&to={toTimestamp}&productionOrderId={productionOrderId}
Method: GET
Формат параметров запроса
Поле | Описание | Тип | Обязательность |
from | Дата и время начала выборки | Целочисленный | Нет |
to | Дата и время конца выборки | Целочисленный | Нет |
productionOrderId | Идентификатор производственного заказа | Строка | Да |
Пример URL REST-запроса
http://172.104.154.9:9999/api/codeUsage?from=1533643712&to=1533673712&productionOrderId=12345
Структура JSON-ответа на запрос по получению из СУЗ отчета об использовании КМ
Формат ответа
Поле | Описание | Тип | Обязательность |
orderReports | Массив данных об использовании КМ | JSON Array of OrderReport | Да |
Формат объекта - OrderReport
Поле | Описание | Тип | Обязательность |
productionOrderId | Идентификатор производственного заказа | Строка | Да |
uuid | UUID бизнес-заказа | UUID | Да |
codeStatuses | Статусы использования КМ | JSON Array of SntinStatus | Да |
Формат объекта - SntinStatus
Поле | Описание | Тип | Обязательность |
sntin | Серийный номер + номенклатура товара | Строка | Да |
codeStatus | Статус использования КМ | Справочник №1 | Да |
Справочник №1 "Статусы использования КМ" - CodeStatus
Константа | Описание | Тип |
GENERATED | КМ эмитирован | Строка |
UTILISED | КМ нанесен | Строка |
VERIFIED | КМ верифицирован | Строка |
REJECTED | КМ выведен (брак) | Строка |
DROPPED_OUT | КМ выведен (другая причина) | Строка |
PACKED | КМ упакован | Строка |
UNKNOWN | Неизвестен | Строка |
Пример JSON-ответа
{
"orderReports": [
{
"productionOrderId": "12345678901234",
"uuid": "550e8400-e29b-41d4-a716-446655441234",
"codeStatuses": [
{
"sntin": "123456789012345678901234",
"codeStatus": "GENERATED"
},
{
"sntin": "123456789012345678901235",
"codeStatus": "PACKED"
}
]
},
{
"productionOrderId": "12345678901236",
"uuid": "550e8400-e29b-41d4-a716-446655441236",
"codeStatuses": [
{
"sntin": "123456789012345678901236",
"codeStatus": "UTILISED"
},
{
"sntin": "123456789012345678901237",
"codeStatus": "REJECTED"
}
]
}
]
}
Передача документа в ИС МП
Метод предназначен для передачи в ИС МП любых документов. Метод принимает в качестве параметров токен и JSON. Токен генерируется СУЗ при регистрации клиента СУЗ. Токен передается на сервер в заголовке HTTP-запроса с именем "clientToken".
Структура запроса на передачу документа в ИС МП
Параметры REST-запроса
URL: [:server-port]/api/docs">http://[:server-port]/api/docs
Method: POST
Content-Type: application/json
Формат запроса
Поле | Описание | Тип | Обязательность |
participantName | Наименование участника оборота | Строка | Да |
inn | ИНН участника оборота | Строка | Да |
receiverId | Идентификатор подсистемы-получателя | Строка | Да |
documentType | Тип документа | Строка | Да |
document | Документ в формате Base64 | Строка | Да |
Параметр идентификатор подсистемы-получателя необходим, так как может существовать более одной системы маркировки и нужно конкретизировать, кому предназначен документ.
Структура JSON-ответа на запрос по передаче документа в ИС МП
Формат ответа
Поле | Описание | Тип | Обязательность |
uuid | UUID присвоенный документу в СУЗ | UUID | Нет |
status | Статус отправки документа | Справочник №1 | Да |
UUID документу присваивается только в случае успешного приема в очередь на обработку.
Справочник №1 "Статус отправки документа" - DocStatus
Константа | Описание | Тип |
ENQUEUED | Документ принят в очередь на обработку | Строка |
REJECTED | Документ отклонен (ошибка формата) | Строка |
Пример URL REST-запроса
http://172.104.154.9:9999/api/docs
Пример данных POST-запроса в формате JSON
{
"participantName": "",
"inn": "7728551528",
"receiverId": "20180801",
"documentType": "1",
"document": "SW1hZ2VuYXJpdW0gaXMgYSBQb3N0LURldk9wcyBlcmEgc29sdXRpb24h"
}
|
Из за большого объема этот материал размещен на нескольких страницах:
1 2 3 4 5 6 |
