Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Page Tree
root@self
expandCollapseAlltrue
startDepth2

Excerpt
hiddentrue

Landing Page

  • GET api/v9/LandingPage

    Retrieves all Landing Pages created in the System.

    Parameters

    • version: (FromUri)

  • GET api/v9/LandingPage/{id}

    Returns Landing Page with a particular Id.

    Parameters

    • id: Unique Id of the Landing Page (FromUri)

    • version: (FromUri)

  • GET api/v9/LandingPage/{guid}

    Returns Landing Page with a particular Id.

    Parameters

    • guid: Unique Id of the Landing Page (FromUri)

    • version: (FromUri)

  • GET api/v9/LandingPage/urls

    Retrieves list of all available Landing Page URLs

    Parameters

    • version: (FromUri)

  • GET api/v9/LandingPage/Custom

    Retrieves all values of the Custom field in pages

    Parameters

    • version: (FromUri)

  • POST api/v9/LandingPage

    Add new Landing Page.

    Parameters

    • value: Landing Page object (FromBody)

    • version: (FromUri)

  • POST api/v9/LandingPage/bulk

    Add multiple Landing Pages at once

    Parameters

    • pages: Collection of Landing Page objects (FromBody)

    • version: (FromUri)

  • PUT api/v9/LandingPage/{id}

    Update Landing Page with a particular Id.

    Parameters

    • id: Unique Id of the Landing Page (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: (FromUri)

  • DELETE api/v9/LandingPage/{id}

    Delete Landing Page with a particular Id.

    Parameters

    • id: Unique Id of the Landing Page (FromUri)

    • version: (FromUri)

  • DELETE api/v9/LandingPage/{guid}

    Delete Landing Page with a particular Guid.

    Parameters

    • guid: Guid of the Landing Page (FromUri)

    • version: (FromUri)

  • DELETE api/v9/LandingPage/bulk

    Delete multiple Landing Pages at once.

    Parameters

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

    • version: (FromUri)

  • DELETE api/v9/LandingPage/bulk/url

    Delete multiple Landing Pages at once.

    Parameters

    • pageUrls: Collection of Landing Page urls to delete (FromBody)

    • version: (FromUri)

  • DELETE api/v9/LandingPage/bulk/guid

    Delete multiple Landing Pages at once.

    Parameters

    • pages: Collection of Landing Page guids to delete (FromBody)

    • version: (FromUri)

  • GET api/v9/LandingPage/SortBy

    Retrieves Fields available for sorting.

    Parameters

    • version: (FromUri)

  • GET api/v9/LandingPage/AllFacets

    Retrieves All Facets available for display

    Parameters

    • version: (FromUri)

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

    Returns Landing Page with a particular custom url

    Parameters

    • url: Custom url of the Landing Page (FromUri)

    • version: (FromUri)

  • GET api/v9/LandingPage/custom/{custom}

    Get Landing Page entity by Custom field

    Parameters

    • custom: Custom field value (FromUri)

    • version: (FromUri)

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

    Delete Landing Page with a particular url

    Parameters

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

    • version: (FromUri)

  • DELETE api/v9/LandingPage/custom/{custom}

    Delete Landing Page by Custom field value

    Parameters

    • custom: Custom field value (FromUri)

    • version: (FromUri)

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

    No Documentation Found.

    Parameters

    • custom: No Documentation Found. (FromUri)

    • value: No Documentation Found. (FromBody)

    • version: (FromUri)

Landing Page Layout

  • GET api/v9/landingPageLayout

    Gets all landing page's layouts in the system

  • GET api/v9/landingPageLayout/{id}

    Gets a single landing page layout by its id

    Parameters

    • id: Id of a landing page layout (FromUri)

  • GET api/v9/landingPageLayout/{name}

    Gets a single landing page layout by its name

    Parameters

    • name: Name of a landing page layout (FromUri)

  • POST api/v9/landingPageLayout

    No Documentation Found.

    Parameters

    • newLayout: No Documentation Found. (FromBody)

  • PUT api/v9/landingPageLayout/{id}

    Updates a landing page content

    Parameters

    • id: Id of an entity to update (FromUri)

    • pageLayout: An entity with updated properties (FromBody)

  • DELETE api/v4/landingPageLayout/{id}

    Deletes a landing page layout

    Parameters

    • id: Id of an entity to delete (FromUri)