Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов. Протокол (версия 4.57.0) - часть 6

 

  Главная      Книги - Разные     Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов. Протокол обмена интерфейсного уровня Версия 4.57.0

 

поиск по сайту            правообладателям  

 

   

 

    

 

содержание      ..     4      5      6      7     ..

 

 

 

Описание API Государственной информационной системы мониторинга и движения лекарственных препаратов. Протокол (версия 4.57.0) - часть 6

 

 

{
"accounts": [
{
"account_number": "r78gyfqn1h-n3o4itgnj103jg",
"balance": 1000000,
"last_update": "2019-09-17T19:00:00.000",
"min_balance_threshold": 25000
}
]
}
8.11. Получение информации из реестра регистраторов
8.11.1. Фильтрация по реестру регистраторов эмиссии
Endpoint: POST <endpoint>/<version>/reestr/registration-devices/emission/filter
Необходимые права доступа (любое из): REESTR_ALL, REESTR_REGISTRATION_DEVICES
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр
Object
EmissionDevic
1
регистраторов
eFilter
эмиссии
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Структура данных EmissionDeviceFilter
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
device_id
Идентификато
String
DeviceID
0
р устройства
410
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
provision_start_
Дата
String
Date
0
date
предоставлени
я, начало
периода
фильтрации
provision_end_
Дата
String
Date
0
date
предоставлени
я, конец
периода
фильтрации
placement_type
Тип
Number
{0,1,2}
0
•
0 - по
размещения
месту
использова
ния
•
1 - ЦОД
оператора
•
2 - по
адресу МД
status
Статус
Number
{0,1,2,3,5,6,7}
0
•
0 - не
введен в
эксплуатац
ию
•
1 - не
готов
к
передаче
сведений
•
2 - готов к
передаче
сведений
•
3 - выведе
н
из
эксплуатац
ии
•
5 - ремон
т
•
6 - замена
•
7 - возвра
т
411
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
device_vendor
Производитель
String
0
устройства
device_model
Модель
String
0
устройства
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
entries
Записи из
Array of
EmissionDevic
1
реестра
Objects
eInfoEntry
Формат объекта EmissionDeviceInfoEntry:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
device_id
Идентификато
String
DeviceID
1
р устройства
serial_number
Серийный
String
1
(индивидуальн
ый) номер
устройства
device_name
Наименование
String
1
(модель)
устройства
placement_type
Тип
Number
{0,1,2}
1
•0 - по
размещения
месту
использова
ния
•
1 - ЦОД
оператора
•
2 - по
адресу МД
412
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
houseguid
Адрес
String
UUID
0
Отсутствует в
установки (код
случае
ГАР/ФИАС)
размещения в
ЦОД
оператора
device_address
Текстовое
String
0
Отсутствует в
представление
случае
адреса
размещения в
установки
ЦОД
оператора
usage_type
Тип
Number
{0,1}
1
•
использования
0 - основн
ой
• 1 - резерв
provision_date
Дата
String
Date
1
предоставлени
я
contract_info
Информация о
Object
DeviceContract
1
договоре
InfoEntry
413
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
status
Статус
Number
{0,1,2,3,5,6,7}
1
•
0 - не
введен в
эксплуатац
ию
•
1 - не
готов
к
передаче
сведений
•
2 - готов к
передаче
сведений
•
3 - выведе
н
из
эксплуатац
ии
•
5 - ремон
т
•
6 - замена
•
7 - возвра
т
device_vendor
Производитель
String
1
устройства
device_model
Модель
String
1
устройства
Пример использования метода
Запрос:
414
POST api/v1/reestr/registration-devices/emission/filter HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {
"provision_start_date": "2019-04-07",
"provision_end_date": "2019-05-08",
"device_vendor": "ЦРПТ",
"device_model": "1.0"
},
"start_from": 0,
"count": 10
}
Получение результата:
415
{
"total": 2,
"entries": [
{
"device_id": "0000000099990033",
"serial_number": "76EA00000077",
"device_name": "ASUS A620A",
"placement_type": 0,
"houseguid": "005a1430-09fc-44c1-801c-7d71c18627b5",
"device_address": "г. Москва, ул. Малая Большая",
"usage_type": 0,
"provision_date": "2019-04-10",
"contract_info": {
"doc_num": "ABC12345",
"doc_date": "2019-04-10"
},
"status": 0,
"device_vendor": "ЦРПТ",
"device_model": "1.0"
},
{
"device_id": "0000000099990055",
"serial_number": "76EA00000091",
"device_name": "ASUS A620A",
"placement_type": 1,
"usage_type": 0,
"provision_date": "2019-04-11",
"contract_info": {
"doc_num": "N120",
"doc_date": "2019-04-11"
},
"status": 0,
"device_vendor": "ЦРПТ",
"device_model": "1.0"
}
]
}
8.11.2. Фильтрация по реестру регистраторов выбытия
Endpoint: POST <endpoint>/<version>/reestr/registration-devices/withdrawal/filter
Необходимые права доступа (любое из): REESTR_ALL, REESTR_REGISTRATION_DEVICES
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
416
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр
Object
WithdrawalDev
1
регистраторов
iceFilter
выбытия
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Структура данных WithdrawalDeviceFilter
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
device_id
Идентификато
String
DeviceID
0
р устройства
provision_start_
Дата
String
Date
0
date
предоставлени
я, начало
периода
фильтрации
provision_end_
Дата
String
Date
0
date
предоставлени
я, конец
периода
фильтрации
branch_id
Идентификато
String
BranchID
0
р места
деятельности
согласно
лицензии
placement_type
Тип
Number
{0,1,2}
•
0 - по
размещения
месту
использова
ния
•
1 - ЦОД
оператора
•
2 - по
адресу МД
417
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
status
Статус
Array of
{0,1,2,3,4}
0
•
0 - не
Numbers
введен в
эксплуатац
ию
•
1 - не
готов
к
передаче
сведений
•
2 - готов к
передаче
сведений
•
3 - выведе
н
из
эксплуатац
ии
•
4 - отказ
от
получения
device_vendor
Производитель
String
0
устройства
device_model
Модель
String
0
устройства
activation_start
Начало
String
Date
0
_date
временного
диапазона для
даты
активации РВ
activation_end_
Конец
String
Date
0
date
временного
диапазона для
даты
активации РВ
update_responsi
Начало
String
Date
0
ble_start_date
временного
диапазона для
даты
обновления
контакта,
ответственног
о за РВ
418
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
update_responsi
Конец
String
Date
0
ble_end_date
временного
диапазона для
даты
обновления
контакта,
ответственног
о за РВ
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
entries
Записи из
Array of
WithdrawalDev
1
реестра
Objects
iceInfoEntry
Формат объекта WithdrawalDeviceInfoEntry:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
device_id
Идентификато
String
DeviceID
р устройства
serial_number
Серийный
String
(индивидуальн
ый) номер
устройства
device_name
Наименование
String
(модель)
устройства
branch_id
Идентификато
String
BranchID
р места
деятельности
согласно
лицензии
provision_date
Дата
String
Date
предоставлени
я
419
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
contract_info
Информация о
Object
DeviceContract
договоре
InfoEntry
placement_type
Тип
Number
{0,1,2}
•
0 - по
размещения
месту
использова
ния
•
1 - ЦОД
оператора
•
2 - по
адресу МД
status
Статус
Number
{0,1,2,3,4}
0
•
0 - не
введен в
эксплуатац
ию
•
1 - не
готов
к
передаче
сведений
•
2 - готов к
передаче
сведений
•
3 - выведе
н
из
эксплуатац
ии
•
4 - отказ
от
получения
device_vendor
Производитель
String
устройства
device_model
Модель
String
устройства
activation_date
Дата
String
Date
активации РВ
420
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
responsible_per
Контакты
String
son_contacts
сотрудника,
ответственног
о за получение
РВ и его
эксплуатацию
update_responsi
Дата
String
Date
ble_date
обновления
контакта,
ответственног
о за РВ
branch_house_
Код ФИАС
String
guid
МД
branch_address
Адрес МД
String
Пример использования метода
Запрос:
POST api/v1/reestr/registration-devices/withdrawal/filter HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {
"device_id": "0000000099990033",
"provision_start_date": "2019-04-07",
"provision_end_date": "2019-05-08",
"placement_type": 1,
"device_vendor": "ЦРПТ",
"device_model": "1.0"
},
"start_from": 0,
"count": 10
}
Получение результата:
421
{
"total": 1,
"entries": [
{
"device_id": "0000000099990033",
"serial_number": "76EA00000077",
"device_name": "ASUS A620A",
"branch_id": "00000000000464",
"provision_date": "2019-04-10",
"contract_info": {
"doc_num": "ABC12345",
"doc_date": "2019-04-10"
},
"status": 0,
"placement_type": 1,
"device_vendor": "ЦРПТ",
"device_model": "1.0",
"activation_date": "2019-04-10",
"responsible_person_contacts": "+79999999999, Ivan",
"update_responsible_date": "2019-04-10",
"branch_house_guid": "31ce8785-05b2-4bb5-9033-28bb9319411b",
"branch_address": "обл Воронежская р-н Борисоглебский г Борисоглебск ул
Авиационная"
}
]
}
8.12. Получение информации из реестра решений о
приостановке КИЗ
8.12.1. Фильтрация по реестру решений о приостановке КИЗ
Endpoint: POST <endpoint>/<version>/reestr/paused-circulation-decisions/filter
Необходимые
права
доступа
(любое
из):
REESTR_ALL,
REESTR_PAUSED_CIRCULATION_DECISION
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
422
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр
Object
PausedCirculati
1
реестра
onDecisionFilte
решений о
r
приостановке
ЛП
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Структура данных PausedCirculationDecisionFilter
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
inn
ИНН
String
0
участника
halt_type
Тип решения
Number
{0,1}
0
•
0 - времен
ный вывод
из
обращения
•
1 - отмена
временног
о вывода
из
обращения
halt_doc_num
Номер
String
0
решения
halt_id
Идентификато
UUID
0
р решения
batch
Номер
String
BatchNumber
0
производствен
ной серии
gtin
GTIN
String
GTIN
0
start_halt_doc_
Дата решения,
String
Date
0
date
начало
периода
фильтрации
423
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
end_halt_doc_d
Дата решения,
String
Date
0
ate
конец периода
фильтрации
start_halt_date
Дата
String
Date
0
вступления в
силу, начало
периода
фильтрации
end_halt_date
Дата
String
Date
0
вступления в
силу, конец
периода
фильтрации
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
entries
Записи из
Array of
PausedCirculati
1
реестра
Objects
onDecision
Формат объекта PausedCirculationDecision:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin_count
Количество
Number
0
SGTIN
gtin
GTIN
String
GTIN
0
inn
ИНН
String
0
участника
org_name
Наименование
String
0
организации
424
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
halt_doc_date
Дата решения
String
DateTime
0
halt_date
Дата
String
DateTime
0
вступления в
силу
op_date
Дата
String
DateTime
0
приостановки/
отмены
приостановки
SGTIN
batch
Номер
String
BatchNumber
0
производствен
ной серии
halt_doc_num
Номер
String
0
решения
halt_id
Идентификато
UUID
1
р решения
halt_type
Тип решения
Number
{0,1}
0
•
0 - времен
ный вывод
из
обращения
•
1 - отмена
временног
о вывода
из
обращения
owner_address
Адрес места
UUID
0
(Устарел)
деятельности
(ГАР/ФИАС)
reg_date
Дата РУ
String
DateTime
0
reg_num
Номер РУ
String
0
Пример использования метода
Запрос:
425
POST api/v1/reestr/paused-circulation-decisions/filter HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"filter": {
"inn": "1234567890",
"halt_type": 1,
"halt_doc_num": "2019-W13-5-684000000",
"halt_id": "4d6c7c82-ae8e-4859-ac8f-39aca0e0c43f",
"batch": "core-201903291431-WA",
"gtin": "04607028393877",
"start_halt_doc_date": "2019-03-29",
"end_halt_doc_date": "2019-03-29",
"start_halt_date": "2019-03-29",
"end_halt_date": "2019-03-29"
},
"start_from": 0,
"count": 10
}
Получение результата:
{
"total": 1,
"entries": [
{
"inn": "1234567890",
"sgtin_count": 1,
"gtin": "04607028393877",
"halt_doc_num": "2019-W13-5-684000000",
"halt_doc_date": "2019-03-29T00:00:00Z",
"halt_date": "2019-03-29T00:00:00Z",
"op_date": "2019-03-29T11:31:10.684Z",
"batch": "core-201903291431-WA",
"halt_type": 1,
"halt_id": "4d6c7c82-ae8e-4859-ac8f-39aca0e0c43f",
"reg_num": "2019-W13-5-683000000",
"reg_date": "2019-03-29T00:00:00Z"
}
]
}
8.12.2. Получение перечня КИЗ по конкретному решению о приостановке
Endpoint:
POST
<endpoint>/<version>/reestr/paused-circulation-
decisions/{halt_id}/sgtins/filter
426
Необходимые
права
доступа
(любое
из):
REESTR_ALL,
REESTR_PAUSED_CIRCULATION_DECISION
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
entries
Записи из
Array of
PausedCirculati
1
реестра
Objects
onSgtin
Формат объекта PausedCirculationSgtin:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
sgtin
SGTIN
String
SGTIN
1
gtin
GTIN
String
GTIN
0
batch
Номер
String
BatchNumber
0
производствен
ной серии
owner_id
Идентификато
String
SysID или
0
р текущего
BranchID
владельца
427
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
address
Местонахожде
String
0
ние - адрес
federal_subject
Местонахожде
String
0
_code
ние - код
субъекта РФ
owner_inn
ИНН текущего
String
0
владельца
owner_name
Текущий
String
0
владелец
product_sell_na
Торговое
String
0
me
наименование
лекарственног
о препарата
product_name
МНН
String
0
Пример использования метода
Запрос:
POST api/v1/reestr/paused-circulation-decisions/4d6c7c82-ae8e-4859-ac8f-
39aca0e0c43f/sgtins/filter HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"start_from": 0,
"count": 10
}
Получение результата:
428
{
"total": 1,
"entries": [
{
"sgtin": "04607028393877AUTOO9iXOvwFD",
"gtin": "18901148005836",
"batch": "f33e2ba5-a",
"owner_id": "00000000000238",
"product_sell_name": "Найз",
"product_name": "НИМЕСУЛИД",
"address": "Брянская обл, р-н Карачевский, г Карачев, ул Пушкина, Дом 99",
"federal_subject_code": "32",
"owner_inn": "3214000532",
"owner_name": "ГОСУДАРСТВЕННОЕ УЧРЕЖДЕНИЕ ЗДРАВООХРАНЕНИЯ \"ЦЕНТРАЛЬНАЯ
РАЙОННАЯ БОЛЬНИЦА\""
}
]
}
8.13. Получение информации из реестра решений о вводе
лекарственных препаратов в гражданский оборот
8.13.1. Фильтрация по реестру решений о вводе лекарственных препаратов в
гражданский оборот
Endpoint: POST <endpoint>/<version>/reestr/lp-in-circulation-decisions/filter
Необходимые
права
доступа
(любое
из):
REESTR_ALL,
VIEW_LP_IN_CIRCULATION_DECISIONS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Метод возвращает информацию по всем решениям о вводе ЛП в гражданский оборот.
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр
Object
LpInCirculation
1
реестра о
DecisionFilter
вводе
лекарственных
препаратов в
гражданский
оборот
429
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Структура данных LpInCirculationDecisionFilter
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
batch
Номер серии
String
BatchNumber
0
gtin
Идентификаци
String
GTIN
0
онный номер
товара (GTIN)
rzn_reg_num
Идентификато
String
0
р записи РЗН
(Номер
решения на
ввод в оборот)
decision_num
Номер
String
0
разрешения на
ввод в оборот
(обязателен
для
иммунобиолог
ических ЛП)
start_date
Начало
String
DateTime
0
временного
диапазона для
даты записи
АИС РЗН
end_date
Конец
String
DateTime
0
временного
диапазона для
даты записи
АИС РЗН
430
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
start_op_exec_
Начало
String
DateTime
0
date
временного
диапазона для
даты
фактической
регистрации в
системе
МДЛП
end_op_exec_d
Конец
String
DateTime
0
ate
временного
диапазона для
даты
фактической
регистрации в
системе
МДЛП
inn
ИНН
String
INNFL/INNUL
0
Фильтр только
организации,
по полному
которая
совпадению
осуществила
ввод ЛП в
гражданский
оборот
prod_sell_name
Торговое
String
0
наименование
reg_num
Номер
String
0
регистрационн
ого
удостоверения
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
entries
Записи из
Array of
LpInCirculation
1
реестра
Objects
DecisionEntry
431
Формат объекта LpInCirculationDecisionEntry:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
batch
Серия (Номер
String
BatchNumber
1
производствен
ной серии)
gtin
gtin
String
GTIN
1
batch_capacity
Размер серии
Number
1
(Количество
SGTIN в
серии)
rzn_reg_num
Идентификато
String
0
р записи РЗН
(Номер
решения на
ввод в оборот)
decision_num
Номер
String
0
разрешения на
ввод в оборот
(обязателен
для
иммунобиолог
ических ЛП)
date
Дата записи
String
DateTime
1
АИС РЗН
op_exec_date
Дата
String
DateTime
1
фактической
регистрации в
системе
МДЛП
in_circulation_c
Количество
Number
1
ount
введенных
SGTIN в серии
status
Статус
Number
{0,1}
1
•
0
--
решения
осталось
свободное
место под
выпуск
•
1
--
полностью
выполнен
432
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
inn
ИНН
String
0
организации,
которая
осуществила
ввод ЛП в
гражданский
оборот
prod_sell_name
Торговое
String
1
наименование
reg_num
Номер
String
0
регистрационн
ого
удостоверения
Пример использования метода
Запрос:
POST api/v1/reestr/lp-in-circulation-decisions/filter HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"start_from": 0,
"count": 100,
"filter": {
"start_date": "2000-10-10T00:00:00Z",
"end_date": "2000-10-11T00:00:00Z",
"prod_sell_name": "Ванкомицин Эльфа",
"reg_num": "ЛП-003862"
}
}
Получение результата:
433
{
"total":14,
"entries":[
{
"batch":"VA-2003",
"gtin":"04607037191174",
"batch_capacity":25005,
"rzn_reg_num":"2793022",
"date":"2020-06-25T00:00:00Z",
"op_exec_date":"2020-06-26T21:00:55.92Z",
"in_circulation_count":0,
"status":0,
"inn":"7709203010",
"count_rzn_reg_nums":0,
"prod_sell_name":"Ванкомицин Эльфа",
"reg_num":"ЛП-003862"
},
{
"batch":"VA-2004",
"gtin":"04607037191174",
"batch_capacity":25200,
"rzn_reg_num":"2793026",
"date":"2020-06-25T00:00:00Z",
"op_exec_date":"2020-06-26T21:00:55.921Z",
"in_circulation_count":0,
"status":0,
"inn":"7709203010",
"count_rzn_reg_nums":0,
"prod_sell_name":"Ванкомицин Эльфа",
"reg_num":"ЛП-003862"
}
]
}
8.14. Получение информации из реестра производственных
серий
8.14.1. Получение сводной информации распределения ЛП (временно
приостановлен)
Метод возвращает информацию по распределению ЛП по МД, МОХ или участнику в разрезе
статуса и места получения этого статуса.
Endpoint: POST <endpoint>/<version>/reestr/batches/short-distribution
Необходимые права доступа (любое из): REESTR_ALL, VIEW_BATCH_GRAF
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
434
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
GTIN
String
GTIN
1
batches
Номер
Array of Strings
BATCH
1
На данный
производствен
момент
ной серии
возможно
запрашивать
информацию
только по
одной серии
(ограничения
текущей
реализации)
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
entries
Записи из
Array of
ShortDistributio
1
реестра
Objects
n
Формат объекта ShortDistribution:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
GTIN
String
GTIN
1
batches
Информация о
Array of
BatchInfo
1
производствен
Objects
ных сериях
Формат объекта BatchInfo:
435
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
batch
Номер
String
BATCH
1
производствен
ной серии
registration_dat
Дата
String
DateTime
1
e
регистрации
производствен
ной серии
size
Количество
Number
1
кодов
маркировки в
производствен
ной серии
statuses
Информация
Array of
BatchStatusInfo
1
по статусам
Objects
кодов
маркировки в
производствен
ной серии
Формат объекта BatchStatusInfo:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
status
Статус кодов
String
BatchStatus
1
См. Статусы
маркировки в
кодов
производствен
маркировки в
ной серии
производствен
ной серии
organization_na
Наименование
String
1
me
организации
address
Адрес
String
0
МД/МОХ
total_income
Всего пришло
Number
1
total_outcome
Всего ушло
Number
1
balance
Баланс
Number
1
sgtin_amount
Количество
Number
1
кодов
маркировки в
данном
статусе
436
Пример использования метода
Запрос:
POST api/v1/reestr/batches/short-distribution HTTP/1.1
Host: api.sb.mdlp.crpt.ru
Accept: application/json
Content-Type: application/json
Authorization: token 13b5b046-0cd7-4e1c-8409-da9541986d1c
{
"gtin": "04620032570010",
"batches": [
"070919017"
]
}
Получение результата:
437
{
"gtin": "04620032570010",
"batches": [
{
"batch": "070919017",
"registration_date": "2020-02-26T14:29:18",
"size": 20,
"statuses": [
{
"status": "IMPORT",
"organization_name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ
\"ВИНЕГРЕТ\"",
"address": "г Санкт-Петербург, пр-кт Космонавтов, Дом 15, Литера А",
"total_income": 20,
"total_outcome": 10,
"balance": 10,
"sgtin_amount": 10
},
{
"status": "OTHER",
"organization_name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ
\"ВИНЕГРЕТ\"",
"address": "г Санкт-Петербург, пр-кт Космонавтов, Дом 15, Литера А",
"total_income": 20,
"total_outcome": 10,
"balance": 10,
"sgtin_amount": 10
},
{
"status": "PRODUCTION",
"organization_name": "Д-р Редди'с Лабораторис Лтд.",
"total_income": 20,
"total_outcome": 20,
"balance": 0,
"sgtin_amount": 20
}
]
}
]
}
8.15. Получение информации из реестра деклараций
(импортные ЛП)
8.15.1. Фильтрация по реестру деклараций (импортные ЛП)
Endpoint: POST <endpoint>/<version>/reestr/declarations/filter
Необходимые
права
доступа
(любое
из):
REESTR_ALL,
438
VIEW_LP_IN_CIRCULATION_DECISIONS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Метод возвращает информацию по всем декларациям (импортные ЛП).
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр
Object
DeclarationsFilt
1
реестра
er
партий,
ввозимых из
ЕАЭС
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Формат объекта DeclarationsFilter:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
Код товара
String
GTIN
0
(GTIN)
batch
Производствен
String
0
ная серия
declaration_nu
Номер
String
0
m
декларации
start_op_exec_
Начало
String
Datetime
0
date
временного
диапазона для
даты
обработки
декларации
системой
439
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
end_op_exec_d
Конец
String
Datetime
0
ate
временного
диапазона для
даты
обработки
декларации
системой
prod_sell_name
Торговое
String
0
наименование
reg_num
Номер
String
0
регистрационн
ого
удостоверения
inn
ИНН
String
0
владельца
start_date
Начало
String
Date
0
временного
диапазона для
даты записи в
АИС РЗН о
вводе в оборот
end_date
Конец
String
Date
0
временного
диапазона для
даты записи в
АИС РЗН о
вводе в оборот
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
entries
Записи из
Array of
DeclarationsEnt
1
реестра
Objects
ry
Формат объекта DeclarationsEntry:
440
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
Код товара
String
GTIN
1
(GTIN)
batch
Производствен
String
1
ная серия
declaration_nu
Номер
String
0
m
декларации
op_date
Дата из
String
Datetime
1
документа
op_exec_date
Дата
String
Datetime
1
обработки
rzn_reg_num
Идентификато
String
0
р записи РЗН
declaration_cap
Доступное к
Number
1
acity
вводу
количество в
рамках
декларации
owner_ssid
Идентификато
String
SysID или
0
р владельца
BranchID
партии
prod_sell_name
Торговое
String
1
наименование
reg_num
Номер
String
0
регистрационн
ого
удостоверения
org_name
Наименование
String
0
владельца
document_ids
Идентификато
Object
0
р документа,
по которому
прошли
данные по
декларации
при
оформлении
441
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
count
Количество
Number
0
успешно
обработанных
SGTIN в
рамках данной
декларации
in_circulation_c
Количество
Number
1
ount
SGTIN,
введенных в
оборот
decision_num
Номер
String
0
разрешения на
ввод в оборот
для
имуннобиолог
ических ЛП
inn
ИНН
String
0
владельца
date
Дата записи в
String
Datetime
0
АИС РЗН о
вводе в оборот
Пример использования метода
Запрос:
442
POST /api/v1/reestr/declarations/filter
Host: api.sb.mdlp.crpt.ru
Authorization: token 171edb41-02c4-4002-92f7-ca0c1d8b588a
Content-Type: application/json
{
"start_from":0,
"count":20,
"filter":{
"gtin":"04607143560567",
"batch":"core202301201119F1DU",
"declaration_num":"87654321/200123/6925461",
"start_op_exec_date":"2023-01-19T00:00:00Z",
"end_op_exec_date":"2023-01-20T00:00:00Z",
"prod_sell_name":"Кардиостатин",
"reg_num":"Р N002573/01",
"inn":"7715967832",
"start_date":"2023-01-19",
"end_date":"2023-01-20"
}
}
Получение результата:
443
{
"total":1,
"entries":[
{
"gtin":"04607143560567",
"batch":"core202301201119F1DU",
"declaration_num":"87654321/200123/6925461",
"op_date":"2023-01-20T08:19:40.737Z",
"op_exec_date":"2023-01-20T08:19:40.796Z",
"rzn_reg_num":"2788046",
"declaration_capacity":2,
"owner_ssid":"3f9c9999-c7f2-4c88-9aef-6c863ffabf43",
"reg_num":"Р N002573/01",
"prod_sell_name":"Кардиостатин",
"org_name":"ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ ТОПЛИВНАЯ КОМПАНИЯ
ЛЕГИОН",
"document_ids":[
"f3a8fc08-ec97-4ec9-b46a-a713a7effc01"
],
"count":2,
"in_circulation_count":2,
"decision_num":"1997797",
"inn":"7715967832",
"date":"2023-01-20T00:00:00Z"
}
]
}
8.16. Получение информации из реестра партий, ввозимых
из ЕАЭС
8.16.1. Фильтрация по реестру партий, ввозимых из ЕАЭС
Endpoint: POST <endpoint>/<version>/reestr/consignments/filter
Необходимые
права
доступа
(любое
из):
REESTR_ALL,
VIEW_LP_IN_CIRCULATION_DECISIONS
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Метод возвращает информацию по всем партиям, ввозимым из ЕАЭС.
Параметры метода
Входной информацией являются следующие данные:
444
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filter
Фильтр
Object
ConsignmentsF
1
реестра
ilter
партий,
ввозимых из
ЕАЭС
start_from
Индекс первой
Number
1
записи
count
Максимальное
Number
1
количество
записей
Формат объекта ConsignmentsFilter:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
Код товара
String
GTIN
0
(GTIN)
batch
Производствен
String
0
ная серия
doc_num
Номер партии
String
0
start_doc_date
Начало
String
Date
0
временного
диапазона для
даты партии
end_doc_date
Конец
String
Date
0
временного
диапазона для
даты партии
start_op_exec_
Начало
String
Datetime
0
date
временного
диапазона для
даты
последней
операции
end_op_exec_d
Конец
String
Datetime
0
ate
временного
диапазона для
даты
последней
операции
445
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
prod_sell_name
Торговое
String
0
наименование
reg_num
Номер
String
0
регистрационн
ого
удостоверения
inn
ИНН
String
0
владельца
start_date
Начало
String
Date
0
временного
диапазона для
даты записи в
АИС РЗН о
вводе в оборот
end_date
Конец
String
Date
0
временного
диапазона для
даты записи в
АИС РЗН о
вводе в оборот
Выходная информация
Выходная информация содержит следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total
Общее
Number
1
количество
записей по
запросу
entries
Записи из
Array of
ConsignmentsE
1
реестра
Objects
ntry
Формат объекта ConsignmentsEntry:
446
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
gtin
Код товара
String
GTIN
1
(GTIN)
batch
Производствен
String
1
ная серия
doc_date
Дата партии
String
DateTime
0
doc_num
Номер партии
String
0
count
Количество
Number
0
введенных
SGTIN в
партии
document_ids
Идентификато
Object
GUID
0
р документа
отгрузки /
ввоза ЛП из
ЕАЭС
op_exec_date
Дата
String
Datetime
1
обработки
операции
owner_ssid
Идентификато
String
SysID или
0
р владельца
BranchID
партии
prod_sell_name
Торговое
String
1
наименование
reg_num
Номер
String
0
регистрационн
ого
удостоверения
org_name
Наименование
String
0
владельца
op_date
Дата из
String
Datetime
1
документа
rzn_reg_num
Идентификато
String
0
р записи РЗН
consignment_ca
Доступное к
Number
1
pacity
вводу
количество в
рамках партии
447
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
auto_to_in_circ
Статус
Number
0
Возможные
ulation_status
автоматическо
значения:
го ввода в ГО
0 - введён
автоматически
;
1 - GTIN не
подлежит
авто-вводу;
2 - автоввод
не выполнен;
3 - автоввод
выполнен
частично;
4 - ожидает
автоввод по
расписанию -
только если
тип эмиссии
"Контрактное
производство"
(emission_type
= 2)
in_circulation_c
Количество
Number
1
ount
SGTIN,
введенных в
оборот
decision_num
Номер
String
0
разрешения на
ввод в оборот
для
имуннобиолог
ических ЛП
rzn_response_i
Идентификато
String
0
d
р ответа РЗН
inn
ИНН
String
0
владельца
date
Дата записи в
String
Datetime
0
АИС РЗН о
вводе в оборот
Пример использования метода
Запрос:
448
POST /api/v1/reestr/consignments/filter
Host: api.sb.mdlp.crpt.ru
Authorization: token 7de5ccdb-c3be-47b7-8872-d7d1e17f6939
Content-Type: application/json
{
"start_from":0,
"count":20,
"filter":{
"gtin":"04607143560567",
"batch":"core2022120911324p7K",
"doc_num":"2022-W49-5-339391000",
"start_doc_date":"2023-01-19",
"end_doc_date":"2024-01-19",
"start_op_exec_date":"2022-11-19T00:00:00Z",
"end_op_exec_date":"2022-12-20T00:00:00Z",
"prod_sell_name":"Кардиостатин",
"inn":"7715967832",
"start_date":"2022-11-19",
"end_date":"2022-12-20"
}
}
Получение результата:
449
{
"total":1,
"entries":[
{
"gtin":"04607143560567",
"batch":"core2022120911324p7K",
"doc_date":"2022-12-09T00:00:00Z",
"doc_num":"2022-W49-5-339391000",
"count":2,
"document_ids":[
"610f567b-d040-4250-943d-bdb6eec137a9"
],
"op_exec_date":"2022-12-09T08:32:31.793Z",
"owner_ssid":"00000000000456",
"prod_sell_name":"Кардиостатин",
"reg_num":"Р N002573/01",
"org_name":"ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ ТОПЛИВНАЯ КОМПАНИЯ
ЛЕГИОН",
"op_date":"2022-12-09T08:32:31.744Z",
"rzn_reg_num":"6395287",
"consignment_capacity":2,
"auto_to_in_circulation_status":0,
"in_circulation_count":2,
"decision_num":"9863800",
"rzn_response_id":"84bfa634-e29b-47dc-814d-7f49725637d9",
"inn":"7715967832",
"date":"2022-12-09T00:00:00Z"
}
]
}
450
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:
451
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
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
452
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
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
453
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
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
пациентов и
инструкция по
утилизации
454
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
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
сти при
уничтожении
неиспользованн
ых ЛП
455
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
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
456
Имя реквизита
Описание
Тип
Ограничени
Кардина
Примечания
в формате
реквизита
данных
я
льность
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":"Организация для претензий"
}
457
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
контейнера
458
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
FormData
FormDa
ta
package_images
Файлы
File
0
См. Требования к
изображений
изображениям
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
459
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
• параметры строки запроса (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 для данного
контейнера будет
удалена
Выходная информация
460
При успешном выполнении клиент получает ответ с кодом 200 и пустым телом.
Пример использования метода
Запрос:
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
Получение результата:
461
Файл 343e284f-6669-4c4b-ab23-659ca5105c87.zip
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
записей
462
Формат объекта ContainerResult:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
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
которой
контейнер не
прошел
модерацию
Пример использования метода
Запрос:
463
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":{
}
}
Получение результата:
{
"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
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Параметры метода
Входной информацией являются следующие данные:
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
JSON
JSON
containers
Идентификатор
Array of
UUID
1
ы контейнеров
String
464
Выходная информация
При успешном выполнении клиент получает ответ с кодом 200 и пустым телом.
Пример использования метода
Запрос:
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
{
"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
контейнера
465
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
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 - связь не
сериями
устанавливается
автоматически
Пример использования метода
Запрос:
466
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
которой
устанавливается
связь с
контейнером
467
Имя реквизита
Описание
Тип
Ограничения
Кардина
Примечания
в формате
реквизита
данных
льность
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"
}
468
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
469
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
filters
Параметры
Object
1
Формат
фильтрации
зависит от
данных
типа задачи.
См.
Параметры
фильтрации и
описание
доступных
полей для
выгрузок
данных
fields
Набор полей,
Array of Strings
0*
Если
которые
отсутствует
должны
или передан
присутствоват
пустой массив,
ь в выгрузке
в
выгрузке
будут
присутствоват
ь
все
возможные
поля.
Набор полей
зависит
от
типа задачи.
См.
Параметры
фильтрации и
описание
доступных
полей
для
выгрузок
данных
* - Игнорируется для выгрузок:
• Выгрузка детализированной информации по движению ЛП
• Выгрузка иерархии по SGTIN
• Выгрузка общедоступной информации по SGTIN
Выходная информация
По результатам выполнения клиент получает следующую информацию:
470
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
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}
471
Необходимые права доступа: 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
Получение результата:
472
{
"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\": [\"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
473
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
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
474
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
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
задачи, начало
временного
промежутка
475
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
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
ошибки
Пример использования метода
Запрос:
476
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
{
"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
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
477
Параметры метода
Входной информацией являются следующие данные:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
task_id
Идентификато
String
UUID
1
Параметр пути
р задачи
(path param)
Выходная информация
По результатам успешного выполнения метода клиент получает zip-архив со следующим
содержимым:
Для задач с типом remaining_medicines, medicine_disposal, remaining_medicines_branches,
pricing_report, lp_movement_circulation, import_movement, 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
ошибки
Пример использования метода
Запрос:
478
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
Получение результата:
Файл 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)
Выходная информация
В случае успешного выполнения метода клиент получает ответ с пустым телом, в случае
возникновения ошибки, следующую информацию:
479
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
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)
480
Выходная информация
В случае успешного выполнения метода клиент получает ответ с пустым телом, в случае
возникновения ошибки, следующую информацию:
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
error_code
Код ошибки
String
1
См. Список
возможных
кодов ошибок
error_descriptio
Описание
String
1
n
ошибки
Пример использования метода
Запрос:
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
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
Выходная информация
По результатам выполнения клиент получает следующую информацию:
481
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
max_task_coun
Ограничение,
Number
1
t_per_user
количества
задач на
пользователя
max_task_coun
Ограничение
Number
1
t_per_member
количества
задач на
организацию
Пример использования метода
Запрос:
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. Список возможных кодов ошибок
Таблица 67. Список возможных кодов ошибок
Код
Описание
TASKS_NOT_COMPLETED
Задача не завершена
TASK_NOT_FOUND
Задача не найдена
USER_TASKS_LIMIT_EXCEEDED
Достигнут лимит задач на пользователя
MEMBER_TASKS_LIMIT_EXCEEDED
Достигнут лимит задач на организацию
INVALID_TASK_FIELDS
Запрошены не существующие поля выгрузки
NOT_ENOUGH_RIGHTS
Недостаточно прав для создания задачи на
выгрузку
ZIP_ENTRY_NOT_FOUND
Файл с указанным именем не найден в архиве
482
Код
Описание
ZIP_ENTRY_TOO_LARGE
Указанный файл имеет слишком большой
размер
UNSUPPORTED_EXPORT_TYPE
Неподдерживаемый тип выгрузки
INVALID_FILTER_PARAMETERS
По указанным параметрам не найдено данных
10.9. Параметры фильтрации и описание доступных полей
для выгрузок данных
10.9.1. Выгрузка детализированной информации по движению ЛП (временно
приостановлен)
Тип задачи: detail_batch_movements (Временно приостановлен)
Необходимые права доступа: VIEW_BATCH_GRAF
Интервал между вызовами метода см. в разделе Общие требования по использованию методов.
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
марка
483
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
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
КМ серии в
обороте
items
Элементы
Array of
1
Массив
распределения
Objects
элементов МД
КМ
и МОХ между,
которыми
распределены
КМ в рамках
серии,
на
момент
получения
выгрузки.
Формат элемента массива items.
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total_income
Приход
Number
1
Количество
КМ, которые
поступили на
МД или МОХ,
в рамках
серии.
484
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
total_outcome
Выбытие
Number
1
Количество
КМ, которые
выбыли с МД
или МОХ, в
рамках серии.
production
Производство
Number
1
Статус
"производство
". Отображает
количество
КМ,
произведенны
х на данном
МД или SSID
(для
зарубежного
производства).
import
Импорт
Number
1
Статус
"импорт".
Отображает
количество
КМ, которые
поступили
через импорт
на данное МД
485
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
wholesale
Оптовая
Number
1
Статус
продажа
"оптовая
продажа".
Отображает
количество
КМ, которые
были
выведены с
данного МД
или МОХ,
через оптовую
продажу. При
увеличении
статуса
"оптовая
продажа"
увеличивается
показатель
"Выбытие" для
текущего МД
и МОХ. Также
увеличивается
статус
"Закупка в
РФ", для МД
или МОХ,
который
совершил
покупку КМ.
486
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
purchase_in_ru
Закупка в РФ
Number
1
Статус
ssia
"Закупка в
РФ".
Отображает
количество
КМ, которые
были введены
на МД или
МОХ, через
закупку КМ.
Данный статус
следует после
"оптовой
продажи". При
увеличении
статуса
"закупка в рф"
увеличивается
показатель
Приход для
текущего МД
или МОХ.
Также
увеличивается
статус
"Оптовая
продажа", для
МД или МОХ,
который
совершил
продажу КМ.
retail_sale
Розничная
Number
1
Конечный
продажа
статус для КМ
в серии.
Отображает
количество
КМ, которые
были
выведены из
оборота через
розничную
продажу (ККТ
и д.р)
487
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
discount_sale
Продажа со
Number
1
Конечный
скидкой
статус для КМ
в серии.
Отображает
количество
КМ, которые
были
выведены из
оборота через
розничную
продажу со
скидкой
(льготный
рецепт и д.р)
medical_use
Медицинское
Number
1
Конечный
использование
статус для КМ
в серии.
Отображает
количество
КМ, которые
были
выведены из
оборота через
медицинское
использование.
other
Другое
Number
1
Конечный
статус для КМ
в серии.
Отображает
количество
КМ, которые
были
выведены из
оборота
другими
способами
(выборка
образцов,
уничтожение и
т.д.)
488
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
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
489
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
children
Перемещения
Array of
0
Массив
Objects
объектов.
Содержит
сведения о МД
или МОХ, на
который были
перемещены
КМ с текущего
МД или МОХ.
Объекты
включают в
себя
информацию о
количестве
перемещенных
КМ и дате
совершения
операции.
Формат элемента массива children.
Имя
Описание
Тип данных
Ограничения
Кардинально
Примечания
реквизита в
реквизита
JSON
сть
формате
JSON
warehouse_id
Идентификато
String
1
Идентификаци
р МД, МОХ
онный номер
или SSID
МД или МОХ
или
идентификатор
участника во
ФГИС МДЛП
(в случае
зарубежного
производства)
count
Количество
Number
1
Количество
КМ, которые
были
перемещены
на данное
МД/МОХ
op_date
Дата операции
String
MskDateTime
1
Дата операции
(UTC)
поступления
КМ на
МД/МОХ.
490
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)
упаковку
491

 

 

 

 

 

 

 

содержание      ..     4      5      6      7     ..