ServiceStack Home (Live)

QueryCustomers

Admin

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
All Verbs	/query/customers

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@ValidateRequest(Validator="IsAdmin")
@AutoQueryViewer(DefaultFields="Id,Name,Email,DisplayName,FirstName,LastName,Company,CreatedDate,Plan,IsReferrer", DefaultSearchField="Email", DefaultSearchType="Contains", IconUrl="material-icons:person", Title="Customers")
open class QueryCustomers : QueryDb<Customer>()
{
}

open class QueryDb<T> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    open var skip:Int? = null

    @DataMember(Order=2)
    open var take:Int? = null

    @DataMember(Order=3)
    open var orderBy:String? = null

    @DataMember(Order=4)
    open var orderByDesc:String? = null

    @DataMember(Order=5)
    open var include:String? = null

    @DataMember(Order=6)
    open var fields:String? = null

    @DataMember(Order=7)
    open var meta:HashMap<String,String>? = null
}

open class Customer : IAddress
{
    open var id:Int? = null
    open var email:String? = null
    open var displayName:String? = null
    open var firstName:String? = null
    open var lastName:String? = null
    open var company:String? = null
    open var phoneNumber:String? = null
    override var addressLine1:String? = null
    override var addressLine2:String? = null
    override var addressCity:String? = null
    override var addressZip:String? = null
    override var addressState:String? = null
    override var addressCountry:String? = null
    open var stripeCustomerId:String? = null
    open var stripeCouponId:String? = null
    open var plan:String? = null
    open var createdDate:Date? = null
    open var isReferrer:Boolean? = null
    open var orders:ArrayList<Order>? = null
    open var subscriptions:ArrayList<Subscription>? = null
}

open class Order : IAddress
{
    open var id:Int? = null
    open var customerId:Int? = null
    open var productName:String? = null
    open var firstName:String? = null
    open var lastName:String? = null
    open var email:String? = null
    open var company:String? = null
    open var phoneNumber:String? = null
    override var addressLine1:String? = null
    override var addressLine2:String? = null
    override var addressCity:String? = null
    override var addressZip:String? = null
    override var addressState:String? = null
    override var addressCountry:String? = null
    open var agreeTerms:Boolean? = null
    open var notes:String? = null
    open var last4:String? = null
    open var subTotal:Int? = null
    open var couponId:String? = null
    open var discount:Int? = null
    open var tax:Int? = null
    open var total:Int? = null
    open var itemQuantity:Int? = null
    open var authorizedQuantity:Int? = null
    open var subscriptionId:Int? = null
    open var licenseRef:String? = null
    open var paymentId:Int? = null
    open var emailId:Int? = null
    open var paid:Boolean? = null
    open var createdDate:Date? = null
    open var modifiedDate:Date? = null
    open var modifiedBy:String? = null
    open var cancelledDate:Date? = null
    open var cancelledReason:String? = null
    open var ipAddress:String? = null
    open var orderDetails:ArrayList<OrderDetail>? = null
}

open class OrderDetail
{
    open var id:Int? = null
    open var orderId:Int? = null
    open var skuId:Int? = null
    open var skuType:SkuType? = null
    open var price:Int? = null
    open var description:String? = null
    open var quantity:Int? = null
    open var total:Int? = null
}

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

open class Subscription
{
    open var id:Int? = null
    open var customerId:Int? = null
    open var email:String? = null
    open var skuId:Int? = null
    open var skuName:String? = null
    open var skuType:SkuType? = null
    open var code:String? = null
    open var quantity:Int? = null
    open var supportQuantity:Int? = null
    open var total:Int? = null
    open var isPlan:Boolean? = null
    open var isRenewal:Boolean? = null
    open var subscriptionDurationDays:Int? = null
    open var renewalDate:Date? = null
    open var licenseRef:String? = null
    open var licenseName:String? = null
    open var licenseAddress:String? = null
    open var licenseType:LicenseType? = null
    open var expiryDate:Date? = null
    open var licenseKey:LicenseKey? = null
    open var licenseKeyText:String? = null
    open var createdDate:Date? = null
    open var modifiedDate:Date? = null
    open var cancelledDate:Date? = null
    open var stripeSubscriptionId:String? = null
    open var emailId:Int? = null
    open var emailRenewalId:Int? = null
    open var emailExpiredId:Int? = null
    open var renewalSubscriptionId:Int? = null
    open var externalRef:String? = null
    open var notes:String? = null
    open var error:String? = null
}

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

open class LicenseKey
{
    open var ref:String? = null
    open var name:String? = null
    @SerializedName("type") open var Type:LicenseType? = null
    open var meta:Long? = null
    open var hash:String? = null
    open var halg:String? = null
    open var expiry:Date? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    open var offset:Int? = null

    @DataMember(Order=2)
    open var total:Int? = null

    @DataMember(Order=3)
    open var results:ArrayList<Customer> = ArrayList<Customer>()

    @DataMember(Order=4)
    open var meta:HashMap<String,String>? = null

    @DataMember(Order=5)
    open var responseStatus:ResponseStatus? = null
}

