Page Comparison

Overview

This API allows you to update a landing page layout in Hawksearch dashboard.

Product Listing Landing Page

Request

...

Expand

Code Block language json PUT /api/v10/LandingPageLandingPageLayout/1234 HTTP/1.1 Host: dashboard-na.hawksearch.com X-HawkSearch-ApiKey: USE_YOUR_API_KEY Cache-Control: no-cache Postman-Token: cd457184-4c00-a650-62f2-530f22a9a384 { "PageIdPageLayoutId": 12343, "Name": "Columbia3 Sportswear®", "Title": "Columbia Sportswear Title 2", "MetaDescription": "Columbia Landing Page Meta DescriptionImages (Top), 1 Zone (Bottom)", "MetaKeywordsLayout": "columbia landing page meta keywords", "CustomUrl": "/brands/columbia/", "Breadcrumb": "<p><a href=\"http://www.erehwon.com/\" target=\"_blank\">Home</a>&nbsp;&gt;&nbsp;<a href=\"http://www.erehwon.com/store/brands/\" target=\"_blank\">View All Brands</a>&nbsp;&gt;&nbsp;Columbia <strong>Sportswear</strong></p>", "NarrowXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"All\" RuleType=\"Group\">\r\n <Rules>\r\n <Rule Operator=\"None\" RuleType=\"Eval\"<div class=\"grid_12\">\r\n <div class=\"grid_4\">\r\n <Rules />\r\n <Field>facet:brand</Field>{{Image1}}\r\n <Condition>contains</Condition>\r\n <Value>Columbia Sportswear</Value>\r\n </Rule></div>\r\n </Rules>\r\n <Field />\r\n <Condition /<div class=\"grid_4\">\r\n <Value />\r\n</Rule>", "IsFacetOverride": true, "IsIncludeProducts": false, "SortFieldId": 0, "SortDirection": "Asc", "SelectedFacets": [ { "FacetId": 114, "Field": "", "Label": "Search within these results", "SortOrder": 1, "SortBy": null }, { "FacetId": 12114, "Field": "department_nest", "Label": "Department", "SortOrder": 2, "SortBy": "" }, { "FacetId": 99, "Field": "size-property", "Label": "Size", "SortOrder": 3, "SortBy": "Score" }, { "FacetId": 98, "Field": "color-property", "Label": "Color", "SortOrder": 4, "SortBy": "" } ], "PageLayoutId": null, "EnableFacetAutoOrdering": false, "Custom": "", "Tags": "brand,promo,columbia", "CanonicalUrl": "", "PageType": "ProductListing", "ContentConfigList": [], "PageHeading": "", "CustomHtml": "", "Keywords": null, "ListName": "Columbia Sportswear®", "Notes": "lorem ipsum dolor", "IsNoIndex": false, "IsNoFollow": false, "StartDate": "01-01-0001", "EndDate": "01-01-0001" }

Content Landing Page

Request: POST request to the API below:

POST /api/v10/LandingPage HTTP/1.1
Host: dashboard-na.hawksearch.com
X-HawkSearch-ApiKey: USE_YOUR_API_KEY
Cache-Control: no-cache
Postman-Token: cd457184-4c00-a650-62f2-530f22a9a384

{
    "Name": "Content LP",
    "Title": "Content LP",
    "MetaDescription": "",
    "MetaKeywords": "",
    "CustomUrl": "contentlp",
    "Breadcrumb": "",
    "NarrowXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"All\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />{Image2}}\r\n  </div>  \r\n  <Condition />\r\n  <Value />\r\n</Rule>",
    "IsFacetOverride": false,
    "IsIncludeProducts": false,
    "SortFieldId": 0,
    "SortDirection": null,
    "SelectedFacets": [],
    "PageLayoutId": 326,
    "EnableFacetAutoOrdering": false,
    "Custom": "",
    "Tags": "",
    "CanonicalUrl": "",
    "PageType": "Content",
    "ContentConfigList": [
        {
            "ZoneName": "Header",
            "ZoneConfig": [
                {
                    "BannerId": 103550,
                    "CustomValue": null,
                    "DateFrom": "01-01-0001",
                    "DateTo": "01-01-0001",
                    "SortOrder": 0,
                    "TriggerXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"Any\" RuleType=\"Group\"<div class=\"grid_4\">\r\n  <Rules />\r\n  <Field /> {{Image3}}\r\n  <Condition />\r\n</div>  <Value />\r\n</Rule>"
                }
            ]
        },
        {
            "ZoneName": "Sub Content 1",
            "ZoneConfig": [
                {
                    "BannerId": 73532,
                    "CustomValue": null,
                    "DateFrom": "01-01-0001",
                    "DateTo": "01-01-0001",
                    "SortOrder": 0,
                    "TriggerXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"Any\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>"
                }
            ]
        },
        {
            "ZoneName": "Other",
            "ZoneConfig": []
        },
        {
            "ZoneName": "Bottom content",
            "ZoneConfig": [
                {
                    "BannerId": 73532,
                    "CustomValue": null,
                    "DateFrom": "01-01-0001",
                    "DateTo": "01-01-0001",
                    "SortOrder": 0,
                    "TriggerXml": "<?xml version=\"1.0\" encoding=\"utf-16\"?>\r\n<Rule xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" Operator=\"Any\" RuleType=\"Group\">\r\n  <Rules />\r\n  <Field />\r\n  <Condition />\r\n  <Value />\r\n</Rule>"
                }
            ]
        }
    ],
    "PageHeading": "Content LP"div>\r\n<div class=\"grid_12\">\r\n  {{WidgetZone}}\r\n</div>",
    "CustomHtmlAssetName": "test example used in automation testingicon_Column_25.gif",
    "Keywords": null,
    "ListName": null,
    "Notes": "",
    "IsNoIndex": false,
    "IsNoFollow": false,
    "StartDateCreateDate": "01-01-0001",
    "EndDateModifyDate": "01-01-0001"
}

Response

The response is an array of landing page layout objects, every object being a series of key-value pairs. For the description of the data, please refer to Using API to Create Get All Landing PagesPage Layout

PUT Methods

• PUT api/v9/LandingPagelandingPageLayout/{id}

  Update Landing Page with a particular Id.Updates a landing page content

  Parameters

  • id: Unique Id of the Landing Page an entity to update (FromUri)

  • value: Landing Page object (FromBody)

  • version: (FromUri)

• PUT api/v4/LandingPage/{guid}

  Update Landing Page with a particular Guid.

  Parameters

  • guid: Guid of the Landing Page (FromUri)

  • value: Landing Page object (FromBody)

  • version: (FromUri)

• PUT api/v9/LandingPage/url/{url}

  Update Landing Page with a particular Url.

  Parameters

  • url: Unique Url of the Landing Page (FromUri)

  • value: Landing Page object (FromBody)

  • version: (FromUri)

• PUT api/v9/LandingPage/bulk

  Update multiple Landing Pages at once.

  Parameters

  • pages: Collection of Landing Page objects to be updated (FromBody)

  • version: (FromUripageLayout: An entity with updated properties (FromBody)