Web API: added RewardPointsHistory entity

Author: mgesing

src/Libraries/SmartStore.Core/Domain/Customers/Customer.cs

@@ -247,6 +247,7 @@ public virtual ICollection<Order> Orders
         /// <summary>
         /// Gets or sets reward points history
         /// </summary>
+        [DataMember]
         public virtual ICollection<RewardPointsHistory> RewardPointsHistory
         {
             get => _rewardPointsHistory ?? (_rewardPointsHistory = new HashSet<RewardPointsHistory>());

src/Libraries/SmartStore.Core/Domain/Customers/RewardPointsHistory.cs

@@ -1,51 +1,61 @@
 using System;
+using System.Runtime.Serialization;
 using SmartStore.Core.Domain.Orders;
 
 namespace SmartStore.Core.Domain.Customers
 {
     /// <summary>
     /// Represents a reward point history entry
     /// </summary>
+    [DataContract]
     public partial class RewardPointsHistory : BaseEntity
     {
         /// <summary>
         /// Gets or sets the customer identifier
         /// </summary>
+        [DataMember]
         public int CustomerId { get; set; }
 
         /// <summary>
         /// Gets or sets the points redeemed/added
         /// </summary>
+        [DataMember]
         public int Points { get; set; }
 
         /// <summary>
         /// Gets or sets the points balance
         /// </summary>
+        [DataMember]
         public int PointsBalance { get; set; }
 
         /// <summary>
         /// Gets or sets the used amount
         /// </summary>
+        [DataMember]
         public decimal UsedAmount { get; set; }
 
         /// <summary>
         /// Gets or sets the message
         /// </summary>
+        [DataMember]
         public string Message { get; set; }
 
         /// <summary>
         /// Gets or sets the date and time of instance creation
         /// </summary>
+        [DataMember]
         public DateTime CreatedOnUtc { get; set; }
 
         /// <summary>
         /// Gets or sets the order for which points were redeemed as a payment
         /// </summary>
+        [DataMember]
         public virtual Order UsedWithOrder { get; set; }
 
         /// <summary>
         /// Gets or sets the customer
         /// </summary>
+        [DataMember]
         public virtual Customer Customer { get; set; }
     }
 }

src/Libraries/SmartStore.Core/Domain/Orders/Order.cs

@@ -498,6 +498,7 @@ protected virtual SortedDictionary<decimal, decimal> ParseTaxRates(string taxRat
         /// <summary>
         /// Gets or sets the reward points history record
         /// </summary>
+        [DataMember]
         public virtual RewardPointsHistory RedeemedRewardPointsEntry { get; set; }
 
         /// <summary>

src/Plugins/SmartStore.WebApi/Controllers/OData/CustomersController.cs

@@ -215,6 +215,13 @@ public IHttpActionResult GetCustomerRoleMappings(int key)
             return Ok(GetRelatedCollection(key, x => x.CustomerRoleMappings));
         }
 
+        [WebApiQueryable]
+        [WebApiAuthenticate(Permission = Permissions.Order.Read)]
+        public IHttpActionResult GetRewardPointsHistory(int key)
+        {
+            return Ok(GetRelatedCollection(key, x => x.RewardPointsHistory));
+        }
+
         #endregion
     }
 }

src/Plugins/SmartStore.WebApi/Controllers/OData/OrdersController.cs

@@ -136,6 +136,13 @@ public IHttpActionResult GetOrderItems(int key)
             return Ok(GetRelatedCollection(key, x => x.OrderItems));
         }
 
+        [WebApiQueryable]
+        [WebApiAuthenticate(Permission = Permissions.Order.Read)]
+        public IHttpActionResult GetRedeemedRewardPointsEntry(int key)
+        {
+            return Ok(GetRelatedEntity(key, x => x.RedeemedRewardPointsEntry));
+        }
+
         #endregion
 
         #region Actions

src/Plugins/SmartStore.WebApi/Controllers/OData/RewardPointsHistoryController.cs

@@ -0,0 +1,72 @@
+using System.Net;
+using System.Web.Http;
+using SmartStore.Core.Domain.Customers;
+using SmartStore.Core.Security;
+using SmartStore.Services.Customers;
+using SmartStore.Web.Framework.WebApi.OData;
+using SmartStore.Web.Framework.WebApi.Security;
+
+namespace SmartStore.WebApi.Controllers.OData
+{
+    [IEEE754Compatible]
+    public class RewardPointsHistoryController : WebApiEntityController<RewardPointsHistory, ICustomerService>
+    {
+        [WebApiQueryable]
+        [WebApiAuthenticate(Permission = Permissions.Customer.Read)]
+        public IHttpActionResult Get()
+        {
+            return Ok(GetEntitySet());
+        }
+
+        [WebApiQueryable]
+        [WebApiAuthenticate(Permission = Permissions.Customer.Read)]
+        public IHttpActionResult Get(int key)
+        {
+            return Ok(GetByKey(key));
+        }
+
+        [WebApiAuthenticate(Permission = Permissions.Customer.Read)]
+        public IHttpActionResult GetProperty(int key, string propertyName)
+        {
+            return GetPropertyValue(key, propertyName);
+        }
+
+        public IHttpActionResult Post()
+        {
+            return StatusCode(HttpStatusCode.Forbidden);
+        }
+
+        public IHttpActionResult Put()
+        {
+            return StatusCode(HttpStatusCode.Forbidden);
+        }
+
+        public IHttpActionResult Patch()
+        {
+            return StatusCode(HttpStatusCode.Forbidden);
+        }
+
+        public IHttpActionResult Delete()
+        {
+            return StatusCode(HttpStatusCode.Forbidden);
+        }
+
+        #region Navigation properties
+
+        [WebApiQueryable]
+        [WebApiAuthenticate(Permission = Permissions.Customer.Read)]
+        public IHttpActionResult GetUsedWithOrder(int key)
+        {
+            return Ok(GetRelatedEntity(key, x => x.UsedWithOrder));
+        }
+
+        [WebApiQueryable]
+        [WebApiAuthenticate(Permission = Permissions.Customer.Read)]
+        public IHttpActionResult GetCustomer(int key)
+        {
+            return Ok(GetRelatedEntity(key, x => x.Customer));
+        }
+
+        #endregion
+    }
+}

src/Plugins/SmartStore.WebApi/SmartStore.WebApi.csproj

@@ -264,6 +264,7 @@
     <Compile Include="Controllers\OData\ProductVariantAttributesController.cs" />
     <Compile Include="Controllers\OData\QuantityUnitsController.cs" />
     <Compile Include="Controllers\OData\PaymentMethodsController.cs" />
+    <Compile Include="Controllers\OData\RewardPointsHistoryController.cs" />
     <Compile Include="Controllers\OData\ShipmentItemsController.cs" />
     <Compile Include="Controllers\OData\TaxCategoriesController.cs" />
     <Compile Include="Controllers\OData\SyncMappingsController.cs" />

src/Plugins/SmartStore.WebApi/WebApiConfigurationProvider.cs

@@ -80,6 +80,7 @@ public void Configure(WebApiConfigurationBroadcaster configData)
             m.EntitySet<QuantityUnit>("QuantityUnits");
             m.EntitySet<RelatedProduct>("RelatedProducts");
             m.EntitySet<ReturnRequest>("ReturnRequests");
+            m.EntitySet<RewardPointsHistory>("RewardPointsHistory");
             m.EntitySet<Setting>("Settings");
             m.EntitySet<Shipment>("Shipments");
             m.EntitySet<ShipmentItem>("ShipmentItems");