POST api/fraud/RuleAction
Добавление, изменение, получение информации о правиле сервиса фрод-мониторинга
Request Information
URI Parameters
None.
Body Parameters
RuleActionRequestName | Description | Type | Additional information |
---|---|---|---|
ActionType |
Тип действия (Update, Info, Create, Delete) |
string |
None. |
FraudRule |
Идентификатор правила для удаления, получения информации или редактирования |
integer |
None. |
FraudName |
Наименование правила |
string |
None. |
Partner |
Идентификатор партнера, в точках которого рассматриваются покупки |
integer |
None. |
PartnerList |
Идентификатор списка партнеров, в точках которых рассматриваются покупки |
integer |
None. |
City |
Идентификатор города, в точках которого рассматриваются покупки |
integer |
None. |
Pos |
Идентификатор торговой точки, в которой рассматриваются покупки |
integer |
None. |
PosList |
Идентификатор списка торговых точек, в котором рассматриваются покупки |
integer |
None. |
OnePos |
Признак, что покупки должны быть в одной торговой точке, а не накопительным итогом |
boolean |
None. |
DaysAgo |
Кол-во дней назад от сегодня, в течение которых анализируются покупки клиента |
integer |
None. |
BegDate |
Дата начала действия правила |
date |
None. |
EndDate |
Дата окончания действия правила |
date |
None. |
Purchases |
Кол-во совершенных покупок, за период, от которого клиент попадает в итоговую выборку |
integer |
None. |
PurchaseSum |
Сумма совершенных покупок, за период, от которой клиент попадает в итоговую выборку |
decimal number |
None. |
Redeemed |
Сумма списания бонусов, за период, от которой клиент попадает в итоговую выборку |
decimal number |
None. |
RefundSum |
Сумма возвратов, за период (daysago), от которой клиент попадает в выборку |
decimal number |
None. |
NoCardType |
Идентификатор типа карты, на который НЕ действует правило |
integer |
None. |
NoCardTypeList |
идентификатор списка типов карт, на которые НЕ действует правило |
integer |
None. |
ClientList |
Идентификатор списка клиентов, на который действует правило |
integer |
None. |
NoActive |
Признак, что правило отключено (явно задается в случае деактивации правила) |
boolean |
None. |
Active |
Признак, что правило включено (явно задается в случае активации правила) |
boolean |
None. |
Description |
Описание правила |
string |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "ActionType": "sample string 1", "FraudRule": 1, "FraudName": "sample string 2", "Partner": 1, "PartnerList": 1, "City": 1, "Pos": 1, "PosList": 1, "OnePos": true, "DaysAgo": 1, "BegDate": "2024-04-29T18:02:06.171709+03:00", "EndDate": "2024-04-29T18:02:06.171709+03:00", "Purchases": 1, "PurchaseSum": 1.0, "Redeemed": 1.0, "RefundSum": 1.0, "NoCardType": 1, "NoCardTypeList": 1, "ClientList": 1, "NoActive": true, "Active": true, "Description": "sample string 3", "Operator": 1, "Token": 1, "SiteCode": "sample string 4" }
application/xml, text/xml
<RuleActionRequest 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 4</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ActionType>sample string 1</ActionType> <Active>true</Active> <BegDate>2024-04-29T18:02:06.171709+03:00</BegDate> <City>1</City> <ClientList>1</ClientList> <DaysAgo>1</DaysAgo> <Description>sample string 3</Description> <EndDate>2024-04-29T18:02:06.171709+03:00</EndDate> <FraudName>sample string 2</FraudName> <FraudRule>1</FraudRule> <NoActive>true</NoActive> <NoCardType>1</NoCardType> <NoCardTypeList>1</NoCardTypeList> <OnePos>true</OnePos> <Partner>1</Partner> <PartnerList>1</PartnerList> <Pos>1</Pos> <PosList>1</PosList> <PurchaseSum>1</PurchaseSum> <Purchases>1</Purchases> <Redeemed>1</Redeemed> <RefundSum>1</RefundSum> </RuleActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
RuleActionResponseName | Description | Type | Additional information |
---|---|---|---|
FraudRule |
Идентификатор созданного правила |
integer |
None. |
Data |
Список |
Collection of RuleActionDataRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "FraudRule": 1, "Data": [ { "RuleId": 1, "RuleName": "sample string 1", "Partner": 1, "PartnerName": "sample string 2", "PartnerList": 1, "PartnerListName": "sample string 3", "City": 1, "CityName": "sample string 4", "Pos": 1, "PosName": "sample string 5", "PosList": 1, "Caption": "sample string 6", "OnePos": "sample string 7", "DaysAgo": 1, "BegDate": "2024-04-29T18:02:06.4529816+03:00", "EndDate": "2024-04-29T18:02:06.4529816+03:00", "Purchases": 1, "PurchaseSum": 1.0, "Redeemed": 1.0, "NoCardtype": 1, "NoCardTypeList": 1, "ClientList": 1, "RuleStatus": "sample string 8", "Description": "sample string 9", "ProcTime": "2024-04-29T18:02:06.4529816+03:00", "LastChangeDate": "2024-04-29T18:02:06.4529816+03:00", "RefundSum": 1.0 }, { "RuleId": 1, "RuleName": "sample string 1", "Partner": 1, "PartnerName": "sample string 2", "PartnerList": 1, "PartnerListName": "sample string 3", "City": 1, "CityName": "sample string 4", "Pos": 1, "PosName": "sample string 5", "PosList": 1, "Caption": "sample string 6", "OnePos": "sample string 7", "DaysAgo": 1, "BegDate": "2024-04-29T18:02:06.4529816+03:00", "EndDate": "2024-04-29T18:02:06.4529816+03:00", "Purchases": 1, "PurchaseSum": 1.0, "Redeemed": 1.0, "NoCardtype": 1, "NoCardTypeList": 1, "ClientList": 1, "RuleStatus": "sample string 8", "Description": "sample string 9", "ProcTime": "2024-04-29T18:02:06.4529816+03:00", "LastChangeDate": "2024-04-29T18:02:06.4529816+03:00", "RefundSum": 1.0 } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<RuleActionResponse 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> <Data> <RuleActionResponse.RuleActionDataRow> <BegDate>2024-04-29T18:02:06.4529816+03:00</BegDate> <Caption>sample string 6</Caption> <City>1</City> <CityName>sample string 4</CityName> <ClientList>1</ClientList> <DaysAgo>1</DaysAgo> <Description>sample string 9</Description> <EndDate>2024-04-29T18:02:06.4529816+03:00</EndDate> <LastChangeDate>2024-04-29T18:02:06.4529816+03:00</LastChangeDate> <NoCardTypeList>1</NoCardTypeList> <NoCardtype>1</NoCardtype> <OnePos>sample string 7</OnePos> <Partner>1</Partner> <PartnerList>1</PartnerList> <PartnerListName>sample string 3</PartnerListName> <PartnerName>sample string 2</PartnerName> <Pos>1</Pos> <PosList>1</PosList> <PosName>sample string 5</PosName> <ProcTime>2024-04-29T18:02:06.4529816+03:00</ProcTime> <PurchaseSum>1</PurchaseSum> <Purchases>1</Purchases> <Redeemed>1</Redeemed> <RefundSum>1</RefundSum> <RuleId>1</RuleId> <RuleName>sample string 1</RuleName> <RuleStatus>sample string 8</RuleStatus> </RuleActionResponse.RuleActionDataRow> <RuleActionResponse.RuleActionDataRow> <BegDate>2024-04-29T18:02:06.4529816+03:00</BegDate> <Caption>sample string 6</Caption> <City>1</City> <CityName>sample string 4</CityName> <ClientList>1</ClientList> <DaysAgo>1</DaysAgo> <Description>sample string 9</Description> <EndDate>2024-04-29T18:02:06.4529816+03:00</EndDate> <LastChangeDate>2024-04-29T18:02:06.4529816+03:00</LastChangeDate> <NoCardTypeList>1</NoCardTypeList> <NoCardtype>1</NoCardtype> <OnePos>sample string 7</OnePos> <Partner>1</Partner> <PartnerList>1</PartnerList> <PartnerListName>sample string 3</PartnerListName> <PartnerName>sample string 2</PartnerName> <Pos>1</Pos> <PosList>1</PosList> <PosName>sample string 5</PosName> <ProcTime>2024-04-29T18:02:06.4529816+03:00</ProcTime> <PurchaseSum>1</PurchaseSum> <Purchases>1</Purchases> <Redeemed>1</Redeemed> <RefundSum>1</RefundSum> <RuleId>1</RuleId> <RuleName>sample string 1</RuleName> <RuleStatus>sample string 8</RuleStatus> </RuleActionResponse.RuleActionDataRow> </Data> <FraudRule>1</FraudRule> </RuleActionResponse>