POST api/client/LeadsPagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

ClientLeadsPagingInfoRequest
NameDescriptionTypeAdditional information
Client

Идентификатор клиента

integer

None.

BegDate

Фильтр: дата начала анализируемого периода

date

None.

EndDate

Фильтр: дата окончания анализируемого периода

date

None.

Start

Фильтр: с какой позиции вернуть записи

integer

None.

Length

Фильтр: какое количество записей вернуть

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Client": 1,
  "BegDate": "2024-06-20T05:42:11.2563229+03:00",
  "EndDate": "2024-06-20T05:42:11.2563229+03:00",
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample:
<ClientLeadsPagingInfoRequest 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-06-20T05:42:11.2563229+03:00</BegDate>
  <Client>1</Client>
  <EndDate>2024-06-20T05:42:11.2563229+03:00</EndDate>
  <Length>1</Length>
  <Start>1</Start>
</ClientLeadsPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClientLeadsPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

Общее количество записей, которые можно вернуть после применения всех фильтров

integer

None.

TotalRowsSelect

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

integer

None.

LeadsClients

Массив обращений клиентов

Collection of ClientLeadsPagingInfoLeadsClient

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "LeadsClients": [
    {
      "Id": 1,
      "Leads": 1,
      "ProcTime": "2024-06-20T05:42:11.2719434+03:00",
      "LeadSourceName": "sample string 1",
      "LeadStatusName": "sample string 2",
      "LeadTypeName": "sample string 3",
      "FormName": "sample string 4",
      "Subject": "sample string 5",
      "LeadMarkName": "sample string 6",
      "CountNotReadMessage": 1
    },
    {
      "Id": 1,
      "Leads": 1,
      "ProcTime": "2024-06-20T05:42:11.2719434+03:00",
      "LeadSourceName": "sample string 1",
      "LeadStatusName": "sample string 2",
      "LeadTypeName": "sample string 3",
      "FormName": "sample string 4",
      "Subject": "sample string 5",
      "LeadMarkName": "sample string 6",
      "CountNotReadMessage": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ClientLeadsPagingInfoResponse 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>
  <LeadsClients>
    <ClientLeadsPagingInfoResponse.ClientLeadsPagingInfoLeadsClient>
      <CountNotReadMessage>1</CountNotReadMessage>
      <FormName>sample string 4</FormName>
      <Id>1</Id>
      <LeadMarkName>sample string 6</LeadMarkName>
      <LeadSourceName>sample string 1</LeadSourceName>
      <LeadStatusName>sample string 2</LeadStatusName>
      <LeadTypeName>sample string 3</LeadTypeName>
      <Leads>1</Leads>
      <ProcTime>2024-06-20T05:42:11.2719434+03:00</ProcTime>
      <Subject>sample string 5</Subject>
    </ClientLeadsPagingInfoResponse.ClientLeadsPagingInfoLeadsClient>
    <ClientLeadsPagingInfoResponse.ClientLeadsPagingInfoLeadsClient>
      <CountNotReadMessage>1</CountNotReadMessage>
      <FormName>sample string 4</FormName>
      <Id>1</Id>
      <LeadMarkName>sample string 6</LeadMarkName>
      <LeadSourceName>sample string 1</LeadSourceName>
      <LeadStatusName>sample string 2</LeadStatusName>
      <LeadTypeName>sample string 3</LeadTypeName>
      <Leads>1</Leads>
      <ProcTime>2024-06-20T05:42:11.2719434+03:00</ProcTime>
      <Subject>sample string 5</Subject>
    </ClientLeadsPagingInfoResponse.ClientLeadsPagingInfoLeadsClient>
  </LeadsClients>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</ClientLeadsPagingInfoResponse>