POST api/level/LevelClients

Получение информации о количестве клиентов, карты которых находятся на заданном уровне, с детализацией и без

Request Information

URI Parameters

None.

Body Parameters

LevelClientsRequest
NameDescriptionTypeAdditional information
PosCode

Код торговой точки, с которой идёт запрос на создание корзины

string

None.

Level

Идентификатор уровня, данные по которому нужно веруть

integer

None.

LevelName

Наименование уровня (например, Gold, Silver и т.д.)

string

None.

LevelCondition

Процент поощрения по уровню (например 5%, 7%, 10% и т.д.)

string

None.

Start

Пагинация: начальная позиция от которой нужно возвращать данные (1, 10, 20, 30 и т.д.)

integer

None.

Length

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

integer

None.

OnlyCount

Признак, что нужно вернуть только общее количество клиентов на уровне, без выборки

boolean

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "Level": 1,
  "LevelName": "sample string 2",
  "LevelCondition": "sample string 3",
  "Start": 1,
  "Length": 1,
  "OnlyCount": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 4"
}

application/xml, text/xml

Sample:
<LevelClientsRequest 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 4</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Length>1</Length>
  <Level>1</Level>
  <LevelCondition>sample string 3</LevelCondition>
  <LevelName>sample string 2</LevelName>
  <OnlyCount>true</OnlyCount>
  <PosCode>sample string 1</PosCode>
  <Start>1</Start>
</LevelClientsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LevelClientsResponse
NameDescriptionTypeAdditional information
TotalRows

Общее кол-во запией, которое попало в выборку

integer

None.

TotalRowsSelect

Общее кол-во записей, которое вернулось в массиве

integer

None.

Clients

Массив клиентов

Collection of LevelClientsClient

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Clients": [
    {
      "Id": 1,
      "Client": 1,
      "Card": 1,
      "OutNumber": 1
    },
    {
      "Id": 1,
      "Client": 1,
      "Card": 1,
      "OutNumber": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<LevelClientsResponse 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>
  <Clients>
    <LevelClientsResponse.LevelClientsClient>
      <Card>1</Card>
      <Client>1</Client>
      <Id>1</Id>
      <OutNumber>1</OutNumber>
    </LevelClientsResponse.LevelClientsClient>
    <LevelClientsResponse.LevelClientsClient>
      <Card>1</Card>
      <Client>1</Client>
      <Id>1</Id>
      <OutNumber>1</OutNumber>
    </LevelClientsResponse.LevelClientsClient>
  </Clients>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</LevelClientsResponse>