Главная Книги - Разные Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов (версия 4.65.0)
поиск по сайту правообладателям
|
|
содержание .. 9 10 11 12 ..
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
not_in_circulati
Количество
Number
0
on_count
SGTIN не
введенных в
оборот
sent_to_rzn
Отправлено в
Boolean
0
Параметр
(Устарел)
РЗН
заполняется
только для
резидентов
false - Не
принято;
true - Принят
о;
null - для
нерезидентов
status_from_rzn
Статус от РЗН
String
0
Заполняется
только для
резидентов.
Для
нерезидентов
- null.
Возможные
значения:
Нет ответа;
Принято;
Не принято
expiration_date
Срок годности
String
Date
0
container_id
Идентификато
String
UUID
0
р контейнера
10.9.7. Выгрузка общедоступной информации по SGTIN из архива
Тип задачи: public_sgtins_archive
Необходимые права доступа: REESTR_ALL, REESTR_SGTIN
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.7.1. Параметры фильтрации
500
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtins
Массив SGTIN
Array of Strings
SGTIN
1
Максимальное количество элементов в списке запрашиваемых SGTIN: 100
10.9.7.2. Доступные поля выгрузки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
запрошенных
записей
failed
Количество не
Number
1
найденных
записей и
записей, не
прошедших
проверку
entries
Записи из
Array of
PublicSgtinsAr
0
реестра
Objects
chive
failed_entries
Массив КИЗ,
Array of
FailedPublicSgt
0
по которым
Objects
insArchive
поиск
завершился с
ошибкой
Структура объекта PublicSgtinsArchive:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
gtin
GTIN
String
GTIN
1
status
Статус
String
1
sscc
Идентификаци
String
SSCC
0
онный код
третичной
упаковки
501
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
status_date
Дата
String
DateTime
1
последней
смены статуса
last_tracing_op
Дата
String
DateTime
0
_date
последней
операции
branch_id
Идентификато
String
SysID или
1
р МД
BranchID
текущего
местонахожде
ния ЛП
batch
Номер
String
BatchNumber
0
производствен
ной серии
emission_type
Тип эмиссии
Number
{1,2,3,4}
0
rzn_decision_d
Дата подачи
String
DateTime
0
ate
сведений в
АИС РЗН
expiration_date
Срок годности
String
DateTime
0
vzn_drug
Признак,
Boolean
1
отображающи
й, относится
ли ЛП к
списку 7ВЗН
gnvlp
Признак
Boolean
1
наличия в
ЖНВЛП
prod_name
Торговаямарка
String
0
(бренд)
sell_name
Торговое
String
0
наименование
full_prod_name
Полное
String
0
наименование
товара
pack1_desc
Полное
String
0
наименование
товара
prod_form_nam
Лекарственная
String
0
e
форма
502
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
prod_d_name
Количество
String
0
единиц
измерения
дозировки
лекарственног
о препарата
reg_holder
Держатель
String
0
регистрационн
ого
удостоверения
reg_date
Дата
String
DateTime
0
государственн
ой
регистрации
reg_number
Номер
String
0
регистрационн
ого
удостоверения
drug_code
Внутренний
String
0
уникальный
идентификатор
лекарственног
о препарата в
реестре
ЕСКЛП
halt_doc_date
Дата решения
String
DateTime
0
о
приостановке
halt_doc_num
Номер
String
0
решения о
приостановке
halt_id
Идентификато
String
UUID
0
р решения о
приостановке
withdrawal_typ
Тип вывода из
Number
{1, 2, 3, 4, 5}
0
e
оборота
via_device
Способ
Number
{1, 2, 3, 4}
0
выбытия
Структура объекта FailedPublicSgtinsArchive:
503
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
error_code
Код ошибки*
Number
1
error_desc
Описание
String
1
ошибки
* Значения кодов:
Код
Значение
2
Запрашиваемые данные не найдены.
10.9.8. Выгрузка списка успешно обработанных SGTIN по id исходного XML-
документа
Тип задачи: sgtins_by_doc_id
Необходимые права доступа: MANAGE_EXPORT_TASKS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.8.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Обязательны
Примечания
реквизита в
реквизита
JSON
й
формате
JSON
document_id
Уникальный
String
UUID
1
идентификатор
документа
10.9.8.2. Доступные поля выгрузки
Наименование
Описание
Примечания
sgtin
SGTIN
Выходная информация
По результатам выполнения клиент получает следующую информацию:
504
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
UUID
1
р созданной
задачи
В случае ошибки клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
POST api/v1/export/tasks/sgtins_by_doc_id
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"task_filter":
{
"filters":
{
"document_id":"ff919606-f792-4c72-95f6-461037528632"
},
"fields": ["sgtin"]
}
}
Получение результата:
{
"id": "cc7890a8-39ac-4ba9-ae9a-b20f406a781c"
}
505
11. Аналитические данные по отчётам
В данном разделе описана функциональность создания однократных заданий на выгрузки
больших объемов и скачивания результатов в формате *.csv.
Ограничения
1. Максимальное количество созданных заданий в сутки для организации - 10.
a. Создание заданий на выгрузку доступно по API и в ЛК ФГИС МДЛП, лимит на создание
заданий общий.
b. При достижении указанного лимита создание новых заданий на выгрузку будет
недоступно.
2. К каждому сформированному заданию на выгрузку формируется файл отчёта.
a. Файл отчета будет удален автоматически через 10 дней.
b. Задание на выгрузку будет автоматически удалено через 30 дней.
3. Создание задания, скачивание / удаление файла выгрузки доступно пользователю, у которого
присутствует право на данный тип задания.
a. Список созданных заданий доступен всем пользователям в разрезе организации.
4. Часовые пояса:
a. Учёт лимита на запросы происходит по дате, соответствующей дате в часовом поясе
UTC;
b. Агрегация в отчётах для каждого события происходит с учетом того часового пояса,
который указан в полученном документе от участника.
Последовательность формирования выгрузок больших объемов
1. Создание нового задания на выгрузку (Метод создания нового задания на выгрузку) и
получение идентификатора задания на выгрузку, используемого на последующих шагах
работы с выгрузкой.
2. Проверка статуса готовности задания на выгрузку по идентификатору задания на выгрузку
(Метод получения статуса задания на выгрузку и Метод получения статусов заданий на
выгрузку).
3. Получение результирующего идентификатора для задания на выгрузку в статусе
"COMPLETED"
("Выполнено") (Метод получения результирующих идентификаторов
выгрузок данных).
4. Получение сформированного файла выгрузки данных по полученному результирующему
идентификатору выгрузки (Метод получения выгрузки). Если выгрузка перемещена в архив,
необходимо сформировать выгрузку повторно.
11.1. Метод создания нового задания на выгрузку
Метод предназначен для создания нового задания на выгрузку и получение идентификатора
задания на выгрузку, который необходим для работы с другими методами сервиса выгрузок.
Endpoint: POST <endpoint>/<version>/data/export/tasks
Необходимые
права
доступа:
GENERAL_PRICING_REPORT
/
506
GENERAL_REPORT_ON_MOVEMENT
/
GENERAL_REPORT_ON_REMAINING_ITEMS
/
GENERAL_REPORT_ON_DISPOSAL / VIRTUAL_WAREHOUSE_REPORT (в зависимости от
типа задания на выгрузку)
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
report_id
Тип задания на
String
1
Cм. Список типов
выгрузку
заданий на получение
аналитических данных
по отчётам
params
Параметры
Object
0
Формат зависит от типа
создаваемого
задания. См.
задания
Параметры фильтрации
и описание доступных
полей для выгрузок
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданной
задачи
create_date
Дата создания
String
DateTime
1
задания
Пример использования метода
Запрос:
POST api/v1/data/export/tasks HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
{
"report_id":"GENERAL_REPORT_ON_REMAINING_ITEMS",
"params":{
507
"1156_IC_Product_MDLP_general_gtin":"08027864050035"
}
}
Получение результата:
{
"task_id": "8ef694e2-1332-4590-a79d-3a98a06c2ac1",
"create_date": "2022-09-09T12:02:21.27"
}
11.2. Метод получения статуса задания на выгрузку
Метод предназначен для получения статуса задания на выгрузку по идентификатору задания,
полученному в Метод создания нового задания на выгрузку.
Endpoint: GET <endpoint>/<version>/data/export/tasks/{task_id}
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданного
задания
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданного
задания
508
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
current_status
Статус задачи
String
1
Возможные значения:
"PREPARATION" - "
Подготовка";
"COMPLETED" - "Вы
полнено";
"FAILED" - "Не
успешно"
report_id
Тип задания на
String
1
Cм. Список типов
выгрузку
заданий на получение
аналитических данных
по отчётам
create_date
Дата создания
String
DateTime
1
задачи
params
Параметры
Object
0
задания в
формате * .json
creator
Создатель
Object
UserViewDto
1
задания
task_type
Время хранения
Object
TaskType
1
выгрузки в днях
Формат объекта UserViewDto:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
full_name
ФИО создателя
String
1
задания
Формат объекта TaskType:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
downloading_stor
Время хранения
Number
1
age_days
выгрузки в днях
Пример использования метода
Запрос:
GET /api/v1/data/export/tasks/aa1f5f59-063e-4b4c-9477-b276732aaaf9 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
509
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
Получение результата:
{
"task_id":"aa1f5f59-063e-4b4c-9477-b276732aaaf9",
"current_status":"COMPLETED",
"report_id":"GENERAL_REPORT_ON_REMAINING_ITEMS",
"create_date":"2022-09-09T12:05:21.27",
"creator":{
"full_name":"Иванов Дмитрий Иванович"
},
"task_type":{
"downloading_storage_days":10
}
}
11.3. Метод получения статусов заданий на выгрузку
Метод предназначен для получения информации по всем заданиям на выгрузку
Endpoint: POST <endpoint>/<version>/data/export/tasks/search
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
pagination
Пагинация
Object
Pagination
1
current_statuses
Текущий статус
String
0
Возможные значения:
задания
"PREPARATION" - "
Подготовка";
"COMPLETED" - "Вы
полнено";
"FAILED" - "Не
успешно".
Можно передавать
несколько значений в
строке, например:
"PREPARATION,COM
PLETED,FAILED"
510
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
report_ids
Наименования
Array of
0
Cм. Список типов
типов задания
Strings
заданий на получение
аналитических данных
по отчётам
task_ids
Идентификатор
Array of
0
ы созданных
Strings
заданий
create_dates_fro
Дата создания
String
DateTime
0
m
(с)
create_dates_to
Дата создания
String
DateTime
0
(по)
Формат объекта Pagination:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
page
Страница
Number
0
Для получения списка
пагинации
заданий на выгрузку с
первой записи
необходимо указать 0
size
Размер значений
Number
0
Не может превышать
пагинации
1000
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
list
Список
Array of
1
результатов
Objects
фильтрации
total_count
Количество
Number
1
задач,
соответствующи
х запросу
Формат элемента массива list:
511
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданного
задания
create_date
Дата создания
String
DateTime
1
задания
params
Строка
String
0
параметров
задания в
формате * .json
current_status
Текущий статус
String
1
Возможные значения:
задания
"PREPARATION" - "
Подготовка";
"COMPLETED" - "Вы
полнено";
"FAILED" - "Не
успешно"
report_id
Тип задания
String
1
Cм. Список типов
заданий на получение
аналитических данных
по отчётам
creator
Создатель
Object
UserViewDto
1
задания
task_type
Время хранения
Object
TaskType
1
выгрузки в днях
Формат объекта UserViewDto:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
full_name
ФИО создателя
String
1
задания
Формат объекта TaskType:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
downloading_stor
Время хранения
Number
1
age_days
выгрузки в днях
Пример использования метода
512
Запрос:
POST /api/v1/data/export/tasks/search HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Content-Type: application/json
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
{
"pagination": {
"page": 1,
"size": 100
},
"report_ids": ["GENERAL_PRICING_REPORT","GENERAL_REPORT_ON_DISPOSAL"]
}
Получение результата:
{
"list":[
{
"task_id":"8ef694e2-1332-4590-a79d-3a98a06c2ac1",
"current_status":"COMPLETED",
"report_id":"GENERAL_PRICING_REPORT",
"create_date":"2022-09-09T12:02:21.27",
"creator":{
"full_name":"Иванов Дмитрий Иванович"
},
"task_type":{
"downloading_storage_days":10
}
},
{
"task_id":"83aca9f8-de09-42b2-8ff9-1b1dbb5d5285",
"current_status":"COMPLETED",
"report_id":"GENERAL_REPORT_ON_DISPOSAL",
"create_date":"2022-09-22T12:02:21.27",
"creator":{
"full_name":"Сидоров Сергей Михайлович"
},
"task_type":{
"downloading_storage_days":10
}
}
],
"total_count":2
}
513
11.4. Метод получения результирующих идентификаторов
выгрузок данных
Метод предназначен для получения идентификаторов для выгрузки данных.
Endpoint: GET <endpoint>/<version>/data/export/results
Необходимые права доступа: авторизованный пользователь
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_ids
Список
Array of
UUID
0
Если значение
идентификаторо
Strings
отсутствует, то
в заданий, по
вернется список всех
которым
выгрузок с учетом
необходимо
пагинации.
отобразить
выгрузки
Параметр пути (path
param)
page
Страница
Number
1
Для получения списка
пагинации
выгрузок с первой
записи необходимо
указать 0.
Параметр пути (path
param)
size
Размер значений
Number
1
Не может превышать
пагинации
1000.
Параметр пути (path
param)
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
list
Список
Array of
Result
1
результатов
Objects
фильтрации
514
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
total_count
Количество
Number
1
задач,
соответствующи
х запросу
Формат объекта Result:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
task_id
Идентификатор
String
UUID
1
созданного
задания
result_id
Идентификатор
String
UUID
0
Заполнено, если
результирующей
значение параметра
выгрузки
"download_status"
("Статус выгрузки")
равно "SUCCESS"
("Успешно")
available
Возможность
String
1
Возможные значения:
скачивания
выгрузки
"AVAILABLE" - "Дос
тупна";
"NOT_AVAILABLE"
- "Недоступна"
file_size
Размер CSV
Number
1
выгрузки в
архиве
file_delete_date
Дата и время
String
DateTime
1
запланированно
го удаления
выгрузки
download_status
Статус выгрузки
String
1
Возможные значения:
"SUCCESS" - "Успеш
но";
"PREPARATION" - "
Подготовка";
"FAILED" - "Не
успешно"
515
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
error_message
Сообщение об
String
0
Параметр возвращается
ошибке
при наличии ошибки,
когда значение
параметра
"download_status"
("Статус выгрузки")
равно "FAILED" ("Не
успешно").
Техническая
особенность
формирования
выгрузки: параметр
может возвращаться,
если значение
параметра "available"
("Возможность
скачивания выгрузки")
равно "AVAILABLE"
("Доступна"). При
принятии решения о
доступности выгрузки
необходимо
ориентироваться на
значение параметра
"available"
("Возможность
скачивания выгрузки")
Пример использования метода
Запрос:
GET /api/v1/data/export/results?page=1&size=12&task_ids=4780df3c-c1d7-4e76-83f7-
cea7dcefada0&task_ids=aa1f5f59-063e-4b4c-9477-b276732aaaf9 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
Получение результата:
{
"list":[
{
"task_id":"4780df3c-c1d7-4e76-83f7-cea7dcefada0",
"result_id":"54a85f64-5717-4562-b3fc-2c963f66afa6",
"file_delete_date":"2021-01-25T10:11:13.305Z",
516
"file_size":1024,
"download_status":"SUCCESS",
"available":"AVAILABLE"
},
{
"task_id":"aa1f5f59-063e-4b4c-9477-b276732aaaf9",
"result_id":"5f9fffb9-1c22-49dc-b10d-dfbc0acfcc42",
"file_delete_date":"2021-01-27T12:13:15.305Z",
"file_size":600,
"download_status":"PREPARATION",
"available":"NOT_AVAILABLE"
}
],
"total_count":2
}
11.5. Метод получения выгрузки
Метод предназначен для получения результата задания на выгрузку только в том случае, когда
параметры "download_status" ("Статус выгрузки") и "available" ("Возможность скачивания
выгрузки"), возвращаемые в "Метод получения результирующих идентификаторов выгрузок
данных", имеют значения "SUCCESS"
("Успешно") и "AVAILABLE"
("Доступна"),
соответственно.
Endpoint: GET <endpoint>/<version>/data/export/results/{result_id}/file
Необходимые
права
доступа:
GENERAL_PRICING_REPORT
/
GENERAL_REPORT_ON_MOVEMENT
/
GENERAL_REPORT_ON_REMAINING_ITEMS
/
GENERAL_REPORT_ON_DISPOSAL / VIRTUAL_WAREHOUSE_REPORT (в зависимости от
типа задания на выгрузку)
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
result_id
Идентификатор
String
UUID
1
выгрузки
Выходная информация
По результатам успешного выполнения метода клиент получает zip-архив. Время загруженного
CSV файла указано в формате UTC+0.
В случае ошибки клиент получает следующую информацию:
517
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
GET /api/v1/data/export/results/54b7e985-a438-4644-a506-bd53a4841621/file HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
Accept: */*
Получение результата:
Файл a2668930-22ec-4258-ad2d-699484813dfb.zip
11.6. Метод удаления файла выгрузки
Метод предназначен для удаления файла выгрузки. После вызова метода выгрузка будет удалена
через три минуты.
Endpoint: DELETE <endpoint>/<version>/data/export/results/{result_id}
Необходимые
права
доступа:
GENERAL_PRICING_REPORT
/
GENERAL_REPORT_ON_MOVEMENT
/
GENERAL_REPORT_ON_REMAINING_ITEMS
/
GENERAL_REPORT_ON_DISPOSAL / VIRTUAL_WAREHOUSE_REPORT (в зависимости от
типа задания на выгрузку)
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
result_id
Идентификатор
String
UUID
1
выгрузки
Выходная информация
По результатам выполнения клиент получает следующую информацию:
518
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
result_id
Идентификатор
String
UUID
1
выгрузки
task_id
Идентификатор
String
UUID
1
созданного
задания
file_delete_date
Дата и время
String
DateTime
1
запланированно
го удаления
выгрузки
Пример использования метода
Запрос:
DELETE /api/v1/data/export/results/54b7e985-a438-4644-a506-bd53a4841621 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token fc15b313-0a97-40cd-9700-7e1b2b468c42
Получение результата:
{
"result_id":"54b7e985-a438-4644-a506-bd53a4841621",
"task_id":"aa1f5f59-063e-4b4c-9477-b276732aaaf9",
"file_delete_date":"2022-12-29T15:03:49.577171"
}
11.7. Параметры фильтрации и описание доступных полей
для выгрузок
11.7.1. Общий отчёт по ценам
Тип задания: GENERAL_PRICING_REPORT
Необходимые права доступа: GENERAL_PRICING_REPORT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.1.1. Параметры фильтрации
519
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1026_IC_Period_
Тип
String
1
Допустимые значения:
Type_WM
периода
"IC_Period_Month" - Месяц
;
"IC_Period_Week" - Неделя
520
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1028_IC_Period_
Неделя
String
0*
Указать период выгрузки в
Week
виде порядкового номера
недели при отсчёте с
1
января 1970 года. В этом
параметре
недоступно
указание двух последних
недель. Если требуется
получить данные за одну из
последних двух недель,
воспользуйтесь
параметрами
"0616_IC_Operation_MDLP_
period_all"
("Получить
данные за последние две
недели")
и
"1031_IC_Period_Week_all"
("Неделя (включая две
последние недели)").
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1028_IC_Period_Week":
"2758"
521
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1027_IC_Period_
Месяц
String
0**
Указать период выгрузки в
Month_11_2019
виде порядкового номера
месяца. Для включения в
выгрузку данных за две
последние недели текущего
месяца укажите в параметре
"0616_IC_Operation_MDLP_
period_all"
("Получить
данные за последние две
недели") значение "true".
Формула для расчёта:
текущий_год
*
12
+
номер_месяца_в_году_выгр
узки.
Например, для задания
периода выгрузки "Ноябрь
2022"
(11-й месяц
2022
года)
вычисление
производится
следующим
образом: 2022 * 12 + 11 =
24275
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1027_IC_Period_Month_
11_2019": "24275"
}
1158_IC_Agg_1
Тип
String
0
Допустимые значения:
15_type_realiz
агрегации
Agg_General_one___
1026 -
агрегация по GTIN
(значение по умолчанию)
Agg_General_two___
1026 -
агрегация по GTIN + серия
1156_IC_Product
GTIN
Array of
GTIN
0
_MDLP_general_
Strings
gtin
1157_IC_Product
Серия
Array of
0
_MDLP_general_
Strings
batch
522
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
0312_IC_Source
Источник
Array of
0
Допустимые значения:
_type
финансиро
Strings
вания
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов
внебюджетных фондов";
"смешанные средства
бюджетов"
523
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
0616_IC_Operati
Получить
String
0
Допустимые значения:
on_MDLP_perio
данные за
"true" - получить данные за
d_all
последние
недели
последние две недели;
"false" - не
получать
данные за последние две
недели.
Если указано значение
"true",
и
тип
периода - неделя, то:
• номер
недели
указывается в параметре
"1031_IC_Period_Week_
all"
("Неделя (включая
две последние недели)");
• последней
неделей,
доступной в отчёте,
будет текущая, которая
на
момент
формирования
отчёта
может быть неполной;
• можно запросить любые
предшествующие
(полные) недели.
Пример: отчёт формируется
3
апреля
(среда),
в
параметре
"1031_IC_Period_Week_all"
("Неделя (включая две
последние
недели)"
выбраны
текущая
(неполная)
неделя
и
предыдущая
(полная)
неделя, тогда в отчёт
попадут:
• текущая
(неполная)
неделя
до
даты,
предшествующей
сегодняшней
(1 - 2
апреля,
понедельник - вторник)
;
• предыдущая
(полная)
неделя
(25 - 31 марта,
524
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
Если указано значение
"true",
тип
периода - месяц,
и
в
параметре
"1027_IC_Period_Month_11_
2019"
указан
номер
текущего месяца,
то в
выгрузке будут данные за
текущий месяц, включая
данные за последние две
недели.
Если указано значение
"false", то отчёт может
показать только любые
недели, предшествующие
предыдущей неделе. То есть
если отчёт формируется
3
апреля
(среда),
то
последней
неделей,
доступной в параметре
"1028_IC_Period_Week"
("Неделя"), будет
18 - 24
марта, а следующая неделя
(25 - 31
марта)
будет
недоступна.
Значение заключается в
кавычки в запросе метода,
т.к.
формат
параметра - string, пример:
{
"0616_IC_Operation_MDL
P_period_all": "true"
}
525
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1031_IC_Period_
Неделя
String
0***
Указать период выгрузки в
Week_all
(включая
виде порядкового номера
две
недели при отсчёте с
1
последние
января 1970 года. Параметр
недели)
может быть заполнен, если
в
параметре
"0616_IC_Operation_MDLP_
period_all"
("Получить
данные за последние две
недели") указано значение
"true". В данном параметре
можно указать как номер
одной из двух последних
недель, так и номер любой
другой недели.
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1028_IC_Period_Week":
"2758"
}
* - Обязателен, если не указано значение параметра "1027_IC_Period_Month_11_2019"
526
("Месяц") или если в параметре "0616_IC_Operation_MDLP_period_all" ("Получить данные за
последние две недели") указано значение, отличное от "true"
** - Обязателен, если не указано значение параметра "1028_IC_Period_Week" ("Неделя") или
параметра "1031_IC_Period_Week_all" ("Неделя (включая две последние недели)")
*** - Обязателен, если не указано значение параметра "1028_IC_Period_Week" ("Неделя") или
параметра "1027_IC_Period_Month_11_2019" ("Месяц")
11.7.1.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечание
GTIN
ИНН участника
ИНН эмитента
Код субъекта РФ
Количество точек продаж
МНН
Наименование участника
Наименование эмитента
Объем продаж, уп.
Серия
Значение в выгрузке заполнено, если в запросе параметр
"1158_IC_Agg_115_type_realiz" ("Тип агрегации") имеет
значение "Agg_General_two___
1026" (агрегация по GTIN
+ серия).
Средневзвешенная цена, руб.
Субъект РФ
Торговое наименование
Источник финансирования
Возможные значения:
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов внебюджетных фондов";
"смешанные средства бюджетов"
Дата обновления данных
11.7.2. Общий отчёт по выбытию ЛП
Тип задания: GENERAL_REPORT_ON_DISPOSAL
Необходимые права доступа: GENERAL_REPORT_ON_DISPOSAL
527
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.2.1. Параметры фильтрации
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1026_IC_Period_
Тип
String
1
Допустимые значения:
Type_WM
периода
"IC_Period_Month" - Месяц
;
"IC_Period_Week" - Неделя
1028_IC_Period_
Неделя
String
0*
Указать период выгрузки в
Week
виде порядкового номера
недели при отсчёте с
1
января 1970 года.
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1028_IC_Period_Week":
"2758"
}
528
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1027_IC_Period_
Месяц
String
0**
Указать период выгрузки в
Month_11_2019
виде порядкового номера
месяца.
Формула для расчёта:
текущий_год
*
12
+
номер_месяца_в_году_выгр
узки.
Например, для задания
периода выгрузки "Ноябрь
2022"
(11-й месяц
2022
года)
вычисление
производится
следующим
образом: 2022 * 12 + 11 =
24275
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1027_IC_Period_Month_
11_2019": "24275"
}
1156_IC_Product
GTIN
Array of
GTIN
0
_MDLP_general_
Strings
gtin
1157_IC_Product
Серия
Array of
0
_MDLP_general_
Strings
batch
0312_IC_Source
Источник
Array of
0
Допустимые значения:
_type
финансиро
Strings
вания
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов
внебюджетных фондов";
"смешанные средства
бюджетов"
529
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
0616_IC_Operati
Получить
String
0
Допустимые значения:
on_MDLP_perio
данные за
"true" - получить данные за
d_all
последние
недели
последние две недели;
"false" - не
получать
данные за последние две
недели.
Если указано значение
"true",
и
тип
периода - неделя, то:
• номер
недели
указывается в параметре
"1031_IC_Period_Week_
all"
("Неделя (включая
две последние недели)");
• последней
неделей,
доступной в отчёте,
будет текущая, которая
на
момент
формирования
отчёта
может быть неполной;
• можно запросить любые
предшествующие
(полные) недели.
Пример: отчёт формируется
3
апреля
(среда),
в
параметре
"1031_IC_Period_Week_all"
("Неделя (включая две
последние
недели)"
выбраны
текущая
(неполная)
неделя
и
предыдущая
(полная)
неделя, тогда в отчёт
попадут:
• текущая
(неполная)
неделя
до
даты,
предшествующей
сегодняшней
(1 - 2
апреля,
понедельник - вторник)
;
• предыдущая
(полная)
неделя
(25 - 31 марта,
530
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
Если указано значение
"true",
тип
периода - месяц,
и
в
параметре
"1027_IC_Period_Month_11_
2019"
указан
номер
текущего месяца,
то в
выгрузке будут данные за
текущий месяц, включая
данные за последние две
недели.
Если указано значение
"false", то отчёт может
показать только любые
недели, предшествующие
предыдущей неделе. То есть
если отчёт формируется
3
апреля
(среда),
то
последней
неделей,
доступной в параметре
"1028_IC_Period_Week"
("Неделя"), будет
18 - 24
марта, а следующая неделя
(25 - 31
марта)
будет
недоступна.
Значение заключается в
кавычки в запросе метода,
т.к.
формат
параметра - string, пример:
{
"0616_IC_Operation_MDL
P_period_all": "true"
}
531
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1031_IC_Period_
Неделя
String
0***
Указать период выгрузки в
Week_all
(включая
виде порядкового номера
две
недели при отсчёте с
1
последние
января 1970 года. Параметр
недели)
может быть заполнен, если
в
параметре
"0616_IC_Operation_MDLP_
period_all"
("Получить
данные за последние две
недели") указано значение
"true". В данном параметре
можно указать как номер
одной из двух последних
недель, так и номер любой
другой недели.
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1028_IC_Period_Week":
"2758"
}
* - Обязателен, если не указано значение параметра "1027_IC_Period_Month_11_2019"
532
("Месяц") или если в параметре "0616_IC_Operation_MDLP_period_all" ("Получить данные за
последние две недели") указано значение, отличное от "true"
** - Обязателен, если не указано значение параметра "1028_IC_Period_Week" ("Неделя") или
параметра "1031_IC_Period_Week_all" ("Неделя (включая две последние недели)")
*** - Обязателен, если не указано значение параметра "1028_IC_Period_Week" ("Неделя") или
параметра "1027_IC_Period_Month_11_2019" ("Месяц")
11.7.2.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечания
Дата выбытия
ИНН эмитента
Наименование эмитента
Код субъекта РФ
Субъект РФ
Населенный пункт
Район
ИНН участника
Наименование участника
Идентификатор МД участника
Адрес
МНН
Торговое наименование
GTIN
Серия
Срок годности
Тип выбытия
Cм. Типы выбытия
Объем выбытий, уп.
Источник финансирования
Возможные значения:
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов внебюджетных фондов";
"смешанные средства бюджетов"
Дата обновления данных
533
11.7.3. Общий отчёт по движению ЛП
Тип задания: GENERAL_REPORT_ON_MOVEMENT
Необходимые права доступа: GENERAL_REPORT_ON_MOVEMENT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.3.1. Параметры фильтрации
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1026_IC_Period_
Тип
String
1
Допустимые значения:
Type_WM
периода
"IC_Period_Month" - Месяц
;
"IC_Period_Week" - Неделя
534
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1029_IC_Period_
Неделя
String
0*
Указать период выгрузки в
Week_now
виде порядкового номера
недели при отсчёте с
1
января 1970 года.
Формула для расчёта:
(год_выгрузки
-
1970)
*
52,1786
+
номер_недели_в_году_выгр
узки.
Полученное при расчёте
число всегда округляется до
целого в меньшую сторону.
Например, для задания
периода
выгрузки
"7.11.2022
- 13.11.2022"
(45
неделя
2022 года)
вычисление производится
следующим образом:
(2022 - 1970) * 52,1786 + 45
= 2758,2872
При округлении получается
"2758".
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1029_IC_Period_Week_n
ow": "2758"
}
535
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1027_IC_Period_
Месяц
String
0**
Указать период выгрузки в
Month_11_2019
виде порядкового номера
месяца.
Формула для расчёта:
текущий_год
*
12
+
номер_месяца_в_году_выгр
узки.
Например, для задания
периода выгрузки "Ноябрь
2022"
(11-й месяц
2022
года)
вычисление
производится
следующим
образом: 2022 * 12 + 11 =
24275
Полученное
значение
заключается в кавычки в
запросе метода, т.к. формат
параметра - string, пример:
{
"1027_IC_Period_Month_
11_2019": "24275"
}
1156_IC_Product
GTIN
Array of
GTIN
0
_MDLP_general_
Strings
gtin
1157_IC_Product
Серия
Array of
0
_MDLP_general_
Strings
batch
0312_IC_Source
Источник
Array of
0
Допустимые значения:
_type
финансиро
Strings
вания
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов
внебюджетных фондов";
"смешанные средства
бюджетов"
* - Обязателен,
если не указано значение параметра "1027_IC_Period_Month_11_2019"
("Месяц")
** - Обязателен, если не указано значение параметра "1029_IC_Period_Week_now" ("Неделя")
536
11.7.3.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечания
Дата операции
Операция агрегируется по дате операции, полученной в
документе движения, который направляет участник
ИНН эмитента
Наименование эмитента
МНН
Торговое наименование
GTIN
Серия
Номер операции
ИНН отправителя
Наименование отправителя
Идентификатор МД отправителя
ИНН получателя
Наименование получателя
Идентификатор МД получателя
Количество, уп.
Источник финансирования
Возможные значения:
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов внебюджетных фондов";
"смешанные средства бюджетов"
Дата обновления данных
11.7.4. Общий отчёт по остаткам ЛП
Тип задания: GENERAL_REPORT_ON_REMAINING_ITEMS
Необходимые права доступа: GENERAL_REPORT_ON_REMAINING_ITEMS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.4.1. Параметры фильтрации
537
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1156_IC_Product
GTIN
Array of
GTIN
0
Если значения параметров
_MDLP_general_
Strings
"1156_IC_Product_MDLP_ge
gtin
neral_gtin" ("GTIN") и
"1157_IC_Product_MDLP_ge
neral_batch" ("Серия") не
1157_IC_Product
Серия
Array of
0
указаны, то осуществляется
_MDLP_general_
Strings
выгрузка данных по всем
batch
GTIN + Серия, доступным
данному участнику
0312_IC_Source
Источник
Array of
0
Допустимые значения:
_type
финансиро
Strings
вания
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов
внебюджетных фондов";
"смешанные средства
бюджетов"
11.7.4.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечания
ИНН эмитента
Наименование эмитента
Код субъекта РФ
Субъект РФ
Населенный пункт
Район
ИНН участника
Наименование участника
Идентификатор МД участника
Учитываются только активные места деятельности
Адрес
МНН
Торговое наименование
GTIN
Серия
538
Наименование
Примечания
Срок годности
Остатки на рынке, уп.
Остатки до ввода в ГО, уп.
Общие остатки, уп.
Источник финансирования
Возможные значения:
"собственный бюджет";
"федеральный бюджет";
"региональный бюджет";
"средства бюджетов внебюджетных фондов";
"смешанные средства бюджетов"
Дата обновления данных
Остатки на рынке без учета 705, уп
11.7.5. Мой виртуальный склад (новый)
Тип задания: VIRTUAL_WAREHOUSE_REPORT
Необходимые права доступа: VIRTUAL_WAREHOUSE_REPORT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
11.7.5.1. Параметры фильтрации
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1512_IC_id_mo_
Идентифик
String
BranchID
1
mox
атор МД /
МОХ
1246_IC_Product
GTIN
Array of
GTIN
0
_gtin
Strings
1247_IC_Product
Серия
Array of
0
_batch
Strings
1257_IC_Product
Статус ЛП
String
0
Возможные значения:
_MDLP_stat_lp
ЛП отгружено новому
владельцу;
На балансе текущего
владельца (значение по
умолчанию)
539
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
1173_IC_Product
Тип срока
Array of
0
Возможные значения:
_MDLP_expirati
годности
Strings
on_lp
"Просрочено";
"Остаток срока годности до
14 дней";
"Остаток срока годности до
месяца";
"Остаток срока годности до
2х месяцев";
"Остаток срока годности до
3х месяцев";
"Остаток срока годности
больше 3х месяцев"
0238_IC_Date_St
Начало
String
Date
0
Значение по умолчанию:
art_period_8
периода
текущая дата минус 2 года
окончания
срока
годности
0239_IC_Date_Fi
Завершение
String
Date
0
Значение по умолчанию:
nish_period_8
периода
текущая дата плюс 2 года
окончания
срока
годности
11.7.5.2. Доступные поля выгрузки
Наименования доступных полей выгрузки (соответствуют наименованиям в выгрузке в формате
* .csv):
Наименование
Примечание
Адрес / Идентификатор МД / МОХ
МНН
Торговое наименование
GTIN
Серия
Тип срока годности
Возможные значения:
Просрочено;
Остаток срока годности до 14 дней;
Остаток срока годности до месяца;
Остаток срока годности до 2х месяцев;
Остаток срока годности до 3х месяцев;
Остаток срока годности больше 3х месяцев
540
Наименование
Примечание
Дата окончания срока годности
Количество упаковок
Количество упаковок по 705 схеме
Дата обновления информации
541
12. Получение событий, связанных с выбытием
КИЗ
12.1. Общие правила работы
1. События добавляются в очередь с момента активации соответствующей подписки.
2. После получения порции данных по подписке данные из очереди выдачи участнику будут
удалены.
3. Период хранения данных в очереди участника по подписке в случае, если участник не
получает эти данные, равна 3 дням.
4. В выдаче данные отсортированы по дате добавления в очередь участника по возрастанию (от
наиболее старой даты к новой дате).
12.2. Список доступных типов событий вывода из оборота
(WithdrawalEventType)
Таблица 69. Список доступных типов событий вывода из оборота (WithdrawalEventType)
Наименование типа
Описание
SGTIN_AWAITING_WITHDRAWAL_KKT
Формирование события в подписку по SGTIN,
для которого поступила информация о
выбытии, поместившая SGTIN в реестр
ожиданий вывода из оборота (ККТ или
документ).
Событие формируется при наличии подписки
для следующих участников оборота товаров:
• для участника, осуществившего вывод ЛП
из оборота;
• для текущего владельца SGTIN в ЛК (в
случае отсутствия сведений о приемке со
стороны участника, осуществившего вывод
ЛП из оборота).
Событие формируется при получении схем:
• 511;
• 10511;
• 512;
•
10522
542
Наименование типа
Описание
SGTIN_AWAITING_WITHDRAWAL_DEVICE
Формирование события в подписку по SGTIN,
для которого поступила информация о
выбытии, поместившая SGTIN в реестр
ожиданий вывода из оборота (РВ или
документ).
Событие формируется при наличии подписки
для следующих участников оборота товаров:
• для участника, осуществившего вывод ЛП
из оборота;
• для текущего владельца SGTIN в ЛК (в
случае отсутствия сведений о приемке со
стороны участника, осуществившего вывод
ЛП из оборота).
Событие формируется при получении схем:
• 521;
• 10521;
• 10523;
• 531;
• 10531;
•
10532
543
Наименование типа
Описание
SGTIN_WITHDRAWN
Формирование события в подписку по SGTIN
при смене статуса (для SGTIN, находившихся в
реестре ожиданий, по факту выхода из реестра
ожиданий).
Событие формируется при наличии подписки
для
участника
оборота
товаров,
осуществившего вывод ЛП из оборота.
Событие формируется при получении схем:
• 335 - для типов custom_procedure_code:
◦ 10 (экспорт);
◦ 93 (уничтожение);
◦ 94 (отказ в пользу государства).
• 461:
◦ 511:
▪ 10511;
▪ 512;
▪ 521;
▪ 10521;
▪ 10522;
▪ 10523;
▪ 531;
▪ 10531;
▪
10532.
◦
552 - все типы
12.3. Создание подписки на получение событий, связанных с
выбытием КИЗ
Endpoint: POST <endpoint>/<version>/withdrawal_events/subscribe
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
544
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
event_types
Массив типов
Array of Strings
WithdrawalEve
1
См. Список
событий
ntType;
доступных
Минимальный
типов событий
размер:
1;
вывода из
Максимальны
оборота
й размер: 3;
(WithdrawalEv
entType).
branch_ids
Массив
Array of Strings
Branch;
1
идентификато
Минимальный
ров МД
размер:
1;
Максимальны
й
размер:
2000;
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
subscription_id
Идентификато
String
UUID
1
р подписки
Пример использования метода
Запрос:
POST api/v1/withdrawal_events/subscribe HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"event_types": [
"SGTIN_AWAITING_WITHDRAWAL_KKT",
"SGTIN_WITHDRAWN",
],
"branch_ids": [
"00000000100930"
]
}
545
Получение результата:
{
"subscription_id": "3c2bf2c2-cea2-489d-a282-ddcf79b315b4"
}
12.4. Получение списка подписок
Endpoint:
GET
<endpoint>/<version>/withdrawal_events/subscriptions?start_from={start_from}&count=
{count}
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_from
Индекс первой
Number
Минимальное
1
Параметр
записи
значение: 0
запроса (query
parameter)
count
Максимальное
Number
Минимальное
1
Параметр
количество
значение:
1;
запроса (query
записей
Максимальное
parameter)
значение: 500;
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
subscriptions
Массив с
Array of
WithdrawalEve
1
См. Формат
информацией
Objects
ntsSubscription
объекта
о подписках
WithdrawalEve
ntsSubscription.
Таблица 70. Формат объекта WithdrawalEventsSubscription
546
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
subscription_id
Идентификато
String
UUID
1
р подписки
event_types
Массив типов
Array of Strings
WithdrawalEve
1
См. Список
событий
ntType
доступных
типов событий
вывода из
оборота
(WithdrawalEv
entType).
branch_ids
Массив
Array of Strings
Branch
1
идентификато
ров МД
Пример использования метода
Запрос:
GET api/v1/withdrawal_events/subscriptions?start_from=0&count=1 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"total": 1,
"subscriptions": [
{
"subscription_id": "3c2bf2c2-cea2-489d-a282-ddcf79b315b4",
"event_types": [
"SGTIN_AWAITING_WITHDRAWAL_KKT",
"SGTIN_WITHDRAWN"
],
"branch_ids": [
"00000000100930"
]
}
]
}
12.5. Изменение подписки на получение событий, связанных
с выбытием КИЗ
Endpoint: PUT <endpoint>/<version>/withdrawal_events/subscriptions/{subscription_id}
547
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
subscription_id
Идентификато
String
UUID
1
Параметр пути
р подписки
(path param)
event_types
Массив типов
Array of Strings
WithdrawalEve
1
См. Список
событий
ntType;
доступных
Минимальный
типов событий
размер:
1;
вывода из
Максимальны
оборота
й размер: 3;
(WithdrawalEv
entType).
branch_ids
Массив
Array of Strings
Branch;
1
идентификато
Минимальный
ров МД
размер:
1;
Максимальны
й
размер:
2000;
Выходная информация
По результатам выполнения клиент получает ответ с кодом 200 и пустым телом.
Пример использования метода
Запрос:
PUT api/v1/withdrawal_events/subscriptions/{subscription_id} HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"event_types": [
"SGTIN_AWAITING_WITHDRAWAL_KKT",
"SGTIN_WITHDRAWN",
],
"branch_ids": [
"00000000100930"
]
}
548
12.6. Получение событий, связанных с выбытием КИЗ
Endpoint:
GET
<endpoint>/<version>/withdrawal_events?subscription_id={subscription_id}&count={cou
nt}
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Фиксация событий вывода КИЗ из оборота начинается после создания подписки.
Соответственно, события, произошедшие до создания подписки не будут отражены в результате
метода.
События, полученные в результате метода считаются обработанными и повторное их получение
невозможно. При последующем вызове будут возвращены следующие по очереди события.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
subscription_id
Идентификато
String
UUID
1
Параметр
р подписки
запроса (query
parameter)
count
Максимальное
Number
Минимальное
1
Параметр
количество
значение:
1;
запроса (query
записей
Максимальное
parameter)
значение: 500;
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
events
Массив с
Array of
WithdrawalEve
1
См. Формат
информацией
Objects
nt
объекта
о событиях
WithdrawalEve
выбытия КИЗ
nt
count
Общее
Number
1
количество
записей
Таблица 71. Формат объекта WithdrawalEvent
549
содержание .. 9 10 11 12 ..
|
||
|
|
|