POST api/client/ClientFavoriteAction
Добавление, получение, изменение данных об избранных и любимых товарах/магазинах клиента
Request Information
URI Parameters
None.
Body Parameters
ClientFavoriteActionRequestName | Description | Type | Additional information |
---|---|---|---|
ActionType |
Тип действия |
string |
None. |
ForPos |
Признак, что запрос идет по точке продаж |
boolean |
None. |
Client |
Идентификатор клиента |
integer |
None. |
Code |
Код товара |
string |
None. |
GoodId |
Идентификатор товара |
integer |
None. |
Pos |
Идентификатор точки продаж |
integer |
None. |
FavoriteId |
Идентификатор изменяемой или удаляемой записи |
integer |
None. |
NoActive |
Команда: "Деативировать запись" |
boolean |
None. |
Active |
Команда: "Активировать запись" |
boolean |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "ActionType": "sample string 1", "ForPos": true, "Client": 1, "Code": "sample string 2", "GoodId": 1, "Pos": 1, "FavoriteId": 1, "NoActive": true, "Active": true, "Operator": 1, "Token": 1, "SiteCode": "sample string 3" }
application/xml, text/xml
<ClientFavoriteActionRequest 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 3</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ActionType>sample string 1</ActionType> <Active>true</Active> <Client>1</Client> <Code>sample string 2</Code> <FavoriteId>1</FavoriteId> <ForPos>true</ForPos> <GoodId>1</GoodId> <NoActive>true</NoActive> <Pos>1</Pos> </ClientFavoriteActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ClientFavoriteActionResponseName | Description | Type | Additional information |
---|---|---|---|
FavoriteGoods |
Массив информации о любимых товарах |
Collection of ClientFavoriteActionFavoriteGoodRow |
None. |
FavoritePoses |
Массив информации о любимых магазинах |
Collection of ClientFavoriteActionFavoritePosRow |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "FavoriteGoods": [ { "Id": 1, "GoodId": 1, "Code": "sample string 1", "Name": "sample string 2", "ProcTime": "2024-04-29T16:35:52.3983462+03:00", "BegDate": "2024-04-29T16:35:52.3983462+03:00", "EndDate": "2024-04-29T16:35:52.4139715+03:00", "NoActive": true }, { "Id": 1, "GoodId": 1, "Code": "sample string 1", "Name": "sample string 2", "ProcTime": "2024-04-29T16:35:52.3983462+03:00", "BegDate": "2024-04-29T16:35:52.3983462+03:00", "EndDate": "2024-04-29T16:35:52.4139715+03:00", "NoActive": true } ], "FavoritePoses": [ { "Id": 1, "Pos": 1, "ProcTime": "2024-04-29T16:35:52.4139715+03:00", "BegDate": "2024-04-29T16:35:52.4139715+03:00", "EndDate": "2024-04-29T16:35:52.4139715+03:00", "NoActive": true }, { "Id": 1, "Pos": 1, "ProcTime": "2024-04-29T16:35:52.4139715+03:00", "BegDate": "2024-04-29T16:35:52.4139715+03:00", "EndDate": "2024-04-29T16:35:52.4139715+03:00", "NoActive": true } ], "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<ClientFavoriteActionResponse 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> <FavoriteGoods> <ClientFavoriteActionResponse.ClientFavoriteActionFavoriteGoodRow> <BegDate>2024-04-29T16:35:52.3983462+03:00</BegDate> <Code>sample string 1</Code> <EndDate>2024-04-29T16:35:52.4139715+03:00</EndDate> <GoodId>1</GoodId> <Id>1</Id> <Name>sample string 2</Name> <NoActive>true</NoActive> <ProcTime>2024-04-29T16:35:52.3983462+03:00</ProcTime> </ClientFavoriteActionResponse.ClientFavoriteActionFavoriteGoodRow> <ClientFavoriteActionResponse.ClientFavoriteActionFavoriteGoodRow> <BegDate>2024-04-29T16:35:52.3983462+03:00</BegDate> <Code>sample string 1</Code> <EndDate>2024-04-29T16:35:52.4139715+03:00</EndDate> <GoodId>1</GoodId> <Id>1</Id> <Name>sample string 2</Name> <NoActive>true</NoActive> <ProcTime>2024-04-29T16:35:52.3983462+03:00</ProcTime> </ClientFavoriteActionResponse.ClientFavoriteActionFavoriteGoodRow> </FavoriteGoods> <FavoritePoses> <ClientFavoriteActionResponse.ClientFavoriteActionFavoritePosRow> <BegDate>2024-04-29T16:35:52.4139715+03:00</BegDate> <EndDate>2024-04-29T16:35:52.4139715+03:00</EndDate> <Id>1</Id> <NoActive>true</NoActive> <Pos>1</Pos> <ProcTime>2024-04-29T16:35:52.4139715+03:00</ProcTime> </ClientFavoriteActionResponse.ClientFavoriteActionFavoritePosRow> <ClientFavoriteActionResponse.ClientFavoriteActionFavoritePosRow> <BegDate>2024-04-29T16:35:52.4139715+03:00</BegDate> <EndDate>2024-04-29T16:35:52.4139715+03:00</EndDate> <Id>1</Id> <NoActive>true</NoActive> <Pos>1</Pos> <ProcTime>2024-04-29T16:35:52.4139715+03:00</ProcTime> </ClientFavoriteActionResponse.ClientFavoriteActionFavoritePosRow> </FavoritePoses> </ClientFavoriteActionResponse>