POST api/system/TransferDataServiceClients

Получение аналитической информации по результатам работы внешнего сервиса в части привлечения клиентов в программу лояльности

Request Information

URI Parameters

None.

Body Parameters

TransferDataServiceClientsRequest
NameDescriptionTypeAdditional information
ServiceId

Идентификатор внешнего сервиса, по действиям которого запрашиваются данные

integer

None.

Dynamic

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

boolean

None.

Month

Входной фильтр: месяц действия

byte

None.

Year

Входной фильтр: год действия

integer

None.

BegDate

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

date

None.

EndDate

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

date

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ServiceId": 1,
  "Dynamic": true,
  "Month": 64,
  "Year": 1,
  "BegDate": "2024-06-20T05:16:57.5578575+03:00",
  "EndDate": "2024-06-20T05:16:57.5578575+03:00",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample:
<TransferDataServiceClientsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SystemRequest">
  <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-06-20T05:16:57.5578575+03:00</BegDate>
  <Dynamic>true</Dynamic>
  <EndDate>2024-06-20T05:16:57.5578575+03:00</EndDate>
  <Month>64</Month>
  <ServiceId>1</ServiceId>
  <Year>1</Year>
</TransferDataServiceClientsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

TransferDataServiceClientsResponse
NameDescriptionTypeAdditional information
CountRequest

Количество запросов внешнего сервиса на проверку существования клиента в программе лояльности оператора, за период

integer

None.

CountWithPurchase

Количество зарегистрированных внешним сервисом клиентов в разные периоды, но которые совершили свою первую покупку в указанном периоде

integer

None.

CountRegistration

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

integer

None.

CountRegWithPurchase

Количество зарегистрированных клиентов в указанном периоде и которые совершили свои первые покупки в указанном периоде

integer

None.

PersentRegistration

% зарегистированных от запрошенных на проверку за указанный период

decimal number

None.

PersentRegWithPurchase

% совершивших покупки в указанном периоде, от зарегистрированных в указанном периоде

decimal number

None.

Total

Total service

Collection of TransferDataServiceClientsTotalRow

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CountRequest": 1,
  "CountWithPurchase": 1,
  "CountRegistration": 1,
  "CountRegWithPurchase": 1,
  "PersentRegistration": 1.0,
  "PersentRegWithPurchase": 1.0,
  "Total": [
    {
      "Id": 1,
      "ProcYear": 1,
      "ProcMonth": 64,
      "CountRequest": 1,
      "CountWithPurchase": 1,
      "CountRegistration": 1,
      "CountRegWithPurchase": 1,
      "PersentRegistration": 1.0,
      "PersentRegWithPurchase": 1.0
    },
    {
      "Id": 1,
      "ProcYear": 1,
      "ProcMonth": 64,
      "CountRequest": 1,
      "CountWithPurchase": 1,
      "CountRegistration": 1,
      "CountRegWithPurchase": 1,
      "PersentRegistration": 1.0,
      "PersentRegWithPurchase": 1.0
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<TransferDataServiceClientsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SystemResponse">
  <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>
  <CountRegWithPurchase>1</CountRegWithPurchase>
  <CountRegistration>1</CountRegistration>
  <CountRequest>1</CountRequest>
  <CountWithPurchase>1</CountWithPurchase>
  <PersentRegWithPurchase>1</PersentRegWithPurchase>
  <PersentRegistration>1</PersentRegistration>
  <Total>
    <TransferDataServiceClientsResponse.TransferDataServiceClientsTotalRow>
      <CountRegWithPurchase>1</CountRegWithPurchase>
      <CountRegistration>1</CountRegistration>
      <CountRequest>1</CountRequest>
      <CountWithPurchase>1</CountWithPurchase>
      <Id>1</Id>
      <PersentRegWithPurchase>1</PersentRegWithPurchase>
      <PersentRegistration>1</PersentRegistration>
      <ProcMonth>64</ProcMonth>
      <ProcYear>1</ProcYear>
    </TransferDataServiceClientsResponse.TransferDataServiceClientsTotalRow>
    <TransferDataServiceClientsResponse.TransferDataServiceClientsTotalRow>
      <CountRegWithPurchase>1</CountRegWithPurchase>
      <CountRegistration>1</CountRegistration>
      <CountRequest>1</CountRequest>
      <CountWithPurchase>1</CountWithPurchase>
      <Id>1</Id>
      <PersentRegWithPurchase>1</PersentRegWithPurchase>
      <PersentRegistration>1</PersentRegistration>
      <ProcMonth>64</ProcMonth>
      <ProcYear>1</ProcYear>
    </TransferDataServiceClientsResponse.TransferDataServiceClientsTotalRow>
  </Total>
</TransferDataServiceClientsResponse>