| Required role: | Admin |
| All Verbs | /query/customers |
|---|
namespace MyApp.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type SkuType =
| Product = 0
| PerDev = 1
| PerCore = 2
| Site = 3
| Support = 4
| Training = 5
| Register = 6
| Payment = 7
[<AllowNullLiteral>]
type OrderDetail() =
member val Id:Int32 = new Int32() with get,set
member val OrderId:Int32 = new Int32() with get,set
member val SkuId:Int32 = new Int32() with get,set
member val SkuType:SkuType = new SkuType() with get,set
member val Price:Int32 = new Int32() with get,set
member val Description:String = null with get,set
member val Quantity:Int32 = new Int32() with get,set
member val Total:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type Order() =
member val Id:Int32 = new Int32() with get,set
member val CustomerId:Int32 = new Int32() with get,set
member val ProductName:String = null with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Email:String = null with get,set
member val Company:String = null with get,set
member val PhoneNumber:String = null with get,set
member val AddressLine1:String = null with get,set
member val AddressLine2:String = null with get,set
member val AddressCity:String = null with get,set
member val AddressZip:String = null with get,set
member val AddressState:String = null with get,set
member val AddressCountry:String = null with get,set
member val AgreeTerms:Boolean = new Boolean() with get,set
member val Notes:String = null with get,set
member val Last4:String = null with get,set
member val SubTotal:Int32 = new Int32() with get,set
member val CouponId:String = null with get,set
member val Discount:Int32 = new Int32() with get,set
member val Tax:Int32 = new Int32() with get,set
member val Total:Int32 = new Int32() with get,set
member val ItemQuantity:Int32 = new Int32() with get,set
member val AuthorizedQuantity:Nullable<Int32> = new Nullable<Int32>() with get,set
member val SubscriptionId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val LicenseRef:String = null with get,set
member val PaymentId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val EmailId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Paid:Boolean = new Boolean() with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val ModifiedDate:DateTime = new DateTime() with get,set
member val ModifiedBy:String = null with get,set
member val CancelledDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CancelledReason:String = null with get,set
member val IpAddress:String = null with get,set
member val OrderDetails:ResizeArray<OrderDetail> = null with get,set
type LicenseType =
| Free = 0
| FreeIndividual = 1
| FreeOpenSource = 2
| Indie = 3
| Business = 4
| Enterprise = 5
| TextIndie = 6
| TextBusiness = 7
| OrmLiteIndie = 8
| OrmLiteBusiness = 9
| RedisIndie = 10
| RedisBusiness = 11
| AwsIndie = 12
| AwsBusiness = 13
| Trial = 14
| Site = 15
| TextSite = 16
| RedisSite = 17
| OrmLiteSite = 18
[<AllowNullLiteral>]
type LicenseKey() =
member val Ref:String = null with get,set
member val Name:String = null with get,set
member val Type:LicenseType = new LicenseType() with get,set
member val Meta:Int64 = new Int64() with get,set
member val Hash:String = null with get,set
member val Halg:String = null with get,set
member val Expiry:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type Subscription() =
member val Id:Int32 = new Int32() with get,set
member val CustomerId:Int32 = new Int32() with get,set
member val Email:String = null with get,set
member val SkuId:Int32 = new Int32() with get,set
member val SkuName:String = null with get,set
member val SkuType:SkuType = new SkuType() with get,set
member val Code:String = null with get,set
member val Quantity:Int32 = new Int32() with get,set
member val SupportQuantity:Int32 = new Int32() with get,set
member val Total:Int32 = new Int32() with get,set
member val IsPlan:Boolean = new Boolean() with get,set
member val IsRenewal:Boolean = new Boolean() with get,set
member val SubscriptionDurationDays:Int32 = new Int32() with get,set
member val RenewalDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LicenseRef:String = null with get,set
member val LicenseName:String = null with get,set
member val LicenseAddress:String = null with get,set
member val LicenseType:LicenseType = new LicenseType() with get,set
member val ExpiryDate:DateTime = new DateTime() with get,set
member val LicenseKey:LicenseKey = null with get,set
member val LicenseKeyText:String = null with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val ModifiedDate:DateTime = new DateTime() with get,set
member val CancelledDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val StripeSubscriptionId:String = null with get,set
member val EmailId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val EmailRenewalId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val EmailExpiredId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RenewalSubscriptionId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ExternalRef:String = null with get,set
member val Notes:String = null with get,set
member val Error:String = null with get,set
[<AllowNullLiteral>]
type Customer() =
member val Id:Int32 = new Int32() with get,set
member val Email:String = null with get,set
member val DisplayName:String = null with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Company:String = null with get,set
member val PhoneNumber:String = null with get,set
member val AddressLine1:String = null with get,set
member val AddressLine2:String = null with get,set
member val AddressCity:String = null with get,set
member val AddressZip:String = null with get,set
member val AddressState:String = null with get,set
member val AddressCountry:String = null with get,set
member val StripeCustomerId:String = null with get,set
member val StripeCouponId:String = null with get,set
member val Plan:String = null with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val IsReferrer:Boolean = new Boolean() with get,set
member val Orders:ResizeArray<Order> = null with get,set
member val Subscriptions:ResizeArray<Subscription> = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = null with get,set
[<AllowNullLiteral>]
type QueryDb<T>() =
inherit QueryBase()
[<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")>]
[<AllowNullLiteral>]
type QueryCustomers() =
inherit QueryDb<Customer>()
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<T>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<Customer> = null with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = null with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
fields: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
id: 0,
email: String,
displayName: String,
firstName: String,
lastName: String,
company: String,
phoneNumber: String,
addressLine1: String,
addressLine2: String,
addressCity: String,
addressZip: String,
addressState: String,
addressCountry: String,
stripeCustomerId: String,
stripeCouponId: String,
plan: String,
createdDate: 0001-01-01,
isReferrer: False,
orders:
[
{
id: 0,
customerId: 0,
productName: String,
firstName: String,
lastName: String,
email: String,
company: String,
phoneNumber: String,
addressLine1: String,
addressLine2: String,
addressCity: String,
addressZip: String,
addressState: String,
addressCountry: String,
agreeTerms: False,
notes: String,
last4: String,
subTotal: 0,
couponId: String,
discount: 0,
tax: 0,
total: 0,
itemQuantity: 0,
authorizedQuantity: 0,
subscriptionId: 0,
licenseRef: String,
paymentId: 0,
emailId: 0,
paid: False,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
modifiedBy: String,
cancelledDate: 0001-01-01,
cancelledReason: String,
ipAddress: String,
orderDetails:
[
{
id: 0,
orderId: 0,
skuId: 0,
skuType: Product,
price: 0,
description: String,
quantity: 0,
total: 0
}
]
}
],
subscriptions:
[
{
id: 0,
customerId: 0,
email: String,
skuId: 0,
skuName: String,
skuType: Product,
code: String,
quantity: 0,
supportQuantity: 0,
total: 0,
isPlan: False,
isRenewal: False,
subscriptionDurationDays: 0,
renewalDate: 0001-01-01,
licenseRef: String,
licenseName: String,
licenseAddress: String,
licenseType: Free,
expiryDate: 0001-01-01,
licenseKey:
{
ref: String,
name: String,
type: Free,
meta: 0,
hash: String,
halg: String,
expiry: 0001-01-01
},
licenseKeyText: String,
createdDate: 0001-01-01,
modifiedDate: 0001-01-01,
cancelledDate: 0001-01-01,
stripeSubscriptionId: String,
emailId: 0,
emailRenewalId: 0,
emailExpiredId: 0,
renewalSubscriptionId: 0,
externalRef: String,
notes: String,
error: String
}
]
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}