POST api/lead/LeadInfo

Получение информации по лиду

Request Information

URI Parameters

None.

Body Parameters

LeadInfoRequest
NameDescriptionTypeAdditional information
Leads

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

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Leads": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 1"
}

application/xml, text/xml

Sample:
<LeadInfoRequest 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>
  <Leads>1</Leads>
</LeadInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LeadInfoResponse
NameDescriptionTypeAdditional information
LeadSource

Источник лида (точка продаж)

integer

None.

LeadSourceName

Наименование источника лида (точки продаж)

string

None.

Client

Идентификатор клиента, который инициировал лид

integer

None.

LeadType

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

integer

None.

LeadTypeName

Наименование типа лида

string

None.

Formname

Наименование формы, из которой создаётся лид

string

None.

Leadname

ФИО лида

string

None.

Phone

Телефон лида

integer

None.

Email

E-mail лида

string

None.

Cheque

Идентификатор чека, на который ссылается лид

integer

None.

Goods

Идентификатор товара, на который ссылается лид

integer

None.

Pos

Идентификатор точки, на который ссылается лид

integer

None.

Leadmark

Оценка, которую поставил лид, отправляя сообщение

integer

None.

LeadMarkName

Наименование типа оценки

string

None.

LeadGroup

Идентификатор группы лида

integer

None.

LeadGroupName

Наименование группы лида

string

None.

Comment

Произвольный текст (комментарий) лида

string

None.

LeadStatus

Текущий статус лида

byte

None.

LeadStatusName

Наименование статуса лида

string

None.

DateCreate

Дата создания лида

date

None.

Responsible

Идентификатор ответственного за лида

integer

None.

ResponsibleName

Наименование ответственного за лида (ФИО)

string

None.

LeadData

Данные о лидах

Collection of LeadDataActionStr

None.

LeadMessageData

Данные о сообщениях

Collection of LeadMessageData

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "LeadSource": 1,
  "LeadSourceName": "sample string 1",
  "Client": 1,
  "LeadType": 1,
  "LeadTypeName": "sample string 2",
  "Formname": "sample string 3",
  "Leadname": "sample string 4",
  "Phone": 1,
  "Email": "sample string 5",
  "Cheque": 1,
  "Goods": 1,
  "Pos": 1,
  "Leadmark": 1,
  "LeadMarkName": "sample string 6",
  "LeadGroup": 1,
  "LeadGroupName": "sample string 7",
  "Comment": "sample string 8",
  "LeadStatus": 64,
  "LeadStatusName": "sample string 9",
  "DateCreate": "2024-06-16T11:36:08.775846+03:00",
  "Responsible": 1,
  "ResponsibleName": "sample string 10",
  "LeadData": [
    {
      "Id": 1,
      "Field": "sample string 1",
      "Value": "sample string 2",
      "Type": "sample string 3",
      "TypeId": "sample string 4"
    },
    {
      "Id": 1,
      "Field": "sample string 1",
      "Value": "sample string 2",
      "Type": "sample string 3",
      "TypeId": "sample string 4"
    }
  ],
  "LeadMessageData": [
    {
      "Id": 1,
      "Subject": "sample string 1",
      "Parent": 1,
      "Leadtext": "sample string 2",
      "Usertext": "sample string 3",
      "Status": "sample string 4",
      "Date": "2024-06-16T11:36:08.775846+03:00",
      "LeadId": 1,
      "TextAuthor": "sample string 5",
      "ParentText": "sample string 6",
      "MessageData": [
        {
          "Id": 1,
          "Field": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "TypeId": "sample string 4"
        },
        {
          "Id": 1,
          "Field": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "TypeId": "sample string 4"
        }
      ]
    },
    {
      "Id": 1,
      "Subject": "sample string 1",
      "Parent": 1,
      "Leadtext": "sample string 2",
      "Usertext": "sample string 3",
      "Status": "sample string 4",
      "Date": "2024-06-16T11:36:08.775846+03:00",
      "LeadId": 1,
      "TextAuthor": "sample string 5",
      "ParentText": "sample string 6",
      "MessageData": [
        {
          "Id": 1,
          "Field": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "TypeId": "sample string 4"
        },
        {
          "Id": 1,
          "Field": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "TypeId": "sample string 4"
        }
      ]
    }
  ],
  "ErrorCode": 11,
  "Message": "sample string 12"
}

