POST api/pos/PoslistPagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

PoslistPagingInfoRequest
NameDescriptionTypeAdditional information
PosCode

Код торговой точки пользователя

string

None.

Name

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

string

None.

PosList

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

integer

None.

Active

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

boolean

None.

CountPos

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

integer

None.

Start

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

integer

None.

Length

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

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "Name": "sample string 2",
  "PosList": 1,
  "Active": true,
  "CountPos": 1,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 3"
}

application/xml, text/xml

Sample:
<PoslistPagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request">
  <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 3</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Active>true</Active>
  <CountPos>1</CountPos>
  <Length>1</Length>
  <Name>sample string 2</Name>
  <PosCode>sample string 1</PosCode>
  <PosList>1</PosList>
  <Start>1</Start>
</PoslistPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PoslistPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

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

integer

None.

TotalRowsSelect

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

integer

None.

PosList

Массив позиций

Collection of PoslistPagingInfoPosListStr

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "PosList": [
    {
      "Id": 1,
      "PosListId": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-02-25T18:03:42.9228845+03:00",
      "Active": true,
      "CountPos": 1
    },
    {
      "Id": 1,
      "PosListId": 1,
      "Name": "sample string 1",
      "ProcTime": "2024-02-25T18:03:42.9228845+03:00",
      "Active": true,
      "CountPos": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<PoslistPagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response">
  <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>
  <PosList>
    <PoslistPagingInfoResponse.PoslistPagingInfoPosListStr>
      <Active>true</Active>
      <CountPos>1</CountPos>
      <Id>1</Id>
      <Name>sample string 1</Name>
      <PosListId>1</PosListId>
      <ProcTime>2024-02-25T18:03:42.9228845+03:00</ProcTime>
    </PoslistPagingInfoResponse.PoslistPagingInfoPosListStr>
    <PoslistPagingInfoResponse.PoslistPagingInfoPosListStr>
      <Active>true</Active>
      <CountPos>1</CountPos>
      <Id>1</Id>
      <Name>sample string 1</Name>
      <PosListId>1</PosListId>
      <ProcTime>2024-02-25T18:03:42.9228845+03:00</ProcTime>
    </PoslistPagingInfoResponse.PoslistPagingInfoPosListStr>
  </PosList>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</PoslistPagingInfoResponse>