RecommendationManager

Delete

Delete(System.Int64)

Deletes a recommendation.

Authenticated users

• CMS Administrators
• Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

• * Recommendation ID

Parameters

• recommendationId. ID of recommendation to delete.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxRecommendationIdLabel" AssociatedControlID="uxRecommendationId" CssClass="span-4 last"
            runat="server" Text="* RecommendationId :" />
        <ektronUI:TextField ID="uxRecommendationId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>                    
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            RecommendationManager recommendationManager = new RecommendationManager();
            long recommendationId;
            long.TryParse(uxRecommendationId.Text, out recommendationId);
            if (recommendationId > 0)
            {
                RecommendationItemData recommendationItemData = recommendationManager.GetItem(recommendationId);
                if (recommendationItemData != null && recommendationItemData.Id > 0)
                {
                    recommendationManager.Delete(recommendationId);
                    MessageUtilities.UpdateMessage(uxMessage, "Recommendation is Deleted for the Id " + recommendationItemData.Id.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Recommendation Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Recommendation Id", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

DeleteByEntry

DeleteByEntry(System.Int64)

Delete recommendations associated with a catalog entry.

Authenticated users

• CMS Administrators
• Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

• * Entry ID

Parameters

• entryId. ID of entry for which to delete recommendations.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryId" CssClass="span-4 last"
            runat="server" Text="* EntryId :" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Delete"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            RecommendationManager recommendationManager = new RecommendationManager();
            long entryId;
            long.TryParse(uxEntryId.Text, out entryId);
            if (entryId > 0)
            {
                CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
                EntryData entryData = catalogEntryManager.GetItem(entryId);
                if (entryData != null && entryData.Id > 0)
                {
                    recommendationManager.DeleteByEntry(entryId);
                    MessageUtilities.UpdateMessage(uxMessage, "Recommendations are Deleted for the Entry Id " + entryData.Id.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Entry Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Entry Id", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetItem

GetItem(System.Int64)

Retrieves a recommendation by id.

Authenticated users

• CMS Administrators
• Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

• * Recommendation ID

Parameters

• recommendationId. ID of recommendation to retrieve.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxRecommendationIdLabel" AssociatedControlID="uxRecommendationId" CssClass="span-4 last"
            runat="server" Text="* RecommendationId :" />
        <ektronUI:TextField ID="uxRecommendationId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>                    
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetItem"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<ol class="formFields">
    <li class="clearfix">
        <asp:Literal ID="uxMessage" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxEntryId" runat="server"></asp:Literal>
    </li>
    <li class="clearfix">
        <asp:Literal ID="uxGroupId" runat="server"></asp:Literal>
    </li>
</ol>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            RecommendationManager recommendationManager = new RecommendationManager();
            long recommendationId;
            long.TryParse(uxRecommendationId.Text, out recommendationId);
            if (recommendationId > 0)
            {
                RecommendationItemData recommendationItemData = recommendationManager.GetItem(recommendationId);
                if (recommendationItemData != null && recommendationItemData.Id > 0)
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Recommendation Details for the Id " + recommendationItemData.Id.ToString(), Message.DisplayModes.Success);
                    uxEntryId.Text = "Entry Id : " + recommendationItemData.EntryId.ToString();
                    uxGroupId.Text = "Group Id : " + recommendationItemData.GroupId.ToString();
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Recommendation Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Recommendation Id", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

GetList

GetList(System.Int64,System.Int64,Ektron.Cms.Common.EkEnumeration.RecommendationType)

Retrieves a list of RecommendationItemData objects based upon the supplied criteria.

Authenticated users

• CMS Administrators
• Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

• * Entry ID
• * Entry Language
• * Recommendation Type

Parameters

• entryId. Catalog entry ID.
• entryLanguage. Catalog entry language.
• type. Recommendation type.

Returns

Returns list of RecommendationItemData which are matches the criteria.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdLabel" AssociatedControlID="uxEntryId" CssClass="span-4 last"
            runat="server" Text="* EntryId :" />
        <ektronUI:TextField ID="uxEntryId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryLanguageLabel" AssociatedControlID="uxEntryLanguage" CssClass="span-4 last"
            runat="server" Text="* EntryLanguage :" />
        <ektronUI:TextField ID="uxEntryLanguage" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxRecommendationTypeLabel" AssociatedControlID="uxRecommendationType"
            CssClass="span-4 last" runat="server" Text="* RecommendationType :" />
        <asp:DropDownList ID="uxRecommendationType" runat="server">
            <asp:ListItem>CrossSell</asp:ListItem>
            <asp:ListItem>UpSell</asp:ListItem>
        </asp:DropDownList>
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="GetList"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
 
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>
 
<asp:ListView ID="uxRecommendationList" runat="server" ItemPlaceholderID="aspItemPlaceholder">
    <EmptyDataTemplate>
        Criteria did not match any records.</EmptyDataTemplate>
    <LayoutTemplate>
        <table class="devsite-api-method">
            <thead>
                <tr>
                    <th>
                        Id
                    </th>
                    <th>
                        EntryId
                    </th>
                    <th>
                        GroupId
                    </th>
                </tr>
            </thead>
            <tbody>
                <asp:PlaceHolder ID="aspItemPlaceholder" runat="server"></asp:PlaceHolder>
            </tbody>
        </table>
    </LayoutTemplate>
    <ItemTemplate>
        <tr>
            <td class="devsite-method">
                <%# Eval("Id")%>
            </td>
            <td class="devsite-method">
                <%# Eval("EntryId")%>
            </td>
            <td class="devsite-method">
                <%# Eval("GroupId")%>
            </td>
        </tr>
    </ItemTemplate>
</asp:ListView>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            RecommendationManager recommendationManager = new RecommendationManager();
            long entryId;
            long.TryParse(uxEntryId.Text, out entryId);
            long entryLanguage;
            long.TryParse(uxEntryLanguage.Text, out entryLanguage);
            string recommendationType = uxRecommendationType.SelectedItem.Text;
            if (entryId > 0 && entryLanguage > 0)
            {
                CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
                EntryData entryData = catalogEntryManager.GetItem(entryId);
                if (entryData != null && entryData.Id > 0)
                {
                    List<RecommendationItemData> recommendationItemDataList = null;
                    if (recommendationType == "CrossSell")
                    {
                        recommendationItemDataList = recommendationManager.GetList(entryId, entryLanguage, Ektron.Cms.Common.EkEnumeration.RecommendationType.CrossSell);
                    }
                    else
                    {
                        recommendationItemDataList = recommendationManager.GetList(entryId, entryLanguage, Ektron.Cms.Common.EkEnumeration.RecommendationType.Upsell);
                    }
                    uxRecommendationList.DataSource = recommendationItemDataList;
                    uxRecommendationList.DataBind();
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid Entry Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

UpdateCrossSell

UpdateCrossSell(System.Int64,System.Collections.Generic.IEnumerable)

Updates the CrossSell.

Authenticated users

• CMS Administrators
• Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

• * CrossSell Entry ID
• * Entry IDs (Comma Separated)

Parameters

• entryId. ID of entry.
• recommendations. Enumerable of RecommendationItemData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxCrossSellEntryIdLabel" AssociatedControlID="uxCrossSellEntryId" CssClass="span-4 last"
            runat="server" Text="* CrossSell EntryId :" />
        <ektronUI:TextField ID="uxCrossSellEntryId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdsLabel" AssociatedControlID="uxEntryIds" CssClass="span-4 last"
            runat="server" Text="* EntryIds (Comma Seperated) :" />
        <ektronUI:TextField ID="uxEntryIds" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            RecommendationManager recommendationManager = new RecommendationManager();
            long crossSellEntryId;
            long.TryParse(uxCrossSellEntryId.Text, out crossSellEntryId);
            string entryIds = uxEntryIds.Text;
            if (crossSellEntryId > 0 && entryIds != "")
            {
                CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
                EntryData entryData = catalogEntryManager.GetItem(crossSellEntryId);
                if (entryData != null && entryData.Id > 0)
                {
                    string[] entryIdArray = entryIds.Split(new char[]{','});
                    RecommendationItemData[] recommendationItemDataArray = new RecommendationItemData[entryIdArray.Length];
                    for(int i = 0; i < entryIdArray.Length; i++ )
                    {
                        recommendationItemDataArray[i] = new RecommendationItemData();
                        recommendationItemDataArray[i].EntryId = long.Parse(entryIdArray[i]);
                    }
                    recommendationManager.UpdateCrossSell(crossSellEntryId, recommendationItemDataArray);
                    MessageUtilities.UpdateMessage(uxMessage, "EntryIds are Updated to the CrossSell of EntryId " + crossSellEntryId.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid CrossSell Entry Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

UpdateUpSell

UpdateUpSell(System.Int64,System.Collections.Generic.IEnumerable)

Updates the UpSell.

Authenticated users

• CMS Administrators
• Users that have access permission

To create anonymous user access with this method, set the API access mode (ApiMode) in the Manager class when instantiating the class.

Fields

*=Required

• * UpSell Entry ID
• * Entry IDs (Comma Separated)

Parameters

• entryId. ID of entry.
• recommendations. Enumerable of RecommendationItemData object.

.aspx code snippet

<ol class="formFields">
    <li class="clearfix">
        <ektronUI:Label ID="uxUpSellEntryIdLabel" AssociatedControlID="uxUpSellEntryId" CssClass="span-4 last"
            runat="server" Text="* UpSell EntryId :" />
        <ektronUI:TextField ID="uxUpSellEntryId" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup"
            Text="0" />
    </li>
    <li class="clearfix">
        <ektronUI:Label ID="uxEntryIdsLabel" AssociatedControlID="uxEntryIds" CssClass="span-4 last"
            runat="server" Text="* EntryIds (Comma Seperated) :" />
        <ektronUI:TextField ID="uxEntryIds" CssClass="span-4" runat="server" ValidationGroup="RegisterValidationGroup" />
    </li>
    <li class="clearfix">
        <ektronUI:Button ID="uxSubmit" runat="server" OnClick="uxSubmit_Click" Text="Update"></ektronUI:Button>
        <ektronUI:Label ID="uxRequiredLabel" CssClass="span-4" runat="server" Text="* - Required" />
    </li>
</ol>
<asp:Literal ID="uxMessage" runat="server"></asp:Literal>

.aspx.cs code-behind namespace

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using Ektron.Site;
using Ektron.Cms;
using Ektron.Cms.Framework.Commerce;
using Ektron.Cms.Commerce;

.aspx.cs code-behind method

protected void uxSubmit_Click(object sender, EventArgs e)
    {
        try
        {
            RecommendationManager recommendationManager = new RecommendationManager();
            long upSellEntryId;
            long.TryParse(uxUpSellEntryId.Text, out upSellEntryId);
            string entryIds = uxEntryIds.Text;
            if (upSellEntryId > 0 && entryIds != "")
            {
                CatalogEntryManager catalogEntryManager = new CatalogEntryManager();
                EntryData entryData = catalogEntryManager.GetItem(upSellEntryId);
                if (entryData != null && entryData.Id > 0)
                {
                    string[] entryIdArray = entryIds.Split(new char[] { ',' });
                    RecommendationItemData[] recommendationItemDataArray = new RecommendationItemData[entryIdArray.Length];
                    for (int i = 0; i < entryIdArray.Length; i++)
                    {
                        recommendationItemDataArray[i] = new RecommendationItemData();
                        recommendationItemDataArray[i].EntryId = long.Parse(entryIdArray[i]);
                    }
                    recommendationManager.UpdateUpSell(upSellEntryId, recommendationItemDataArray);
                    MessageUtilities.UpdateMessage(uxMessage, "EntryIds are Updated to the UpSell of EntryId " + upSellEntryId.ToString(), Message.DisplayModes.Success);
                }
                else
                {
                    MessageUtilities.UpdateMessage(uxMessage, "Please enter valid UpSell Entry Id", Message.DisplayModes.Error);
                }
            }
            else
            {
                MessageUtilities.UpdateMessage(uxMessage, "Please enter valid values for required fields", Message.DisplayModes.Error);
            }
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
        catch (Exception ex)
        {
            MessageUtilities.UpdateMessage(uxMessage, ex.Message, Message.DisplayModes.Error);
            uxPageMultiView.SetActiveView(uxViewMessage);
        }
    }

RecommendationItemData

Namespace

Ektron.Cms.Commerce

Constructors

• EntryLanguage. Gets or sets the language of the entry.

  public long EntryLanguage { set; get; }

• EntryType. Gets or sets the entry type associated with this recommendation.

  public EkEnumeration.CatalogEntryType EntryType { set; get; }

• Html. Gets or sets the HTML of the recommendation.

  public string Html { set; get; }

• Image. Gets or sets the image associated with the recommendation.

  public string Image { set; get; }

• ImageThumbnail. Gets or sets the image thumbnail associated with the recommendation.

  public string ImageThumbnail { set; get; }

• Media

  public Ektron.Cms.MediaGalleryData Media { set; get; }

• Pricing. The entry pricing, including currencies and quantity. Returns PricingData of the catalog entry.

  public Ektron.Cms.Commerce.PricingData Pricing { set; get; }

• Quicklink. Gets or sets the quicklink of the recommendation.

  public string Quicklink { set; get; }

• RecommendationItemData()

  public RecommendationItemData()

• RecommendationItemData(long, long, long, EkEnumeration.RecommendationType)

  public RecommendationItemData(long id, long entryId,
     long entryLanguage, EkEnumeration.RecommendationType
     recommendationType)

• Summary. Gets or sets the summary of the recommendation.

  public string Summary { set; get; }

• Title. Gets or sets the title of the recommendation.

  public string Title { set; get; }

• Type. Gets or sets the type of recommendation.

  public EkEnumeration.RecommendationType Type { set; get; }

RecommendationType

Namespace

Ektron.Cms.Commerce

Properties

• CrossSell

  Public Const CrossSell
     As Ektron.Cms.Common.EkEnumeration.RecommendationType = 0

• Upsell

  public Const Upsell 
    As Ektron.Cms.Common.EkEnumeration.RecommendationType = 1