POST api/client/ClientInfoPeriod

Получение информации по клиентам, которые совершили нужное действие в указанный период

Request Information

URI Parameters

None.

Body Parameters

ClientInfoPeriodRequest
NameDescriptionTypeAdditional information
BegDate

Дата начала периода

 date

None.
EndDate

Дата окончания периода

 date

None.
Registration

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

 boolean

None.
RegPosList

Условие: клиенты, зарегистрированные в точка продаж указанного списка

 integer

None.
Reg

Отборы по признаку регистрации

 ClientInfoPeriodReg

None.
Operator

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

 integer

None.
Token

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

 integer

None.
SiteCode

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

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "BegDate": "2024-04-25T00:23:55.6146589+03:00",
  "EndDate": "2024-04-25T00:23:55.6146589+03:00",
  "Registration": true,
  "RegPosList": 1,
  "Reg": {
    "Today": true,
    "Yesterday": true,
    "Month": 64,
    "Year": 1
  },
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample: 
<ClientInfoPeriodRequest 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 1</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BegDate>2024-04-25T00:23:55.6146589+03:00</BegDate>
  <EndDate>2024-04-25T00:23:55.6146589+03:00</EndDate>
  <Reg>
    <Month>64</Month>
    <Today>true</Today>
    <Year>1</Year>
    <Yesterday>true</Yesterday>
  </Reg>
  <RegPosList>1</RegPosList>
  <Registration>true</Registration>
</ClientInfoPeriodRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClientInfoPeriodResponse
NameDescriptionTypeAdditional information
Clients

Клиенты

 Collection of ClientInfoPeriodClient

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Clients": [
    {
      "Client": 1,
      "Card": 1,
      "OutNumber": 1,
      "Virtual": true,
      "Card_Type": "sample string 1",
      "Card_Status": "sample string 2",
      "RegPos": 1,
      "RegPosName": "sample string 3",
      "RegDate": "2024-04-25T00:23:55.8646615+03:00"
    },
    {
      "Client": 1,
      "Card": 1,
      "OutNumber": 1,
      "Virtual": true,
      "Card_Type": "sample string 1",
      "Card_Status": "sample string 2",
      "RegPos": 1,
      "RegPosName": "sample string 3",
      "RegDate": "2024-04-25T00:23:55.8646615+03:00"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<ClientInfoPeriodResponse 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>
    <ClientInfoPeriodResponse.ClientInfoPeriodClient>
      <Card>1</Card>
      <Card_Status>sample string 2</Card_Status>
      <Card_Type>sample string 1</Card_Type>
      <Client>1</Client>
      <OutNumber>1</OutNumber>
      <RegDate>2024-04-25T00:23:55.8646615+03:00</RegDate>
      <RegPos>1</RegPos>
      <RegPosName>sample string 3</RegPosName>
      <Virtual>true</Virtual>
    </ClientInfoPeriodResponse.ClientInfoPeriodClient>
    <ClientInfoPeriodResponse.ClientInfoPeriodClient>
      <Card>1</Card>
      <Card_Status>sample string 2</Card_Status>
      <Card_Type>sample string 1</Card_Type>
      <Client>1</Client>
      <OutNumber>1</OutNumber>
      <RegDate>2024-04-25T00:23:55.8646615+03:00</RegDate>
      <RegPos>1</RegPos>
      <RegPosName>sample string 3</RegPosName>
      <Virtual>true</Virtual>
    </ClientInfoPeriodResponse.ClientInfoPeriodClient>
  </Clients>
</ClientInfoPeriodResponse>