POST api/v2/leaflets/search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SearchText	string	Required
Skip	integer	None.
Top	integer	None.
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:

{
  "SearchText": "sample string 1",
  "Skip": 1,
  "Top": 1,
  "ApiKey": "d9420972-50db-473b-b085-3706f3d9214e",
  "ApplicationVersion": 3,
  "Udid": "sample string 4",
  "UserID": "8de71b2a-60ca-4707-a02d-8be53de0a426",
  "ZoneID": 6
}

application/xml, text/xml

Sample:

<LeafletsSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Requests.v2">
  <ApiKey xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">d9420972-50db-473b-b085-3706f3d9214e</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">8de71b2a-60ca-4707-a02d-8be53de0a426</UserID>
  <ZoneID xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models">6</ZoneID>
  <SearchText>sample string 1</SearchText>
  <Skip>1</Skip>
  <Top>1</Top>
</LeafletsSearchRequest>

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 'LeafletsSearchRequest'.

Response Information

Resource Description

LeafletsSearchResultV2

Name	Description	Type	Additional information
Leaflets		Collection of LeafletDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Leaflets": [
    {
      "LeafletID": "c35fa91e-f3c6-4915-b97c-1e60d213e83b",
      "PageNumber": 2,
      "IsInteractive": true,
      "ThumbnailUrl": "sample string 4"
    },
    {
      "LeafletID": "c35fa91e-f3c6-4915-b97c-1e60d213e83b",
      "PageNumber": 2,
      "IsInteractive": true,
      "ThumbnailUrl": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<LeafletsSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/agilys.myshopi.mvc.leaflets.services.Models.Leaflets.Responses.v2" />