POST api/v2/favorites/retailers/subscribe
Request Information
URI Parameters
None.
Body Parameters
RetailerFavoritesSubscribeRequestName | Description | Type | Additional information |
---|---|---|---|
LeafletRetailerID | globally unique identifier |
Required |
|
ApiKey | globally unique identifier |
Required |
|
ApplicationVersion | integer |
Required |
|
Udid | string |
Required |
|
UserID | globally unique identifier |
Required |
|
ZoneID | integer |
Required |
Request Formats
application/json, text/json
Sample:
{ "LeafletRetailerID": "e2a743bc-10dc-4529-8177-3c613ad4a97a", "ApiKey": "685ab920-db3d-43aa-a5e5-6b9c00184ed9", "ApplicationVersion": 3, "Udid": "sample string 4", "UserID": "9aa34484-6af1-4571-9508-596cc65fd998", "ZoneID": 6 }
application/xml, text/xml
Sample:
<RetailerFavoritesSubscribeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Favorites.v2"> <ApiKey xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">685ab920-db3d-43aa-a5e5-6b9c00184ed9</ApiKey> <ApplicationVersion xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">3</ApplicationVersion> <Udid xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">sample string 4</Udid> <UserID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">9aa34484-6af1-4571-9508-596cc65fd998</UserID> <ZoneID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">6</ZoneID> <LeafletRetailerID>e2a743bc-10dc-4529-8177-3c613ad4a97a</LeafletRetailerID> </RetailerFavoritesSubscribeRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |