POST api/v2/favorites/retailers

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
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:

{
  "ApiKey": "66733236-470e-45cf-94a0-6a576dc8f340",
  "ApplicationVersion": 2,
  "Udid": "sample string 3",
  "UserID": "025f0954-b933-4db5-abdd-83334e817bf3",
  "ZoneID": 5
}

application/xml, text/xml

Sample:

<RetailerFavoritesRequest 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">66733236-470e-45cf-94a0-6a576dc8f340</ApiKey>
  <ApplicationVersion xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">2</ApplicationVersion>
  <Udid xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">sample string 3</Udid>
  <UserID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">025f0954-b933-4db5-abdd-83334e817bf3</UserID>
  <ZoneID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">5</ZoneID>
</RetailerFavoritesRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RetailerFavoritesRequest'.

Response Information

Resource Description

RetailerFavoritesResult

Name	Description	Type	Additional information
LeafletRetailerIDs		Collection of globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "LeafletRetailerIDs": [
    "1ba332a0-4c5f-48fa-8870-ca63e31aa9cd",
    "bef967b4-f247-4919-81b0-dbedcfda4b73"
  ]
}

application/xml, text/xml

Sample:

<RetailerFavoritesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Favorites.v2">
  <LeafletRetailerIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>1ba332a0-4c5f-48fa-8870-ca63e31aa9cd</d2p1:guid>
    <d2p1:guid>bef967b4-f247-4919-81b0-dbedcfda4b73</d2p1:guid>
  </LeafletRetailerIDs>
</RetailerFavoritesResult>