application/xml, text/xml

Sample:
<LeadInfoResponse 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">11</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 12</Message>
  <Cheque>1</Cheque>
  <Client>1</Client>
  <Comment>sample string 8</Comment>
  <DateCreate>2024-06-16T11:36:08.775846+03:00</DateCreate>
  <Email>sample string 5</Email>
  <Formname>sample string 3</Formname>
  <Goods>1</Goods>
  <LeadData xmlns:d2p1="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Data">
    <d2p1:LeadDataActionStr>
      <d2p1:Field>sample string 1</d2p1:Field>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Type>sample string 3</d2p1:Type>
      <d2p1:TypeId>sample string 4</d2p1:TypeId>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:LeadDataActionStr>
    <d2p1:LeadDataActionStr>
      <d2p1:Field>sample string 1</d2p1:Field>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Type>sample string 3</d2p1:Type>
      <d2p1:TypeId>sample string 4</d2p1:TypeId>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:LeadDataActionStr>
  </LeadData>
  <LeadGroup>1</LeadGroup>
  <LeadGroupName>sample string 7</LeadGroupName>
  <LeadMarkName>sample string 6</LeadMarkName>
  <LeadMessageData xmlns:d2p1="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Data">
    <d2p1:LeadMessageData>
      <d2p1:Date>2024-06-16T11:36:08.775846+03:00</d2p1:Date>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LeadId>1</d2p1:LeadId>
      <d2p1:Leadtext>sample string 2</d2p1:Leadtext>
      <d2p1:MessageData>
        <d2p1:LeadDataActionStr>
          <d2p1:Field>sample string 1</d2p1:Field>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:TypeId>sample string 4</d2p1:TypeId>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:LeadDataActionStr>
        <d2p1:LeadDataActionStr>
          <d2p1:Field>sample string 1</d2p1:Field>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:TypeId>sample string 4</d2p1:TypeId>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:LeadDataActionStr>
      </d2p1:MessageData>
      <d2p1:Parent>1</d2p1:Parent>
      <d2p1:ParentText>sample string 6</d2p1:ParentText>
      <d2p1:Status>sample string 4</d2p1:Status>
      <d2p1:Subject>sample string 1</d2p1:Subject>
      <d2p1:TextAuthor>sample string 5</d2p1:TextAuthor>
      <d2p1:Usertext>sample string 3</d2p1:Usertext>
    </d2p1:LeadMessageData>
    <d2p1:LeadMessageData>
      <d2p1:Date>2024-06-16T11:36:08.775846+03:00</d2p1:Date>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LeadId>1</d2p1:LeadId>
      <d2p1:Leadtext>sample string 2</d2p1:Leadtext>
      <d2p1:MessageData>
        <d2p1:LeadDataActionStr>
          <d2p1:Field>sample string 1</d2p1:Field>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:TypeId>sample string 4</d2p1:TypeId>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:LeadDataActionStr>
        <d2p1:LeadDataActionStr>
          <d2p1:Field>sample string 1</d2p1:Field>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:TypeId>sample string 4</d2p1:TypeId>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:LeadDataActionStr>
      </d2p1:MessageData>
      <d2p1:Parent>1</d2p1:Parent>
      <d2p1:ParentText>sample string 6</d2p1:ParentText>
      <d2p1:Status>sample string 4</d2p1:Status>
      <d2p1:Subject>sample string 1</d2p1:Subject>
      <d2p1:TextAuthor>sample string 5</d2p1:TextAuthor>
      <d2p1:Usertext>sample string 3</d2p1:Usertext>
    </d2p1:LeadMessageData>
  </LeadMessageData>
  <LeadSource>1</LeadSource>
  <LeadSourceName>sample string 1</LeadSourceName>
  <LeadStatus>64</LeadStatus>
  <LeadStatusName>sample string 9</LeadStatusName>
  <LeadType>1</LeadType>
  <LeadTypeName>sample string 2</LeadTypeName>
  <Leadmark>1</Leadmark>
  <Leadname>sample string 4</Leadname>
  <Phone>1</Phone>
  <Pos>1</Pos>
  <Responsible>1</Responsible>
  <ResponsibleName>sample string 10</ResponsibleName>
</LeadInfoResponse>