POST api/goods/ItemListPagingInfo

Получение списка кодов товаров, с входными фильтрами и пагинацией

Request Information

URI Parameters

None.

Body Parameters

ItemListPagingInfoRequest
NameDescriptionTypeAdditional information
Name

Входной фильтр: наименование списка товаров

string

None.

Active

Входной фильтр: активные списки

boolean

None.

NoActive

Входной фильтр: неактивные списки

boolean

None.

Exclude

Входной фильтр: признак "исключения из условий действия правила" на списке кодов товаров (для Create, Update)

boolean

None.

BegDate

Входной фильтр: начальная дата периода создания списка товаров

date

None.

EndDate

Входной фильтр: конечная дата периода создания списка товаров

date

None.

ItemList

Входной фильтр: идентификатор списка

integer

None.

Code

Входной фильтр: код товара, который находится в списках товаров

string

None.

CodeName

Входной фильтр: наименование товара, который находится в списках товаров

string

None.

Start

Пагинация: от какой записи возвращать данные, включая указанную

integer

None.

Length

Пагинация: количество записей, которые нужно вернуть

integer

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

Токен пользователя, который инициирует данный запрос

integer

None.

SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Active": true,
  "NoActive": true,
  "Exclude": true,
  "BegDate": "2024-06-20T05:41:39.4470194+03:00",
  "EndDate": "2024-06-20T05:41:39.4470194+03:00",
  "ItemList": 1,
  "Code": "sample string 2",
  "CodeName": "sample string 3",
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 4"
}

application/xml, text/xml

Sample:
<ItemListPagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.GoodsRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 4</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Active>true</Active>
  <BegDate>2024-06-20T05:41:39.4470194+03:00</BegDate>
  <Code>sample string 2</Code>
  <CodeName>sample string 3</CodeName>
  <EndDate>2024-06-20T05:41:39.4470194+03:00</EndDate>
  <Exclude>true</Exclude>
  <ItemList>1</ItemList>
  <Length>1</Length>
  <Name>sample string 1</Name>
  <NoActive>true</NoActive>
  <Start>1</Start>
</ItemListPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ItemListPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

Количество записей всего

integer

None.

TotalRowsSelect

Количество записей в запросе

integer

None.

Data

Массив кодов товаров

Collection of ItemListPagingInfoDataRow

None.

ErrorCode

Код ошибки

integer

None.

Message

Сообщение об ошибке

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "ItemList": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-06-20T05:41:39.462397+03:00",
      "NoActive": true,
      "Exclude": true,
      "CountCode": 1
    },
    {
      "Id": 1,
      "ItemList": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-06-20T05:41:39.462397+03:00",
      "NoActive": true,
      "Exclude": true,
      "CountCode": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ItemListPagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.GoodsResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <Data>
    <ItemListPagingInfoResponse.ItemListPagingInfoDataRow>
      <CountCode>1</CountCode>
      <Exclude>true</Exclude>
      <Id>1</Id>
      <ItemList>1</ItemList>
      <Name>sample string 1</Name>
      <NoActive>true</NoActive>
      <ProcTime>2024-06-20T05:41:39.462397+03:00</ProcTime>
    </ItemListPagingInfoResponse.ItemListPagingInfoDataRow>
    <ItemListPagingInfoResponse.ItemListPagingInfoDataRow>
      <CountCode>1</CountCode>
      <Exclude>true</Exclude>
      <Id>1</Id>
      <ItemList>1</ItemList>
      <Name>sample string 1</Name>
      <NoActive>true</NoActive>
      <ProcTime>2024-06-20T05:41:39.462397+03:00</ProcTime>
    </ItemListPagingInfoResponse.ItemListPagingInfoDataRow>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</ItemListPagingInfoResponse>