Required role: | Admin |
All Verbs | /query/subscriptions |
---|
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
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
[<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(DefaultSearchField="Email", DefaultSearchType="Contains", IconUrl="material-icons:person_outline", Title="Subscriptions")>]
[<AllowNullLiteral>]
type QuerySubscriptions() =
inherit QueryDb<Subscription>()
[<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
[<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 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /query/subscriptions HTTP/1.1
Host: account.servicestack.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<QuerySubscriptions 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>
</QuerySubscriptions>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfSubscriptiontlJ4_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: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:d4p1="http://schemas.datacontract.org/2004/07/ServiceStack"> <d4p1:Expiry>0001-01-01T00:00:00</d4p1:Expiry> <d4p1:Halg>String</d4p1:Halg> <d4p1:Hash>String</d4p1:Hash> <d4p1:Meta>0</d4p1:Meta> <d4p1:Name>String</d4p1:Name> <d4p1:Ref>String</d4p1:Ref> <d4p1:Type>Free</d4p1: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> </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> </QueryResponseOfSubscriptiontlJ4_P31p>