POST api/fraud/ClientData

Получение детализации фрод-мониторинга по клиенту: попадания, правила, чеки

Request Information

URI Parameters

None.

Body Parameters

ClientDataRequest
NameDescriptionTypeAdditional information
Client

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

 integer

None.
Partner

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

 integer

None.
PosCode

Код торговой точки

 string

None.
FraudClient

Идентификатор записи входа во фрод

 integer

None.
FraudRule

Идентификатор правила, по которому смотрим чеки

 integer

None.
ShownFraud

Признак того, что возращаем все записи входа-выхода клиента во фрод

 boolean

None.
ShownRule

Признак того, что возращаем правила, по которым клиент вошел во фрод по заданному ид входа во фрод

 boolean

None.
ShownCheque

Признак того, что возращаем чеки, на основании которых клиент попал под правило для входа во фрод

 boolean

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,
  "Partner": 1,
  "PosCode": "sample string 1",
  "FraudClient": 1,
  "FraudRule": 1,
  "ShownFraud": true,
  "ShownRule": true,
  "ShownCheque": true,
  "Start": 1,
  "Length": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample: 
<ClientDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.FraudRequest">
  <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 2</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <Client>1</Client>
  <FraudClient>1</FraudClient>
  <FraudRule>1</FraudRule>
  <Length>1</Length>
  <Partner>1</Partner>
  <PosCode>sample string 1</PosCode>
  <ShownCheque>true</ShownCheque>
  <ShownFraud>true</ShownFraud>
  <ShownRule>true</ShownRule>
  <Start>1</Start>
</ClientDataRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ClientDataResponse
NameDescriptionTypeAdditional information
Frauds

Записи входа-выхода клиента во фрод

 Collection of ClientDataFraud

None.
Rules

Записи по правилам в рамках одного входа-выхода

 Collection of ClientDataRule

None.
Cheques

Записи по чекам в рамках правила и записи входа-выхода

 Collection of ClientDataCheque

None.
TotalRows

Итоговое количество чеков в выборке

 integer

None.
ErrorCode

Код ошибки

 integer

None.
Message

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

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Frauds": [
    {
      "Id": 1,
      "FraudClientId": 1,
      "PhaseName": "sample string 1",
      "BegDate": "2024-04-25T14:13:44.6168144+03:00",
      "EndDate": "2024-04-25T14:13:44.6168144+03:00",
      "FraudStatusName": "sample string 2"
    },
    {
      "Id": 1,
      "FraudClientId": 1,
      "PhaseName": "sample string 1",
      "BegDate": "2024-04-25T14:13:44.6168144+03:00",
      "EndDate": "2024-04-25T14:13:44.6168144+03:00",
      "FraudStatusName": "sample string 2"
    }
  ],
  "Rules": [
    {
      "Id": 1,
      "FraudRuleId": 1,
      "RuleName": "sample string 1",
      "Description": "sample string 2",
      "ProcTime": "2024-04-25T14:13:44.6168144+03:00",
      "Cheques": 1
    },
    {
      "Id": 1,
      "FraudRuleId": 1,
      "RuleName": "sample string 1",
      "Description": "sample string 2",
      "ProcTime": "2024-04-25T14:13:44.6168144+03:00",
      "Cheques": 1
    }
  ],
  "Cheques": [
    {
      "Id": 1,
      "Cheque": 1,
      "ChequeTime": "2024-04-25T14:13:44.6168144+03:00",
      "Pos": 1,
      "PosName": "sample string 1",
      "Amount": 1.0,
      "Added": 1.0,
      "Redeemed": 1.0,
      "ChequeNumber": "sample string 2"
    },
    {
      "Id": 1,
      "Cheque": 1,
      "ChequeTime": "2024-04-25T14:13:44.6168144+03:00",
      "Pos": 1,
      "PosName": "sample string 1",
      "Amount": 1.0,
      "Added": 1.0,
      "Redeemed": 1.0,
      "ChequeNumber": "sample string 2"
    }
  ],
  "TotalRows": 1,
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<ClientDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.FraudResponse">
  <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>
  <Cheques>
    <ClientDataCheque>
      <Added>1</Added>
      <Amount>1</Amount>
      <Cheque>1</Cheque>
      <ChequeNumber>sample string 2</ChequeNumber>
      <ChequeTime>2024-04-25T14:13:44.6168144+03:00</ChequeTime>
      <Id>1</Id>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <Redeemed>1</Redeemed>
    </ClientDataCheque>
    <ClientDataCheque>
      <Added>1</Added>
      <Amount>1</Amount>
      <Cheque>1</Cheque>
      <ChequeNumber>sample string 2</ChequeNumber>
      <ChequeTime>2024-04-25T14:13:44.6168144+03:00</ChequeTime>
      <Id>1</Id>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <Redeemed>1</Redeemed>
    </ClientDataCheque>
  </Cheques>
  <Frauds>
    <ClientDataFraud>
      <BegDate>2024-04-25T14:13:44.6168144+03:00</BegDate>
      <EndDate>2024-04-25T14:13:44.6168144+03:00</EndDate>
      <FraudClientId>1</FraudClientId>
      <FraudStatusName>sample string 2</FraudStatusName>
      <Id>1</Id>
      <PhaseName>sample string 1</PhaseName>
    </ClientDataFraud>
    <ClientDataFraud>
      <BegDate>2024-04-25T14:13:44.6168144+03:00</BegDate>
      <EndDate>2024-04-25T14:13:44.6168144+03:00</EndDate>
      <FraudClientId>1</FraudClientId>
      <FraudStatusName>sample string 2</FraudStatusName>
      <Id>1</Id>
      <PhaseName>sample string 1</PhaseName>
    </ClientDataFraud>
  </Frauds>
  <Rules>
    <ClientDataRule>
      <Cheques>1</Cheques>
      <Description>sample string 2</Description>
      <FraudRuleId>1</FraudRuleId>
      <Id>1</Id>
      <ProcTime>2024-04-25T14:13:44.6168144+03:00</ProcTime>
      <RuleName>sample string 1</RuleName>
    </ClientDataRule>
    <ClientDataRule>
      <Cheques>1</Cheques>
      <Description>sample string 2</Description>
      <FraudRuleId>1</FraudRuleId>
      <Id>1</Id>
      <ProcTime>2024-04-25T14:13:44.6168144+03:00</ProcTime>
      <RuleName>sample string 1</RuleName>
    </ClientDataRule>
  </Rules>
  <TotalRows>1</TotalRows>
</ClientDataResponse>