POST api/v2/leaflets/search
Request Information
URI Parameters
None.
Body Parameters
LeafletsSearchRequestName | Description | 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": "4f3e61f3-3d84-4395-86b3-98552f959b08", "ApplicationVersion": 3, "Udid": "sample string 4", "UserID": "9d5214cb-4008-453f-92b2-05f7a6efd8e6", "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">4f3e61f3-3d84-4395-86b3-98552f959b08</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">9d5214cb-4008-453f-92b2-05f7a6efd8e6</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:
Response Information
Resource Description
LeafletsSearchResultV2Name | Description | Type | Additional information |
---|---|---|---|
Leaflets | Collection of LeafletDto |
None. |
Response Formats
application/json, text/json
Sample:
{ "Leaflets": [ { "LeafletID": "0cb54765-779c-46cd-bac9-aa2a8a3fa8c6", "PageNumber": 2, "IsInteractive": true, "ThumbnailUrl": "sample string 4" }, { "LeafletID": "0cb54765-779c-46cd-bac9-aa2a8a3fa8c6", "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" />