ServiceStack Home (Live)

<back to all web services

QueryProducts

Admin
Requires Authentication
Required role:Admin
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using MyApp.ServiceInterface;
using MyApp.ServiceModel;

namespace MyApp.ServiceInterface
{
    [ValidateRequest("IsAdmin")]
    public partial class QueryProducts
        : QueryDb<Product>
    {
    }

}

namespace MyApp.ServiceModel
{
    public partial class Customer
        : IAddress
    {
        public virtual int Id { get; set; }
        public virtual string Email { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string Company { get; set; }
        public virtual string PhoneNumber { get; set; }
        public virtual string AddressLine1 { get; set; }
        public virtual string AddressLine2 { get; set; }
        public virtual string AddressCity { get; set; }
        public virtual string AddressZip { get; set; }
        public virtual string AddressState { get; set; }
        public virtual string AddressCountry { get; set; }
        public virtual string StripeCustomerId { get; set; }
        public virtual string StripeCouponId { get; set; }
        public virtual string Plan { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual bool IsReferrer { get; set; }
        public virtual List<Order> Orders { get; set; }
        public virtual List<Subscription> Subscriptions { get; set; }
    }

    public partial class Order
        : IAddress
    {
        public virtual int Id { get; set; }
        public virtual int CustomerId { get; set; }
        public virtual string ProductName { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string Email { get; set; }
        public virtual string Company { get; set; }
        public virtual string PhoneNumber { get; set; }
        public virtual string AddressLine1 { get; set; }
        public virtual string AddressLine2 { get; set; }
        public virtual string AddressCity { get; set; }
        public virtual string AddressZip { get; set; }
        public virtual string AddressState { get; set; }
        public virtual string AddressCountry { get; set; }
        public virtual bool AgreeTerms { get; set; }
        public virtual string Notes { get; set; }
        public virtual string Last4 { get; set; }
        public virtual int SubTotal { get; set; }
        public virtual string CouponId { get; set; }
        public virtual int Discount { get; set; }
        public virtual int Tax { get; set; }
        public virtual int Total { get; set; }
        public virtual int ItemQuantity { get; set; }
        public virtual int? AuthorizedQuantity { get; set; }
        public virtual int? SubscriptionId { get; set; }
        public virtual string LicenseRef { get; set; }
        public virtual int? PaymentId { get; set; }
        public virtual int? EmailId { get; set; }
        public virtual bool Paid { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime ModifiedDate { get; set; }
        public virtual string ModifiedBy { get; set; }
        public virtual DateTime? CancelledDate { get; set; }
        public virtual string CancelledReason { get; set; }
        public virtual string IpAddress { get; set; }
        public virtual List<OrderDetail> OrderDetails { get; set; }
    }

    public partial class OrderDetail
    {
        public virtual int Id { get; set; }
        public virtual int OrderId { get; set; }
        public virtual int SkuId { get; set; }
        public virtual SkuType SkuType { get; set; }
        public virtual int Price { get; set; }
        public virtual string Description { get; set; }
        public virtual int Quantity { get; set; }
        public virtual int Total { get; set; }
    }

    public partial class Product
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime ModifiedDate { get; set; }
        public virtual List<Sku> Skus { get; set; }
        public virtual bool Active { get; set; }
    }

    public partial class Sku
    {
        public virtual int Id { get; set; }
        public virtual int ProductId { get; set; }
        public virtual SkuType Type { get; set; }
        public virtual LicenseFeature Feature { get; set; }
        public virtual string Code { get; set; }
        public virtual string Name { get; set; }
        public virtual string Notes { get; set; }
        [Ignore]
        public virtual int? MinQty { get; set; }

        public virtual int? MaxQty { get; set; }
        public virtual int Price { get; set; }
        public virtual string Plan { get; set; }
        public virtual int DiscountOff { get; set; }
        public virtual string DiscountLabelOff { get; set; }
        public virtual int ActualPrice { get; set; }
        public virtual bool IsPlan { get; set; }
        public virtual bool IsRenewal { get; set; }
        public virtual int? SubscriptionDurationDays { get; set; }
        public virtual int? ExpiryDurationDays { get; set; }
        public virtual int? TrialPeriodDays { get; set; }
        public virtual int SupportQty { get; set; }
        public virtual int? CoresQty { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime ModifiedDate { get; set; }
        public virtual LicenseType LicenseType { get; set; }
        public virtual bool Active { get; set; }
    }

    public enum SkuType
    {
        Product,
        PerDev,
        PerCore,
        Site,
        Support,
        Training,
        Register,
        Payment,
    }

    public partial class Subscription
    {
        public virtual int Id { get; set; }
        public virtual int CustomerId { get; set; }
        public virtual string Email { get; set; }
        public virtual int SkuId { get; set; }
        public virtual string SkuName { get; set; }
        public virtual SkuType SkuType { get; set; }
        public virtual string Code { get; set; }
        public virtual int Quantity { get; set; }
        public virtual int SupportQuantity { get; set; }
        public virtual int Total { get; set; }
        public virtual bool IsPlan { get; set; }
        public virtual bool IsRenewal { get; set; }
        public virtual int SubscriptionDurationDays { get; set; }
        public virtual DateTime? RenewalDate { get; set; }
        public virtual string LicenseRef { get; set; }
        public virtual string LicenseName { get; set; }
        public virtual string LicenseAddress { get; set; }
        public virtual LicenseType LicenseType { get; set; }
        public virtual DateTime ExpiryDate { get; set; }
        public virtual LicenseKey LicenseKey { get; set; }
        public virtual string LicenseKeyText { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual DateTime ModifiedDate { get; set; }
        public virtual DateTime? CancelledDate { get; set; }
        public virtual string StripeSubscriptionId { get; set; }
        public virtual int? EmailId { get; set; }
        public virtual int? EmailRenewalId { get; set; }
        public virtual int? EmailExpiredId { get; set; }
        public virtual int? RenewalSubscriptionId { get; set; }
        public virtual string ExternalRef { get; set; }
        public virtual string Notes { get; set; }
        public virtual string Error { get; set; }
    }

}

namespace ServiceStack
{
    [Flags]
    public enum LicenseFeature
    {
        None = 0,
        Free = 0,
        Premium = 1,
        Text = 2,
        Client = 4,
        Common = 8,
        Redis = 16,
        RedisSku = 18,
        OrmLite = 32,
        OrmLiteSku = 34,
        ServiceStack = 64,
        Server = 128,
        Razor = 256,
        Admin = 512,
        Aws = 1024,
        AwsSku = 1026,
        All = 2047,
    }

    public partial class LicenseKey
    {
        public virtual string Ref { get; set; }
        public virtual string Name { get; set; }
        public virtual LicenseType Type { get; set; }
        public virtual long Meta { get; set; }
        public virtual string Hash { get; set; }
        public virtual string Halg { get; set; }
        public virtual DateTime Expiry { get; set; }
    }

    public enum LicenseType
    {
        Free,
        FreeIndividual,
        FreeOpenSource,
        Indie,
        Business,
        Enterprise,
        TextIndie,
        TextBusiness,
        OrmLiteIndie,
        OrmLiteBusiness,
        RedisIndie,
        RedisBusiness,
        AwsIndie,
        AwsBusiness,
        Trial,
        Site,
        TextSite,
        RedisSite,
        OrmLiteSite,
    }

    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string Include { get; set; }

        [DataMember(Order=6)]
        public virtual string Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    public partial class QueryDb<T>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<Customer> Results { get; set; } = [];

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# QueryProducts DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/QueryProducts HTTP/1.1 
Host: account.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryProducts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceInterface">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</QueryProducts>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfProducttlJ4_P31p xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
    <d2p1:Product>
      <d2p1:Active>false</d2p1:Active>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Skus>
        <d2p1:Sku>
          <d2p1:Active>false</d2p1:Active>
          <d2p1:Code>String</d2p1:Code>
          <d2p1:CoresQty>0</d2p1:CoresQty>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:DiscountLabelOff>String</d2p1:DiscountLabelOff>
          <d2p1:DiscountOff>0</d2p1:DiscountOff>
          <d2p1:ExpiryDurationDays>0</d2p1:ExpiryDurationDays>
          <d2p1:Feature>None</d2p1:Feature>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsPlan>false</d2p1:IsPlan>
          <d2p1:IsRenewal>false</d2p1:IsRenewal>
          <d2p1:LicenseType>Free</d2p1:LicenseType>
          <d2p1:MaxQty>0</d2p1:MaxQty>
          <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
          <d2p1:Name>String</d2p1:Name>
          <d2p1:Notes>String</d2p1:Notes>
          <d2p1:Plan>String</d2p1:Plan>
          <d2p1:Price>0</d2p1:Price>
          <d2p1:ProductId>0</d2p1:ProductId>
          <d2p1:SubscriptionDurationDays>0</d2p1:SubscriptionDurationDays>
          <d2p1:SupportQty>0</d2p1:SupportQty>
          <d2p1:TrialPeriodDays>0</d2p1:TrialPeriodDays>
          <d2p1:Type>Product</d2p1:Type>
        </d2p1:Sku>
      </d2p1:Skus>
    </d2p1:Product>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfProducttlJ4_P31p>