Kotlin QueryCustomers 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 /query/customers HTTP/1.1 
Host: account.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryCustomers 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>
</QueryCustomers>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCustomertlJ4_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:Customer>
      <d2p1:AddressCity>String</d2p1:AddressCity>
      <d2p1:AddressCountry>String</d2p1:AddressCountry>
      <d2p1:AddressLine1>String</d2p1:AddressLine1>
      <d2p1:AddressLine2>String</d2p1:AddressLine2>
      <d2p1:AddressState>String</d2p1:AddressState>
      <d2p1:AddressZip>String</d2p1:AddressZip>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsReferrer>false</d2p1:IsReferrer>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:Orders>
        <d2p1:Order>
          <d2p1:AddressCity>String</d2p1:AddressCity>
          <d2p1:AddressCountry>String</d2p1:AddressCountry>
          <d2p1:AddressLine1>String</d2p1:AddressLine1>
          <d2p1:AddressLine2>String</d2p1:AddressLine2>
          <d2p1:AddressState>String</d2p1:AddressState>
          <d2p1:AddressZip>String</d2p1:AddressZip>
          <d2p1:AgreeTerms>false</d2p1:AgreeTerms>
          <d2p1:AuthorizedQuantity>0</d2p1:AuthorizedQuantity>
          <d2p1:CancelledDate>0001-01-01T00:00:00</d2p1:CancelledDate>
          <d2p1:CancelledReason>String</d2p1:CancelledReason>
          <d2p1:Company>String</d2p1:Company>
          <d2p1:CouponId>String</d2p1:CouponId>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:CustomerId>0</d2p1:CustomerId>
          <d2p1:Discount>0</d2p1:Discount>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:EmailId>0</d2p1:EmailId>
          <d2p1:FirstName>String</d2p1:FirstName>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IpAddress>String</d2p1:IpAddress>
          <d2p1:ItemQuantity>0</d2p1:ItemQuantity>
          <d2p1:Last4>String</d2p1:Last4>
          <d2p1:LastName>String</d2p1:LastName>
          <d2p1:LicenseRef>String</d2p1:LicenseRef>
          <d2p1:ModifiedBy>String</d2p1:ModifiedBy>
          <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
          <d2p1:Notes>String</d2p1:Notes>
          <d2p1:OrderDetails>
            <d2p1:OrderDetail>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:OrderId>0</d2p1:OrderId>
              <d2p1:Price>0</d2p1:Price>
              <d2p1:Quantity>0</d2p1:Quantity>
              <d2p1:SkuId>0</d2p1:SkuId>
              <d2p1:SkuType>Product</d2p1:SkuType>
              <d2p1:Total>0</d2p1:Total>
            </d2p1:OrderDetail>
          </d2p1:OrderDetails>
          <d2p1:Paid>false</d2p1:Paid>
          <d2p1:PaymentId>0</d2p1:PaymentId>
          <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
          <d2p1:ProductName>String</d2p1:ProductName>
          <d2p1:SubTotal>0</d2p1:SubTotal>
          <d2p1:SubscriptionId>0</d2p1:SubscriptionId>
          <d2p1:Tax>0</d2p1:Tax>
          <d2p1:Total>0</d2p1:Total>
        </d2p1:Order>
      </d2p1:Orders>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:Plan>String</d2p1:Plan>
      <d2p1:StripeCouponId>String</d2p1:StripeCouponId>
      <d2p1:StripeCustomerId>String</d2p1:StripeCustomerId>
      <d2p1:Subscriptions>
        <d2p1:Subscription>
          <d2p1:CancelledDate>0001-01-01T00:00:00</d2p1:CancelledDate>
          <d2p1:Code>String</d2p1:Code>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:CustomerId>0</d2p1:CustomerId>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:EmailExpiredId>0</d2p1:EmailExpiredId>
          <d2p1:EmailId>0</d2p1:EmailId>
          <d2p1:EmailRenewalId>0</d2p1:EmailRenewalId>
          <d2p1:Error>String</d2p1:Error>
          <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
          <d2p1:ExternalRef>String</d2p1:ExternalRef>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsPlan>false</d2p1:IsPlan>
          <d2p1:IsRenewal>false</d2p1:IsRenewal>
          <d2p1:LicenseAddress>String</d2p1:LicenseAddress>
          <d2p1:LicenseKey xmlns:d6p1="http://schemas.datacontract.org/2004/07/ServiceStack">
            <d6p1:Expiry>0001-01-01T00:00:00</d6p1:Expiry>
            <d6p1:Halg>String</d6p1:Halg>
            <d6p1:Hash>String</d6p1:Hash>
            <d6p1:Meta>0</d6p1:Meta>
            <d6p1:Name>String</d6p1:Name>
            <d6p1:Ref>String</d6p1:Ref>
            <d6p1:Type>Free</d6p1:Type>
          </d2p1:LicenseKey>
          <d2p1:LicenseKeyText>String</d2p1:LicenseKeyText>
          <d2p1:LicenseName>String</d2p1:LicenseName>
          <d2p1:LicenseRef>String</d2p1:LicenseRef>
          <d2p1:LicenseType>Free</d2p1:LicenseType>
          <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
          <d2p1:Notes>String</d2p1:Notes>
          <d2p1:Quantity>0</d2p1:Quantity>
          <d2p1:RenewalDate>0001-01-01T00:00:00</d2p1:RenewalDate>
          <d2p1:RenewalSubscriptionId>0</d2p1:RenewalSubscriptionId>
          <d2p1:SkuId>0</d2p1:SkuId>
          <d2p1:SkuName>String</d2p1:SkuName>
          <d2p1:SkuType>Product</d2p1:SkuType>
          <d2p1:StripeSubscriptionId>String</d2p1:StripeSubscriptionId>
          <d2p1:SubscriptionDurationDays>0</d2p1:SubscriptionDurationDays>
          <d2p1:SupportQuantity>0</d2p1:SupportQuantity>
          <d2p1:Total>0</d2p1:Total>
        </d2p1:Subscription>
      </d2p1:Subscriptions>
    </d2p1:Customer>
  </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>
</QueryResponseOfCustomertlJ4_P31p>