Главная Книги - Разные Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов (версия 4.65.0)
поиск по сайту правообладателям
|
|
содержание .. 8 9 10 11 ..
9. Работа с инструкциями и изображениями
упаковок лекарственных препаратов
В данном разделе описана функциональность по добавлению и редактированию инструкций и
изображений упаковок лекарственных препаратов. Инструкции и изображения добавляются в
разрезе серий. Инструкции и изображения для отдельного ЛП загружаются как отдельный
контейнер с уникальным идентификатором.
Последовательность работы с контейнерами
1.
Создать новый контейнер и получить его идентификатор (Метод создания контейнера).
Новый контейнер получит статус "DRAFT" (Черновик). Идентификатор используется на
последующих шагах работы с контейнерами.
2.
Создать настройку автоматического присвоения контейнеров к GTIN (Метод настройки
автоматического присвоения контейнеров к GTIN) или связь контейнера с серией (Метод
создания связи между контейнером и серией).
ПРИМЕЧАНИЕ
Данный шаг можно выполнить с контейнером в любом статусе
3.
Отправить контейнер на модерацию (Метод передачи контейнера на модерацию).
4.
Проверить статус контейнера (Метод отображения реестра контейнеров):
a. если контейнер в статусе "MODERATION" (На модерации), то модерация ещё не
закончилась;
b. если контейнер в статусе "DECLINED" (Отклонён), то:
i. отредактировать контейнер с учётом замечаний по итогам модерации (Метод
редактирования контейнера), контейнер перейдёт в статус "DRAFT" (Черновик);
Отредактировать контейнер можно, если он находится в
одном из следующих статусов: "DRAFT" (Черновик),
ПРИМЕЧАНИЕ
"DECLINED"
(Отклонён)
или
"APPROVED"
(Подтверждён)
ii. отправить контейнер на повторную модерацию (Метод передачи контейнера на
модерацию).
c. если контейнер в статусе "APPROVED" (Подтверждён), то он отображается в мобильном
приложении "Честный знак" при условии, что для него установлена связь с серией.
9.1. Требования к инструкциям и изображениям
9.1.1. Требования к инструкции в JSON
1. Формат файла - JSON.
2. Размер файла - не более 2 Мбайт.
3. Количество файлов - не более 1.
4. Файл должен иметь следующее наименование: instruction.json.
5. Cтруктура инструкции в формате * .json:
450
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
JSON
JSON
regNum
Номер
String
1
Должен быть заполнен
регистрационно
хотя бы 1 символ,
го
отличный от пробела.
удостоверения
Максимальное
количество
символов - 50
regDate
Дата
String
DateTime
1
государственно
й регистрации
ЛП
regHolder
Держатель
String
1
Должен быть заполнен
регистрационно
хотя бы 1 символ,
го
отличный от пробела.
удостоверения
Максимальное
количество
символов - 500
tradeName
Торговое
String
1
Должен быть заполнен
наименование
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 500
prodFormName
Лекарственная
String
1
Должен быть заполнен
форма
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 500
mnn
Действующие
String
1
Должен быть заполнен
вещества
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 500
composition
Состав
String
1
Должен быть заполнен
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
451
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
JSON
JSON
description
Описание
String
1
Должен быть заполнен
внешнего вида
хотя бы 1 символ,
ЛП
отличный от пробела.
Максимальное
количество
символов - 4000
physicochemical
Физико-
String
0
Максимальное
Characteristics
химические
количество
свойства (для
символов - 4000
радиофармацев
тических
лекарственных
препаратов)
pharmacotherape
Фармакотерапе
String
1
Должен быть заполнен
uticGroup
втическая
хотя бы 1 символ,
группа
отличный от пробела.
Максимальное
количество
символов - 4000
pharmacological
Фармакологиче
Object
Pharmacologic
1
Фармакодинамика и
Properties
ские свойства
alProperties
фармакокинетика
indicationsForUs
Показания к
String
1
Должен быть заполнен
e
применению
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
contraIndication
Противопоказа
String
1
Должен быть заполнен
ния
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
withCare
С
String
1
Должен быть заполнен
осторожностью
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
452
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
JSON
JSON
useDuringPregna
Применение
String
1
Должен быть заполнен
ncy
при
хотя бы 1 символ,
беременности и
отличный от пробела.
в период
Максимальное
грудного
количество
вскармливания
символов - 4000
dosage
Способ
String
1
Должен быть заполнен
применения и
хотя бы 1 символ,
дозы
отличный от пробела.
Максимальное
количество
символов - 4000
sideEffects
Побочное
String
1
Должен быть заполнен
действие
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
overDosage
Передозировка
String
1
Должен быть заполнен
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
interaction
Взаимодействи
String
1
Должен быть заполнен
е с другими ЛП
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
releaseForm
Форма выпуска
String
1
Должен быть заполнен
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
specialInstructio
Особые
String
SpecialInstruct
0
Особые группы
n
указания
ion
пациентов и
инструкция по
утилизации
453
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
JSON
JSON
doctorsActions
Описание
String
0
Максимальное
действий врача
количество
/ пациента при
символов - 4000
пропуске
приема одной
или нескольких
доз ЛП
effectsOnAbility
Влияние ЛП на
String
1
Должен быть заполнен
DriveVehicles
способность
хотя бы 1 символ,
управлять
отличный от пробела.
транспортными
Максимальное
средствами и
количество
механизмами
символов - 4000
expirationInterva
Срок годности
String
1
Должен быть заполнен
l
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 500
storageCondition
Условия
String
1
Должен быть заполнен
хранения
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
storageCondition
Указание на
String
1
Должен быть заполнен
OutChildren
необходимость
хотя бы 1 символ,
хранения ЛП
отличный от пробела.
для
Максимальное
медицинского
количество
применения в
символов - 4000
местах,
недоступных
для детей
precautionsDestr
Cпециальные
String
0
Максимальное
uction
меры
количество
предосторожно
символов - 4000
сти при
уничтожении
неиспользованн
ых ЛП
454
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
JSON
JSON
pharmDelivery
Условия
String
1
Должен быть заполнен
отпуска из
хотя бы 1 символ,
аптек
отличный от пробела.
Максимальное
количество
символов - 4000
manufacturer
Производитель
String
1
Должен быть заполнен
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
support
Организация
String
1
Должен быть заполнен
для претензий
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
Структура объекта PharmacologicalProperties:
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
JSON
JSON
pharmacodynami
Фармакодинам
String
1
Должен быть заполнен
cs
ика
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
pharmacokinetic
Фармакокинети
String
1
Должен быть заполнен
s
ка
хотя бы 1 символ,
отличный от пробела.
Максимальное
количество
символов - 4000
Структура объекта SpecialInstruction:
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
JSON
JSON
specialPatientGr
Особые группы
String
0
Максимальное
oups
пациентов
количество
символов - 4000
455
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
JSON
JSON
disposalInstructi
Инструкция по
String
0
Максимальное
ons
утилизации
количество
символов - 4000
Пример:
{
"regNum":"Номер регистрационного удостоверения",
"regDate":"Дата государственной регистрации ЛП",
"regHolder":"Держатель регистрационного удостоверения",
"tradeName":"Торговое наименование",
"prodFormName":"Лекарственная форма",
"mnn":"Действующее вещество",
"composition":"Состав",
"description":"Описание",
"physicochemicalCharacteristics":"Физико-химические свойства",
"pharmacotherapeuticGroup":"Фармакотерапевтическая группа",
"pharmacologicalProperties":{
"pharmacodynamics":"Фармакодинамика",
"pharmacokinetics":"Фармакокинетика"
},
"indicationsForUse":"Показания к применению",
"contraIndication":"Противопоказания",
"withCare":"С осторожностью",
"useDuringPregnancy":"Применение при беременности",
"dosage":"Способ применения и дозы",
"sideEffects":"Побочное действие",
"overDosage":"Передозировка",
"interaction":"Взаимодействие с другими лекарственными средствами",
"releaseForm":"Форма выпуска",
"specialInstruction":{
"specialPatientGroups":"Особые группы пациентов",
"disposalInstructions":"Инструкция по утилизации"
},
"doctorsActions":"Описание действие врача",
"effectsOnAbilityDriveVehicles":"Влияние ЛП на способность управлять ТС",
"expirationInterval":"Срок годности",
"storageCondition":"Условия хранения",
"storageConditionOutChildren":"Условия хранения в местах, недоступных для
детей",
"precautionsDestruction":"Меры предосторожности при уничтожении",
"pharmDelivery":"Условия отпуска из аптек",
"manufacturer":"Производитель",
"support":"Организация для претензий"
}
456
9.1.2. Требования к инструкции в PDF
1. Формат файла - PDF.
2. Размер файла - не более 2 Мбайт.
3. Количество файлов - не более 1.
4. Нет строгой структуры. Описание должно соответствовать описанию инструкции в формате
* .json.
5. Файл должен иметь следующее наименование: instruction.pdf.
9.1.3. Требования к изображениям
1. Формат изображения - PNG.
2. Соотношение сторон - 1:1 (квадрат).
3. Доступные разрешения:
a. 854 х 854;
b. 1280 х 1280.
Разрешение выбирается участником в зависимости от наличия мелких деталей для
просмотра.
4. Размер одного файла - не более 2 Мбайт.
5. Количество файлов изображений - не более 5.
6. Файлы должны иметь следующие наименования: image-1.png, image-2.png, image-3.png,
image-4.png, image-5.png.
Изображения будут отображаться в мобильном приложении "Честный знак" в соответствии с
порядковым номером в наименовании файла.
9.2. Метод создания контейнера
Endpoint: POST <endpoint>/<version>/reestr/containers
Необходимые права доступа: MANAGE_CONTAINERS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
FormData
FormDa
ta
name
Наименование
String
1
контейнера
package_images
Файлы
File
0
См. Требования к
изображений
изображениям
457
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
FormData
FormDa
ta
instruction
Файл
File
0
См. Требования к
инструкции
инструкции в PDF
(PDF)
structured_instruc
Файл
File
1
См. Требования к
tion
инструкции
инструкции в JSON
(JSON)
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
container_id
Идентификатор
String
UUID
1
контейнера
Пример использования метода
Запрос:
POST api/v1/reestr/containers HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 0c45de54-79b1-48be-81c8-2b7c5c3b9c42
name="Тест"
package_images=@"/C:/Users//Desktop/image-2.png"
instruction=@"/C:/Users//Desktop/instruction.pdf"
structured_instruction=@"/C:/Users//Desktop/instruction.json"
Получение результата:
{
"container_id": "85ccdd6a-314d-44ec-b61f-b315bf81f7d81"
}
9.3. Метод редактирования контейнера
Endpoint: PUT <endpoint>/<version>/reestr/containers/{container_id}
Необходимые права доступа: MANAGE_CONTAINERS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
458
Входной информацией являются следующие данные:
• параметры строки запроса (query parameters):
Параметр
Описание
Тип
Ограничени
Кардина
Примечания
параметра
данных
я
льность
container_id
Идентификатор
String
UUID
1
контейнера
• параметры тела запроса (body parameters):
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
FormData
FormDa
ta
name
Наименование
String
1
контейнера
package_images
Файлы
File
0
См. Требования к
изображений
изображениям. Если
параметр передан
пустым, то ранее
загруженные
изображения для
данного контейнера
будут удалены
instruction
Файл
File
0
См. Требования к
инструкции
инструкции в PDF.
(PDF)
Если параметр
передан пустым, то
ранее загруженная
инструкция в формате
* .pdf для данного
контейнера будет
удалена
structured_instru
Файл
File
1
См. Требования к
ction
инструкции
инструкции в JSON.
(JSON)
Если параметр
передан пустым, то
ранее загруженная
инструкция в формате
* .json для данного
контейнера будет
удалена
Выходная информация
При успешном выполнении клиент получает ответ с кодом 200 и пустым телом.
Пример использования метода
459
Запрос:
PUT api/v1/reestr/containers/c912f922-b3da-41d3-8fb7-c4f63a579c01 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json, text/plain, */*
Authorization: token 5326b140-fd9c-4673-b3b4-168301cfb5ba
Connection: keep-alive
name="Тест 1708/7"
structured_instruction=@"/C:/Users//Desktop/instruction.json"
9.4. Метод скачивания содержимого контейнера
Endpoint: GET <endpoint>/<version>/reestr/containers/{container_id}/download
Необходимые права доступа: MANAGE_CONTAINERS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Параметр
Описание
Тип
Ограничения
Кардина
Примечания
параметра
данных
льность
container_id
Идентификатор
String
UUID
1
Параметр строки
контейнера
запроса (query
parameter)
Выходная информация
По результатам успешного выполнения метода клиент получает zip-архив. Наименование zip-
архива соответствует идентификатору контейнера.
Пример использования метода
Запрос:
GET api/v1/reestr/containers/343e284f-6669-4c4b-ab23-659ca5105c87/download HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json, text/plain, */*
Authorization: token 7112cccd-dafb-42ce-b5d8-c5a934ffffb9
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Получение результата:
Файл 343e284f-6669-4c4b-ab23-659ca5105c87.zip
460
9.5. Метод отображения реестра контейнеров
Endpoint: POST <endpoint>/<version>/reestr/containers/filter
Необходимые права доступа: MANAGE_CONTAINERS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
filter
Параметры
Object
ContainerFilter
1
фильтрации
start_from
Индекс первой
Number
1
записи в списке
контейнеров
count
Количество
Number
1
записей в списке
контейнеров
Формат объекта ContainerFilter:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
container_id
Идентификатор
String
UUID
0
контейнера
name
Наименование
String
0
контейнера
status
Статус
Array of
0
См. Список статусов
контейнера
string
контейнера
Выходная информация
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
entries
Массив
Array of
ContainerResul
0
контейнеров
Object
t
total
Количество
Number
0
записей
Формат объекта ContainerResult:
461
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
container_id
Идентификатор
String
UUID
1
контейнера
name
Наименование
String
1
контейнера
create_date
Дата создания
Date
DateTime
1
контейнера
create_user
Идентификатор
String
UUID
1
пользователя,
который создал
контейнер
change_date
Дата изменения
Date
DateTime
0
контейнера
change_user
Идентификатор
String
UUID
0
пользователя,
который внёс
изменения
status
Статус
Array of
1
См. Список статусов
контейнера
String
контейнера
reason
Причина, по
String
0
которой
контейнер не
прошел
модерацию
Пример использования метода
Запрос:
GET api/v1/reestr/containers/filter HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json, text/plain, */*
Authorization: token 7112cccd-dafb-42ce-b5d8-c5a934ffffb9
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
{
"start_from":0,
"count":20,
"filter":{
}
}
462
Получение результата:
{
"entries":[
{
"container_id":"7a9eb56a-a3d4-41b5-8a97-fc91bf9f89fg",
"name":"Инструкция для GTIN 2023",
"create_date":"2023-03-01T07:40:41.827Z",
"create_user":"g5jib56a-6d44-41b5-8a97-fc91bf9f89fa",
"status": "DRAFT"
}
],
"total": 1
}
9.6. Метод передачи контейнера на модерацию
Endpoint: POST <endpoint>/<version>/reestr/containers/validate
Необходимые права доступа: MANAGE_CONTAINERS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Для данного метода необходимо указать Header: Accept-Language (см. ниже
ВАЖНО
пример использования метода)
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
containers
Идентификатор
Array of
UUID
1
ы контейнеров
String
Выходная информация
При успешном выполнении клиент получает ответ с кодом 202 и пустым телом.
Пример использования метода
Запрос:
POST api/v1/reestr/containers/validate HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 7112cccd-dafb-42ce-b5d8-c5a934ffffb9
Accept-Language: ru-RU
Content-Type: application/json
463
{
"containers":[
"d61ac9e5-2d5a-43ec-a9fd-b96b849dbdb5"
]
}
9.7. Метод настройки автоматического присвоения
контейнеров к GTIN
Метод используется для создания настройки GTIN. Если необходимо отредактировать
настройку, то необходимо воспользоваться этим же методом, указав данные для создания новой
настройки.
Endpoint: POST <endpoint>/<version>/reestr/med_products/assign_container
Необходимые права доступа: MANAGE_CONTAINERS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
gtin
GTIN, для
String
GTIN
1
которого
устанавливается
связь с
контейнером
container_id
Идентификатор
String
UUID
1
контейнера
464
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
autopropagate
Признак
Boolean
1
Возможные значения:
автоматической
true - связь
установки связи
устанавливается
между
автоматически;
контейнером и
false - связь не
сериями
устанавливается
автоматически.
Если у серии явным
образом не указан
идентификатор
контейнера, то при
значении "true" для
такой серии
автоматически будет
установлена связь с
контейнером,
указанным в параметре
"container_id"
("Идентификатор
контейнера")
Выходная информация
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
gtin
GTIN, для
String
GTIN
1
которого
устанавливается
связь с
контейнером
container_id
Идентификатор
String
UUID
1
контейнера
autopropagate
Признак
Boolean
1
Возможные значения:
автоматической
true - связь
установки связи
устанавливается
между
автоматически;
контейнером и
false - связь не
сериями
устанавливается
автоматически
Пример использования метода
Запрос:
465
POST api/v1/reestr/med_products/assign_container HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 7112cccd-dafb-42ce-b5d8-c5a934ffffb9
Content-Type: application/json
{
"container_id": "343e284f-6669-4c4b-ab23-659ca5105c87",
"gtin": "04602824000226",
"autopropagate": true
}
Получение результата:
{
"container_id":"343e284f-6669-4c4b-ab23-659ca5105c87",
"gtin":"04602824000226",
"autopropagate":true
}
9.8. Метод создания связи между контейнером и серией
Метод используется для создания связи между контейнером и серией. Если необходимо
отредактировать связь, то необходимо воспользоваться этим же методом, указав данные для
создания новой связь.
Endpoint: POST <endpoint>/<version>/reestr/batches/assign_container
Необходимые права доступа: MANAGE_CONTAINERS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
gtin
GTIN, для
String
GTIN
1
которого
устанавливается
связь с
контейнером
batch
Серия, для
String
1
которой
устанавливается
связь с
контейнером
466
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
container_id
Идентификатор
String
UUID
1
контейнера
Выходная информация
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
gtin
GTIN, для
String
GTIN
1
которого
устанавливается
связь с
контейнером
batch
Серия, для
String
1
которой
устанавливается
связь с
контейнером
container_id
Идентификатор
String
UUID
1
контейнера
Пример использования метода
Запрос:
POST api/v1/reestr/batches/assign_container HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 7112cccd-dafb-42ce-b5d8-c5a934ffffb9
Content-Type: application/json
{
"container_id": "b475740e-fab8-4ef4-a620-4c12d5034bcc",
"gtin": "04604060002439",
"batch": "070919017"
}
Получение результата:
{
"gtin":"04604060002439",
"batch":"070919017",
"container_id":"b475740e-fab8-4ef4-a620-4c12d5034bcc"
}
467
10. Получение аналитических данных
10.1. Создание задачи
Endpoint: POST <endpoint>/<version>/export/tasks/{task_type}
Необходимые права доступа: MANAGE_EXPORT_TASKS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Ограничения
Организация может иметь не более 1000 задач одновременно, для создания новых нужно
удалить предыдущие задачи.
Пользователь может иметь не более 10 задач одновременно, для создания новых нужно удалить
предыдущие задачи.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
task_type
Тип
String
TaskType
1
Параметр пути
создаваемой
(path param);
задачи
Регистонезави
сим; Cм.
Список типов
задач на
получение
аналитических
данных
(TaskType)
task_filter
Параметры
Object
TaskFilter
1
создаваемой
задачи
Структура данных TaskFilter
468
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filters
Параметры
Object
1
Формат
фильтрации
зависит от
данных
типа задачи.
См.
Параметры
фильтрации и
описание
доступных
полей для
выгрузок
данных
fields
Набор полей,
Array of Strings
0*
Если
которые
отсутствует
должны
или передан
присутствоват
пустой массив,
ь в выгрузке
в
выгрузке
будут
присутствоват
ь
все
возможные
поля.
Набор полей
зависит
от
типа задачи.
См.
Параметры
фильтрации и
описание
доступных
полей
для
выгрузок
данных
* - Игнорируется для выгрузок:
• Выгрузка детализированной информации по движению ЛП
• Выгрузка иерархии по SGTIN
• Выгрузка общедоступной информации по SGTIN
Выходная информация
По результатам выполнения клиент получает следующую информацию:
469
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
UUID
1
р созданной
задачи
В случае ошибки клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
POST api/v1/export/tasks/sscc_hierarchy HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"task_filter": {
"filters": {
"sscc": ["201902251235570000"]
}
}
}
Получение результата:
{
"id": "cc7890a8-39ac-4ba9-ae9a-b20f406a781c"
}
10.2. Просмотр информации о задаче пользователя
Endpoint: GET <endpoint>/<version>/export/tasks/{task_id}
470
Необходимые права доступа: MANAGE_EXPORT_TASKS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
task_id
Идентификато
String
UUID
1
Параметр пути
р задачи
(path param)
Выходная информация
По результатам выполнения клиент получает объект Task. См. Формат объекта Task
В случае ошибки клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
GET api/v1/export/tasks/0b74344f-2cad-4e6b-a1e9-fd30c762d432 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"id": "0b74344f-2cad-4e6b-a1e9-fd30c762d432",
"type": "sscc_hierarchy",
"status": "COMPLETED",
"create_date": "2020-08-21T10:47:42.587686Z",
"progress": "1/1",
471
"parameters": "{\"filters\":{\"sscc\": [\"201902251235570000\"]}}",
"language": "ru"
}
10.3. Просмотр списка задач пользователя
Endpoint: POST <endpoint>/<version>/export/tasks/filter
Необходимые права доступа: MANAGE_EXPORT_TASKS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
task_ids
Массив
Array of Strings
UUID
0
Перемещены в
(Устарел)
идентификато
массив
ров задач
TasksFilter
task_ids,
task_status,
create_date_fro
m,
create_date_to,
n_page,
page_size. Дата
устаревания
2021-05-05
472
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
task_status
Статус задачи
String
TaskStatus
0
См. Список
(Устарел)
статусов
обработки
задачи на
получение
аналитических
данных
(TaskStatus).
Перемещены в
массив
TasksFilter
task_ids,
task_status,
create_date_fro
m,
create_date_to,
n_page,
page_size. Дата
устаревания
2021-05-05
create_date_fro
Дата создания
String
Date
0
Перемещены в
m (Устарел)
задачи, начало
массив
временного
TasksFilter
промежутка
task_ids,
task_status,
create_date_fro
m,
create_date_to,
n_page,
page_size. Дата
устаревания
2021-05-05
create_date_to
Дата создания
String
Date
0
Перемещены в
(Устарел)
задачи,
массив
окончание
TasksFilter
временного
task_ids,
промежутка
task_status,
create_date_fro
m,
create_date_to,
n_page,
page_size. Дата
устаревания
2021-05-05
473
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
n_page
Номер
Number
0
Значение по
(Устарел)
страницы
умолчанию: 1
page_size
Количество
Number
0
Значение по
(Устарел)
результатов на
умолчанию: 20
странице
start_from
Индекс первой
Number
0
Значение по
записи
умолчанию: 0
count
Количество
Number
0
Значение по
записей в
умолчанию: 20
результате
filter
Параметры
Object
TasksFilter
1
фильтрации
Формат объекта TasksFilter:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
task_ids
Массив
Array of Strings
UUID
0
идентификато
ров задач
task_status
Статус задачи
Array of Strings
TaskStatus
0
См. Список
статусов
обработки
задачи на
получение
аналитических
данных
(TaskStatus)
task_type
Тип задачи
Array of Strings
TaskType
0
Cм. Список
типов задач
для
фильтрации
аналитических
данных
(TaskType)
create_date_fro
Дата создания
String
Date
0
m
задачи, начало
временного
промежутка
474
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
create_date_to
Дата создания
String
Date
0
задачи,
окончание
временного
промежутка
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
items
Список
Object
Task
1
См. Формат
результатов
объекта Task
фильтрации
total
Общее
Number
1
количество
задач
В случае ошибки клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
POST api/v1/export/tasks/filter HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
475
"start_from": 3,
"count": 2,
"filter": {
"task_status": ["COMPLETED", "FAILED"]
}
}
Получение результата:
{
"items": [
{
"id": "0b74344f-2cad-4e6b-a1e9-fd30c762d432",
"type": "sscc_hierarchy",
"status": "COMPLETED",
"create_date": "2020-08-21T10:47:42.587686Z",
"progress": "1/1",
"parameters": "{\"filters\":{\"sscc\": [\"201902251235570001\"]}}",
"language": "ru"
},
{
"id": "20397800-f37f-4d8e-9a19-f19d194c5029",
"type": "sscc_hierarchy",
"status": "FAILED",
"create_date": "2020-08-21T10:47:42.696242Z",
"progress": "0/0",
"reason": "По указанным параметрам не найдено данных",
"parameters": "{\"filters\":{\"sscc\": [\"201902251235570002\"]}}",
"language": "ru"
}
],
"total": 9
}
10.4. Получение результата задачи
Endpoint: GET <endpoint>/<version>/export/tasks/{task_id}/result
Необходимые права доступа: MANAGE_EXPORT_TASKS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
476
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
task_id
Идентификато
String
UUID
1
Параметр пути
р задачи
(path param)
Выходная информация
По результатам успешного выполнения метода клиент получает zip-архив со следующим
содержимым:
Для задачи с типом sgtins_by_doc_id:
1. Файл <task_id>-request.json с параметрами фильтрации, указанными при создании
задачи;
2. Файлы с данными <task_id>-X.csv. При большом количестве данных выгрузка делится на
несколько файлов, в каждом из которых содержится не более 1 000 000 записей. X -
порядковый номер файла (нумерация начинается с 0).
Для задач с типом detail_batch_movements, sscc_hierarchy, public_sgtins, public_sgtins_archive,
number_sgtins_in_batches, batches_registry:
1. Файл <task_id>-request.json с параметрами фильтрации, указанными при создании
задачи;
2. Файл с данными <task_id>-result.json.
В случае ошибки клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
GET api/v1/export/tasks/0b74344f-2cad-4e6b-a1e9-fd30c762d432/result HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
477
Файл 0b74344f-2cad-4e6b-a1e9-fd30c762d432.zip
Запрос:
GET api/v1/export/tasks/0b74344f-2cad-4e6b-a1e9-fd30c762d432/result?file=0b74344f-
2cad-4e6b-a1e9-fd30c762d432-0.csv HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
Содержимое файла 0b74344f-2cad-4e6b-a1e9-fd30c762d432-0.csv
10.5. Отмена задачи
Endpoint: POST <endpoint>/<version>/export/tasks/{task_id}/cancel
Необходимые права доступа: MANAGE_EXPORT_TASKS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
task_id
Идентификато
String
UUID
1
Параметр пути
р задачи
(path param)
Выходная информация
В случае успешного выполнения метода клиент получает ответ с пустым
телом, в случае
возникновения ошибки, следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
478
POST api/v1/export/tasks/0b74344f-2cad-4e6b-a1e9-fd30c762d432/cancel HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Результатом успешного выполнения запроса будет Status Code: 204 No Content
Получение результата (пример ошибки):
{
"error_code": "TASK_NOT_FOUND",
"error_description": "Задача не найдена."
}
10.6. Удаление задачи
Endpoint: DELETE <endpoint>/<version>/export/tasks/{task_id}
Необходимые права доступа: MANAGE_EXPORT_TASKS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
task_id
Идентификато
String
UUID
1
Параметр пути
р задачи
(path param)
Выходная информация
В случае успешного выполнения метода клиент получает ответ с пустым телом, в случае
возникновения ошибки, следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
479
Пример использования метода
Запрос:
DELETE api/v1/export/tasks/0b74344f-2cad-4e6b-a1e9-fd30c762d432 HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Результатом успешного выполнения запроса будет Status Code: 204 No Content
Получение результата (пример ошибки):
{
"error_code": "TASK_NOT_FOUND",
"error_description": "Задача не найдена."
}
10.7. Просмотр списка установленных ограничений на
количество задач
Endpoint: GET <endpoint>/<version>/export/tasks/settings
Необходимые права доступа: MANAGE_EXPORT_TASKS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Выходная информация
По результатам выполнения клиент получает следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
max_task_coun
Ограничение,
Number
1
t_per_user
количества
задач на
пользователя
max_task_coun
Ограничение
Number
1
t_per_member
количества
задач на
организацию
Пример использования метода
Запрос:
480
GET /api/v1/export/tasks/settings HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
Получение результата:
{
"max_task_count_per_user": 10,
"max_task_count_per_member": 10
}
10.8. Список возможных кодов ошибок
Таблица 68. Список возможных кодов ошибок
Код
Описание
TASKS_NOT_COMPLETED
Задача не завершена
TASK_NOT_FOUND
Задача не найдена
USER_TASKS_LIMIT_EXCEEDED
Достигнут лимит задач на пользователя
MEMBER_TASKS_LIMIT_EXCEEDED
Достигнут лимит задач на организацию
INVALID_TASK_FIELDS
Запрошены не существующие поля выгрузки
NOT_ENOUGH_RIGHTS
Недостаточно прав для создания задачи на
выгрузку
ZIP_ENTRY_NOT_FOUND
Файл с указанным именем не найден в архиве
ZIP_ENTRY_TOO_LARGE
Указанный файл имеет слишком большой
размер
UNSUPPORTED_EXPORT_TYPE
Неподдерживаемый тип выгрузки
INVALID_FILTER_PARAMETERS
По указанным параметрам не найдено данных
10.9. Параметры фильтрации и описание доступных полей
для выгрузок данных
10.9.1. Выгрузка детализированной информации по движению ЛП (временно
приостановлен)
Тип задачи: detail_batch_movements (Временно приостановлен)
Необходимые права доступа: VIEW_BATCH_GRAF
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
481
10.9.1.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
GTIN
String
GTIN
1
batch
Номер
String
BatchNumber
1
производствен
ной серии
10.9.1.2. Формат результата выгрузки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
GTIN
String
GTIN
1
Идентификаци
онный номер
для
идентификаци
и товаров
batch
Номер серии
String
BatchNumber
1
Производствен
ная серия
product_sell_na
Торговое
String
1
me
наименование
prod_name
Торговая
String
1
марка
reg_holder
Держатель РУ
String
1
batch_size
Размер
Number
1
производствен
ной серии
date
Дата выпуска
String
MskDateTime
1
серии (UTC)
system_subj_id
Идентификато
String
SysID
1
р участника
(производител
я)
out_of_circulati
Выбыло из
Number
1
Количество
on_count
оборота
КМ серии
выбывших из
оборота
in_circulation_c
В обороте
Number
1
Количество
ount
КМ серии в
обороте
482
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
items
Элементы
Array of
1
Массив
распределения
Objects
элементов МД
КМ
и МОХ между,
которыми
распределены
КМ в рамках
серии,
на
момент
получения
выгрузки.
Формат элемента массива items.
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total_income
Приход
Number
1
Количество
КМ, которые
поступили на
МД или МОХ,
в рамках
серии.
total_outcome
Выбытие
Number
1
Количество
КМ, которые
выбыли с МД
или МОХ, в
рамках серии.
production
Производство
Number
1
Статус
"производство
". Отображает
количество
КМ,
произведенны
х на данном
МД или SSID
(для
зарубежного
производства).
483
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
import
Импорт
Number
1
Статус
"импорт".
Отображает
количество
КМ, которые
поступили
через импорт
на данное МД
wholesale
Оптовая
Number
1
Статус
продажа
"оптовая
продажа".
Отображает
количество
КМ, которые
были
выведены с
данного МД
или МОХ,
через оптовую
продажу. При
увеличении
статуса
"оптовая
продажа"
увеличивается
показатель
"Выбытие" для
текущего МД
и МОХ. Также
увеличивается
статус
"Закупка в
РФ", для МД
или МОХ,
который
совершил
покупку КМ.
484
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
purchase_in_ru
Закупка в РФ
Number
1
Статус
ssia
"Закупка в
РФ".
Отображает
количество
КМ, которые
были введены
на МД или
МОХ, через
закупку КМ.
Данный статус
следует после
"оптовой
продажи". При
увеличении
статуса
"закупка в рф"
увеличивается
показатель
Приход для
текущего МД
или МОХ.
Также
увеличивается
статус
"Оптовая
продажа", для
МД или МОХ,
который
совершил
продажу КМ.
retail_sale
Розничная
Number
1
Конечный
продажа
статус для КМ
в серии.
Отображает
количество
КМ, которые
были
выведены из
оборота через
розничную
продажу (ККТ
и д.р)
485
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
discount_sale
Продажа со
Number
1
Конечный
скидкой
статус для КМ
в серии.
Отображает
количество
КМ, которые
были
выведены из
оборота через
розничную
продажу со
скидкой
(льготный
рецепт и д.р)
medical_use
Медицинское
Number
1
Конечный
использование
статус для КМ
в серии.
Отображает
количество
КМ, которые
были
выведены из
оборота через
медицинское
использование.
other
Другое
Number
1
Конечный
статус для КМ
в серии.
Отображает
количество
КМ, которые
были
выведены из
оборота
другими
способами
(выборка
образцов,
уничтожение и
т.д.)
486
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
balance
Баланс
Number
1
Количество
КМ, которые
находятся на
МД на
текущий
момент.
warehouse_id
Идентификато
String
1
Идентификаци
р МД, МОХ
онный номер
или SSID
МД или МОХ
или
идентификатор
участника во
ФГИС МДЛП
(в случае
зарубежного
производства)
address
Адрес
String
0
Полный адрес
МД или МОХ
address_houseg
Адрес
String
0
Код адреса МД
uid
ГАР/ФИАС
или МОХ в
формате
ГАР/ФИАС
inn
ИНН или
String
0
ИНН или
ИТИН
ИТИН
участника
оборота
org_name
Наименование
String
0
Наименование
организации
country_code
Код страны
String
0
Код страны, на
территории
которой
находится МД
или МОХ.
region_code
Код региона
String
0
487
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
children
Перемещения
Array of
0
Массив
Objects
объектов.
Содержит
сведения о МД
или МОХ, на
который были
перемещены
КМ с текущего
МД или МОХ.
Объекты
включают в
себя
информацию о
количестве
перемещенных
КМ и дате
совершения
операции.
Формат элемента массива children.
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
warehouse_id
Идентификато
String
1
Идентификаци
р МД, МОХ
онный номер
или SSID
МД или МОХ
или
идентификатор
участника во
ФГИС МДЛП
(в случае
зарубежного
производства)
count
Количество
Number
1
Количество
КМ, которые
были
перемещены
на данное
МД/МОХ
op_date
Дата операции
String
MskDateTime
1
Дата операции
(UTC)
поступления
КМ на
МД/МОХ.
488
10.9.2. Выгрузка иерархии по SGTIN
Тип задачи: sscc_hierarchy
Необходимые права доступа: REESTR_ALL или REESTR_OWNED_SSCC_SGTIN
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.2.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtins
Массив SGTIN
Array of Strings
SGTIN
0
sscc
Массив SSCC
Array of Strings
SSCC
0
Параметры фильтрации должны содержать не более 100 значений в сумме.
10.9.2.2. Формат результата выгрузки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
package
Массив
Array of
PackageHierarc
1
иерархий
Objects
hy
Структура объекта PackageHierarchy:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
0*
sscc
SSCC
String
SSCC
0**
package_compo
Иерархия
Object
{PackageComp
1
Формат
nents
вложенности
onentsSscc,
зависит от
PackageCompo
того, что
nentsSgtin}
описывает
данный
объект:
вторичную
(PackageComp
onentsSgtin)
или третичную
(PackageComp
onentsSscc)
упаковку
489
* - Присутствует, если объект представляет вторичную упаковку
** - Присутствует, если объект представляет третичную упаковку
Структура объекта PackageComponentsSscc:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
up
Иерархия
Array of
SsccInfo
1
вложенности
Objects
"вверх"
down
Иерархия
Array of
SsccInfo
1
вложенности
Objects
"вниз"
Структура объекта PackageComponentsSgtin:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
up
Иерархия
Array of
SsccInfo
1
вложенности
Objects
"вверх"
down
Иерархия
Array of
SgtinInfo
1
вложенности
Objects
"вниз"
Структура объекта SsccInfo:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
sscc
SSCC
String
SSCC
1
gtin
GTIN
String
GTIN
1
status
Статус SGTIN
String
1
batch
Номер
String
BatchNumber
1
производствен
ной серии
expiration_date
Срок годности
String
MskDateTime
1
препарата
490
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
pause_decision
Информация о
Object
HierarchyPause
0
_info
решении о
DecisionInfo
приостановке
Структура объекта HierarchyPauseDecisionInfo:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
id
Идентификато
String
UUID
1
р решения
number
Номер
String
1
решения
date
Дата решения
String
Date
1
Структура объекта SsccInfo:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sscc
SSCC
String
SSCC
1
packing_date
Дата и время
String
MskDateTime
1
совершения
операции
упаковки
owner_id
Идентификато
String
1
р текущего
владельца
упаковки
owner_organiza
Наименование
String
1
tion_name
организации
текущего
владельца
упаковки
childs
Список
Array of
{SsccInfo,
0*
вложенных в
Objects
SgtinInfo}
упаковку
элементов
* - Отсутствует, если данный объект находится в описании иерархии "вверх".
491
10.9.3. Выгрузка информации о количестве SGTIN и их сериях в SSCC
Тип задачи: number_sgtins_in_batches
Необходимые права доступа: SSCC_CHECK
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.3.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
bulk_sscc
Список SSCC
Array of Strings
1
на проверку*
* - Максимальное количество элементов в списке запрашиваемых SSCC: 35
10.9.3.2. Доступные поля выгрузки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
запрошенных
записей
failed
Количество не
Number
1
найденных
записей и
записей, не
прошедших
проверку
entries
Записи из
Array of
FoundSgtins
0
реестра
Objects
failed_entries
Массив КИЗ,
Array of
FailedSgtinsNu
0
по которым
Objects
mberInfo
поиск
завершился с
ошибкой
Структура объекта FoundSgtins:
492
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sscc
SSCC
String
1
number_sgtins
Состав короба
SgtinNumberIn
1
fo
Структура объекта SgtinNumberInfo:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
batch
Серия
String
0
count_sgtins
Количество
Number
0
SGTIN в серии
exp_date
Срок годности
Date
0
Структура объекта FailedSgtinsNumberInfo:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sscc
SSCC
String
SSCC
1
error_code
Код ошибки*
Number
1
error_desc
Описание
String
1
ошибки
* Значения кодов:
Код
Значение
2
Запрашиваемые данные не найдены.
10.9.4. Выгрузка общедоступной информации по SGTIN
Тип задачи: public_sgtins
Необходимые права доступа: REESTR_ALL, REESTR_SGTIN
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.4.1. Параметры фильтрации
493
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtins
Массив SGTIN
Array of Strings
SGTIN
1
Максимальное количество элементов в списке запрашиваемых SGTIN: 100
10.9.4.2. Формат результата выгрузки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
запрошенных
записей
failed
Количество не
Number
1
найденных
записей и
записей, не
прошедших
проверку
entries
Записи из
Array of
PublicSgtins
0
реестра
Objects
failed_entries
Массив КИЗ,
Array of
FailedPublicSgt
0
по которым
Objects
ins
поиск
завершился с
ошибкой
Структура объекта PublicSgtins:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
gtin
GTIN
String
GTIN
1
status
Статус
String
1
sscc
Идентификаци
String
SSCC
0
онный код
третичной
упаковки
494
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
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
форма
495
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
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, 6}
0
e
оборота
via_device
Способ
Number
{1, 2, 3, 4}
0
выбытия
Структура объекта FailedPublicSgtins:
496
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
error_code
Код ошибки*
Number
1
error_desc
Описание
String
1
ошибки
* Значения кодов:
Код
Значение
2
Запрашиваемые данные не найдены.
10.9.5. Выгрузка отчёта "Мой виртуальный склад" (Устарел)
Тип задачи: remaining_medicines_branches
Данный тип задачи является устаревшим. Необходимо использовать новые
ВАЖНО
методы, приведённые в разделе Аналитические данные по отчётам
Необходимые права доступа: VIEW_BALANCE_ON_BP_REPORT
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.5.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
branch_id
Идентификато
String
0*
р места
деятельности
warehouse_id
Идентификато
String
0*
р места
ответственног
о хранения
gtin
GTIN
String
0**
* - Обязателен, если не указан GTIN
** - Обязателен, если не указан идентификатор места деятельности или идентификатор
ответственного хранения
10.9.5.2. Доступные поля выгрузки
497
Наименование
Описание
Примечания
branch_id
Идентификатор места
деятельности или
идентификатор места
ответственного хранения
gtin
GTIN
batch
Серия
exp_date
Срок годности
prod_name
МНН (стандартизованное
значение)
prod_sell_name
Торговое наименование
cnt
Количество упаковок ЛП
cnt_not_on_my_balance
Количество SGTIN, которое
было отгружено отправителем
update_date
Дата обновления данных в
отчете
10.9.6. Выгрузка из реестра серий
Тип задачи: batches_registry
Необходимые права доступа: VIEW_BATCHES_REGISTRY
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
10.9.6.1. Параметры фильтрации
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
GTIN
String
0
batch
Номер
String
0
производствен
ной серии
498
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
emission_type
Тип эмиссии
Number
{1,2,3,4}
0
1 - Собственн
ое
производство;
2 - Контрактн
ое
производство;
3 - Иностран
ное
производство;
4 - Маркиров
ан в зоне
таможенного
контроля
product_sell_na
Торговое
String
0
me
наименование
10.9.6.2. Доступные поля выгрузки
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sell_name
Торговое
String
0
наименование
gtin
GTIN
String
GTIN
0
Идентификаци
онный номер
для
идентификаци
и товаров
batch
Серия
String
0
emission_type
Тип эмиссии
String
0
count_sgtin
Количество
Number
0
SGTIN
7vzn
7 ВЗН
Boolean
0
false - Нет;
true - Да
gnvlp
ЖНВЛП
Boolean
0
false - Нет;
true - Да
in_circulation_c
Количество
Number
0
ount
SGTIN
введенных в
оборот
499
содержание .. 8 9 10 11 ..
|
||
|
|
|