POST api/lead/LeadsPagingInfo

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

Request Information

URI Parameters

None.

Body Parameters

LeadsPagingInfoRequest
NameDescriptionTypeAdditional information
BegDate

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

date

None.

EndDate

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

date

None.

Date

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

date

None.

Phone

Входной фильтр: номер телефона клиента

integer

None.

Client

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

integer

None.

Responsible

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

integer

None.

LeadStatus

Входной фильтр: статус лида

byte

None.

LeadType

Входной фильтр: тип лида

byte

None.

LeadSource

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

integer

None.

LeadGroup

Входной фильтр: группа лида

integer

None.

Start

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

integer

None.

Length

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

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "BegDate": "2023-03-28T23:37:52.4659862+03:00",
  "EndDate": "2023-03-28T23:37:52.4659862+03:00",
  "Date": "2023-03-28T23:37:52.4659862+03:00",
  "Phone": 1,
  "Client": 1,
  "Responsible": 1,
  "LeadStatus": 64,
  "LeadType": 64,
  "LeadSource": 1,
  "LeadGroup": 1,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample:
<LeadsPagingInfoRequest 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>2023-03-28T23:37:52.4659862+03:00</BegDate>
  <Client>1</Client>
  <Date>2023-03-28T23:37:52.4659862+03:00</Date>
  <EndDate>2023-03-28T23:37:52.4659862+03:00</EndDate>
  <LeadGroup>1</LeadGroup>
  <LeadSource>1</LeadSource>
  <LeadStatus>64</LeadStatus>
  <LeadType>64</LeadType>
  <Length>1</Length>
  <Phone>1</Phone>
  <Responsible>1</Responsible>
  <Start>1</Start>
</LeadsPagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LeadsPagingInfoResponse
NameDescriptionTypeAdditional information
TotalRows

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

integer

None.

TotalRowsSelect

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

integer

None.

Data

Данные

Collection of LeadsPagingInfoData

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "Leads": 1,
      "ProcTime": "2023-03-28T23:37:52.4816034+03:00",
      "LeadSource": 1,
      "LeadSourceName": "sample string 1",
      "FormName": "sample string 2",
      "LeadType": 64,
      "LeadTypeName": "sample string 3",
      "LeadStatus": 64,
      "LeadStatusName": "sample string 4",
      "Responsible": 1,
      "ResponsibleFio": "sample string 5",
      "Name": "sample string 6",
      "Client": 1,
      "Phone": 1,
      "Email": "sample string 7",
      "Cheque": 1,
      "Goods": 1,
      "Pos": 1,
      "PosName": "sample string 8",
      "Comment": "sample string 9",
      "LeadMark": 1,
      "LeadMarkName": "sample string 10",
      "OrderBasket": 1,
      "OrderInvoices": 1,
      "LeadGroup": 1,
      "LeadGroupName": "sample string 11"
    },
    {
      "Id": 1,
      "Leads": 1,
      "ProcTime": "2023-03-28T23:37:52.4816034+03:00",
      "LeadSource": 1,
      "LeadSourceName": "sample string 1",
      "FormName": "sample string 2",
      "LeadType": 64,
      "LeadTypeName": "sample string 3",
      "LeadStatus": 64,
      "LeadStatusName": "sample string 4",
      "Responsible": 1,
      "ResponsibleFio": "sample string 5",
      "Name": "sample string 6",
      "Client": 1,
      "Phone": 1,
      "Email": "sample string 7",
      "Cheque": 1,
      "Goods": 1,
      "Pos": 1,
      "PosName": "sample string 8",
      "Comment": "sample string 9",
      "LeadMark": 1,
      "LeadMarkName": "sample string 10",
      "OrderBasket": 1,
      "OrderInvoices": 1,
      "LeadGroup": 1,
      "LeadGroupName": "sample string 11"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<LeadsPagingInfoResponse 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>
  <Data>
    <LeadsPagingInfoResponse.LeadsPagingInfoData>
      <Cheque>1</Cheque>
      <Client>1</Client>
      <Comment>sample string 9</Comment>
      <Email>sample string 7</Email>
      <FormName>sample string 2</FormName>
      <Goods>1</Goods>
      <Id>1</Id>
      <LeadGroup>1</LeadGroup>
      <LeadGroupName>sample string 11</LeadGroupName>
      <LeadMark>1</LeadMark>
      <LeadMarkName>sample string 10</LeadMarkName>
      <LeadSource>1</LeadSource>
      <LeadSourceName>sample string 1</LeadSourceName>
      <LeadStatus>64</LeadStatus>
      <LeadStatusName>sample string 4</LeadStatusName>
      <LeadType>64</LeadType>
      <LeadTypeName>sample string 3</LeadTypeName>
      <Leads>1</Leads>
      <Name>sample string 6</Name>
      <OrderBasket>1</OrderBasket>
      <OrderInvoices>1</OrderInvoices>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 8</PosName>
      <ProcTime>2023-03-28T23:37:52.4816034+03:00</ProcTime>
      <Responsible>1</Responsible>
      <ResponsibleFio>sample string 5</ResponsibleFio>
    </LeadsPagingInfoResponse.LeadsPagingInfoData>
    <LeadsPagingInfoResponse.LeadsPagingInfoData>
      <Cheque>1</Cheque>
      <Client>1</Client>
      <Comment>sample string 9</Comment>
      <Email>sample string 7</Email>
      <FormName>sample string 2</FormName>
      <Goods>1</Goods>
      <Id>1</Id>
      <LeadGroup>1</LeadGroup>
      <LeadGroupName>sample string 11</LeadGroupName>
      <LeadMark>1</LeadMark>
      <LeadMarkName>sample string 10</LeadMarkName>
      <LeadSource>1</LeadSource>
      <LeadSourceName>sample string 1</LeadSourceName>
      <LeadStatus>64</LeadStatus>
      <LeadStatusName>sample string 4</LeadStatusName>
      <LeadType>64</LeadType>
      <LeadTypeName>sample string 3</LeadTypeName>
      <Leads>1</Leads>
      <Name>sample string 6</Name>
      <OrderBasket>1</OrderBasket>
      <OrderInvoices>1</OrderInvoices>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 8</PosName>
      <ProcTime>2023-03-28T23:37:52.4816034+03:00</ProcTime>
      <Responsible>1</Responsible>
      <ResponsibleFio>sample string 5</ResponsibleFio>
    </LeadsPagingInfoResponse.LeadsPagingInfoData>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</LeadsPagingInfoResponse>