Получение позиций склада

Позволяет получить список позиций склада

Запрос

Адрес запроса

GET /api/hosts/{hostName}/storePositions

Параметры запроса

Параметр	Тип	Описание	По умолчанию	Обязательный	Комментарий
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	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 дополнительно устанавливает уровень доступа. Список значений: true - разрешено управлять остатками, false - только просмотр
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 для выбора позиций по типу ЛС, СП

filter: {
  "condition": "and",
  "rules": [
    {
      "field": "Nomenclature.Ntfr.Code",
      "fieldPath": [
        {
          "name": "Nomenclature",
          "label": "Номенклатура",
          "type": "entity",
          "entityType": "Nomenclature",
          "categories": null
        },
        {
          "name": "Ntfr",
          "label": "Товар фармакологического рынка",
          "type": "entity",
          "entityType": "Ntfr",
          "categories": null
        },
        {
          "name": "Code",
          "label": "Код",
          "type": "string",
          "entityType": null,
          "categories": null
        }
      ],
      "operator": "=",
      "value": "1"    # ЛС 
      # "value": "178"    # Спецпитание
    }
  ]
}

filter для выбора позиций по типу ИМН

filter: {
  "condition": "and",
  "rules": [
    {
      "field": "Nomenclature.Ntfr.Code",
      "fieldPath": [
        {
          "name": "Nomenclature",
          "label": "Номенклатура",
          "type": "entity",
          "entityType": "Nomenclature",
          "categories": null
        },
        {
          "name": "Ntfr",
          "label": "Товар фармакологического рынка",
          "type": "entity",
          "entityType": "Ntfr",
          "categories": null
        },
        {
          "name": "Code",
          "label": "Код",
          "type": "string",
          "entityType": null,
          "categories": null
        }
      ],
      "operator": "!=",
      "value": "178"  # не Спецпитание
    },
    {
      "field": "Nomenclature.Ntfr.Code",
      "fieldPath": [
        {
          "name": "Nomenclature",
          "label": "Номенклатура",
          "type": "entity",
          "entityType": "Nomenclature",
          "categories": null
        },
        {
          "name": "Ntfr",
          "label": "Товар фармакологического рынка",
          "type": "entity",
          "entityType": "Ntfr",
          "categories": null
        },
        {
          "name": "Code",
          "label": "Код",
          "type": "string",
          "entityType": null,
          "categories": null
        }
      ],
      "operator": "!=",
      "value": "1"  # не ЛС
    }
  ]
}

Ответ сервера

В случае успешного выполнения сервер вернет ответ 200 в формате JSON со следующими данными:

Модель: Позиция склада - storePositions

Возможные ошибки

Код ответа сервера	Сообщение	Тип ошибки
500	Возникла ошибка сервера	Error
401	Ошибка авторизации	Error
404	Неправильный запрос с клиента на сервер	Validation

Дерево страниц