...
Параметры запроса
Параметр | Тип | Описание | По умолчанию | Обязательный | Комментарий |
---|---|---|---|---|---|
hostName | path | Хост аптеки | - | + | |
organizationId | query | Идентификатор организации | - |
- | |||||
nomenclatureName | query | Наименование номенклатуры | - | - | |
nomenclatureId | query | Идентификатор номенклатуры | - | - |
nomenclatureCode | query |
Код номенклатуры | - | - |
nomenclatureNameOrCode | query | Код или наименование номенклатуры | - | - |
storeId | query |
Идентификатор склада | - | - |
financeSourceId | query | Идентификатор |
источника финансирования | - | - |
financeSourceName | query |
Наименование источника финансирования | - | - |
tenderId | query |
Идентификатор контракта | - | - |
tenderNum | query | Номер |
контракта | - | - |
storeName | query |
Наименование склада | - | - |
providerId | query |
Идентификатор поставщика | - | - |
...
providerName |
Ответ сервера
В случае успешного выполнения сервер вернет ответ 200 в формате JSON со следующими данными:
Модель: ???
Возможные ошибки
...
query | Наименование поставщика | - | - | ||
tenderTypeId | query | Идентификатор программы финансирования | - | - | |
tenderTypeName | query | Наименование программы финансирования | - | - | |
seriesExpirationDateLessThan | query | Срок годности серии меньше чем | - | - | |
billDocumentId | query | Идентификатор приходной накладной | - | - | |
billDocumentNum | query | Номер приходной накладной | - | - | |
seriesId | query | Идентификатор серии | - | - | |
seriesExpirationDateMoreThan | query | Срок годности серии больше чем | - | - | |
seriesNum | query | Номер серии | - | - | |
countMoreThan | query | Количество больше чем | - | - | |
restCountMoreThan | query | Оставшееся количество больше чем | - | - | |
price | query | Цена | - | - | |
inDateMoreThan | query | На дату больше чем | - | - | |
inDateLessThan | query | На дату меньше чем | - | - | |
mnnId | query | Идентификатор МНН | - | - | |
trnId | query | Идентификатор торгового наименования | - | - | |
lfId | query | Лекарственная форма | - | - | |
accessUserId | query | Идентификатор пользователя для фильтрации складов, которые пользователь видит | - | - | |
nomenclaturePriceByTenderId | query | Идентификатор цены номенклатуры по контракту | - | - | |
productDetailId | query | Идентификатор характеристики товара | - | - | |
productDetailName | query | Наименование характеристики товара | - | - | |
pkuGroupId | query | Идентификатор группы ПКУ | - | - | |
materialGroupGuid | query | Идентификатор группы материалов | - | - | |
departmentCode | query | Код отделения | - | - | |
accessUserManage | query | Доступность управления остатками на складе | - | - | При заданном параметре accessUserId дополнительно устанавливает уровень доступа. Список значений:
|
filterId | query | Идентификатор фильтра | - | - | |
filterParams | query | Параметры фильтрации (массив) | - | - | Массив параметров отбора (примеры ниже) |
filter | query | Объект фильтрации в json | - | - | (примеры ниже) |
priceMoreThan | query | Цена больше чем | - | - | |
priceLessThan | query | Цена меньше чем | - | - | |
manageUserId | query | Идентификатор пользователя для фильтрации складов, на которых пользователь может управлять остатками (поступление, списание) | - | - | |
pageIndex | query | Номер страницы пагинации | - | - | |
pageSize | query | Количество записей на странице | - | - | |
sortBy | query | Сортировка | - | - | |
fields | query | Массив полей для фильтрации | - | - |
Заголовки запроса
Заголовок | Значение (тип/формат значения) | Описание | Обязательный |
---|---|---|---|
Пример запроса
Без форматирования |
---|
{
"organizationId":345,
"hostName":AU2022,
"pageSize":10,
"pageIndex":0,
"sortBy":nomenclatureName,
"storeId":12,
"beginInDate":2022-02-17
} |
Примеры использования параметра filter для фильтрации выбора позиций с типами ЛС, СП и ИМН
Блок кода | ||||
---|---|---|---|---|
| ||||
filter: {
"condition": "and",
"rules": [
{
"field": "Nomenclature.Ntfr.Code",
"fieldPath": [
{
"name": "Nomenclature",
"label": "Номенклатура", |
...
Пример ответа
Без форматирования |
---|
{ "id": 0, "organizationId": 0, "date": "2023-06-13T18:55:07.613Z", "medicalCardNum": "string", "patientPolicySeries": "string", "patientPolicyNumber": "string", "patientSurname": "string", "patientName": "string", "patientPatronymic": "string", "patientBirthday": "2023-06-13T18:55:07.613Z", "store": { "id": 0, "name": "string", "subdivisionId": 0, "type": 0, "individualId": 0, "individual": { "id": 0, "name": "string", "surname": "string", "patronymic": "string", "organizationId": 0, "specialities": [ { "id": 0, "organizationId": 0, "name": "string" } ], "powerAttorneys": [ { "id": 0, "num": "string", "date": "2023-06-13T18:55:07.613Z", "note": "string", "individualId": 0, "individual": "string" } ] }, "departments": [ { "id": 0, "code": "string", "name": "string", "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "supervisorName": "string", "supervisorSurname": "string", "supervisorPatronymic": "string", "subdivisionId": 0, "subdivision": { "id": 0, "code": "string", "name": "string", "phone": "string", "address": "string", "subdivisionKindId": 0, "nsiOid": "string", "okatoCode": "string", "organization": { "id": 0, "code": "string", "name": "string", "ogrn": "string", "inn": "string", "nsiOid": "string", "okatoCode": "string" } } } ] }, "responsible": { "id": 0, "name": "string", "surname": "string", "patronymic": "string", "organizationId": 0, "specialities": [ { "id": 0, "organizationId": 0, "name": "string" } ], "powerAttorneys": [ { "id": 0, "num": "string", "date": "2023-06-13T18:55:07.613Z", "note": "string", "individualId": 0, "individual": "string" } ] }, "sum": 0, "baseSum": 0, "historyGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "positions": [ { "id": 0, "writeoffPurposeListId": 0, "writeoffDate": "2023-06-13T18:55:07.613Z", "storePosition": { "id": 0, "store": { "id": 0, "name": "string", "subdivisionId": 0, "type": 0, "individualId": 0, "individual": { "id": 0, "name": "string", "surname": "string", "patronymic": "string", "organizationId": 0, "specialities": [ { "id": 0, "organizationId": 0, "name": "string" } ], "powerAttorneys": [ { "id": 0, "num": "string", "date": "2023-06-13T18:55:07.613Z", "note": "string", "individualId": 0, "individual": "string" } ] }, "departments": [ { "id": 0, "code": "string", "name": "string", "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "supervisorName": "string", "supervisorSurname": "string", "supervisorPatronymic": "string", "subdivisionId": 0, "subdivision": { "id": 0, "code": "string", "name": "string", "phone": "string", "address": "string", "subdivisionKindId": 0, "nsiOid": "string", "okatoCode": "string", "organization": { "id": 0, "code": "string", "name": "string", "ogrn": "string", "inn": "string", "nsiOid": "string", "okatoCode": "string" } } } ] }, "nomenclature": { "id": 0, "code": "string", "name": "string", "lfCount": 0, "trnId": 0, "mnnId": 0, "pkuGroupId": 0, "pkuGroup": { "id": 0, "code": "string", "name": "string" }, "ntfrId": 0, "ntfr": { "id": 0, "code": "string", "name": "string" }, "klpNsiCode": "string", "nutritionNsiCode": "string", "medDeviceNsiKtruCode": "string" }, "series": { "id": 0, "num": "string", "expirationDate": "2023-06-13T18:55:07.613Z" }, "count": 0, "price": 0, "basePrice": 0, "restCount": 0, "sum": 0, "baseSum": 0, "restSum": 0, "restBaseSum": 0, "nds": { "id": 0, "code": "string", "percent": 0 }, "inDate": "2023-06-13T18:55:07.613Z", "inCount": 0, "reserveCount": 0, "billDocument": { "id": 0, "num": "string", "date": "2023-06-13T18:55:07.613Z" }, "provider": { "id": 0, "code": "string", "name": "string" }, "tender": { "id": 0, "num": "string", "date": "2023-06-13T18:55:07.613Z" }, "financeSource": { "idtype": 0"entity", "codeentityType": "stringNomenclature", "namecategories": "string"null }, "tenderType": { "idname": 0"Ntfr", "guidlabel": "3fa85f64-5717-4562-b3fc-2c963f66afa6Товар фармакологического рынка", "nametype": "string", "financeSourceId": 0entity", "financeSourceentityType": { "Ntfr", "idcategories": 0,null }, "code": "string", { "name": "stringCode", }"label": "Код", "organizationIdtype": 0"string", }, "tenderPositionDeliveryentityType": {null, "idcategories": 0,null } "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ], "beginDateoperator": "2023-06-13T18:55:07.613Z=", "endDatevalue": "2023-06-13T18:55:07.613Z", 1" # ЛС # "countvalue": 0, "178" # Спецпитание } ] } |
Блок кода | ||||
---|---|---|---|---|
| ||||
filter: { "condition": "and", "subdivisionrules": {[ { "idfield": 0"Nomenclature.Ntfr.Code", "fieldPath": [ "code": "string", { "name": "stringNomenclature", }"label": "Номенклатура", "tenderTypetype": {"entity", "identityType": 0"Nomenclature", "guidcategories": "3fa85f64-5717-4562-b3fc-2c963f66afa6",null }, "name": "string", { "financeSourceIdname": 0"Ntfr", "financeSourcelabel": { "Товар фармакологического рынка", "idtype": 0"entity", "codeentityType": "stringNtfr", "namecategories": "string"null }, }, { "organizationIdname": 0"Code", }"label": "Код", "inCounttype": 0"string", } "entityType": null, "storagePlacecategories": {null "id": 0, } ], "nameoperator": "string!=", "value": "178" # не Спецпитание "parentStoragePlaceId": 0}, { "parentStoragePlacefield": "stringNomenclature.Ntfr.Code", "childStoragePlacesfieldPath": [ "string" { ] "name": "Nomenclature", }"label": "Номенклатура", "productDetailstype": ["entity", { "entityType": "Nomenclature", "idcategories": 0,null }, "organizationId": 0, { "name": "stringNtfr", "parentIdlabel": 0 "Товар фармакологического рынка", "parenttype": {"entity", "identityType": 0"Ntfr", "namecategories": "string"null }, "childs": [ { "name": "stringCode", "label": "Код", ] }"type": "string", ] "entityType": null, "hasPackscategories": truenull }, "count": 0, } "measureCount": 0], "measureNameoperator": "string!=", "sumvalue": 0, "1" # "baseSum": 0,не ЛС "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ] }} ] } |
Ответ сервера
В случае успешного выполнения сервер вернет ответ 200 в формате JSON со следующими данными:
Модель: Позиция склада - storePositions
Возможные ошибки
Код ответа сервера | Код сообщения | Сообщение | Тип ошибки |
---|---|---|---|
500 | Возникла ошибка сервера | Error | |
401 | Ошибка авторизации | Error | |
404 | Неправильный запрос с клиента на сервер | Validation |