| Required role: | Admin |
// @DataContract
export class QueryBase
{
// @DataMember(Order=1)
public skip?: number;
// @DataMember(Order=2)
public take?: number;
// @DataMember(Order=3)
public orderBy?: string;
// @DataMember(Order=4)
public orderByDesc?: string;
// @DataMember(Order=5)
public include?: string;
// @DataMember(Order=6)
public fields?: string;
// @DataMember(Order=7)
public meta?: { [index:string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<T> extends QueryBase
{
public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}
export enum SkuType
{
Product = 'Product',
PerDev = 'PerDev',
PerCore = 'PerCore',
Site = 'Site',
Support = 'Support',
Training = 'Training',
Register = 'Register',
Payment = 'Payment',
}
export class OrderDetail
{
public id: number;
public orderId: number;
public skuId: number;
public skuType: SkuType;
public price: number;
public description: string;
public quantity: number;
public total: number;
public constructor(init?: Partial<OrderDetail>) { (Object as any).assign(this, init); }
}
export class Order implements IAddress
{
public id: number;
public customerId: number;
public productName: string;
public firstName: string;
public lastName: string;
public email: string;
public company: string;
public phoneNumber: string;
public addressLine1: string;
public addressLine2: string;
public addressCity: string;
public addressZip: string;
public addressState: string;
public addressCountry: string;
public agreeTerms: boolean;
public notes: string;
public last4: string;
public subTotal: number;
public couponId: string;
public discount: number;
public tax: number;
public total: number;
public itemQuantity: number;
public authorizedQuantity?: number;
public subscriptionId?: number;
public licenseRef: string;
public paymentId?: number;
public emailId?: number;
public paid: boolean;
public createdDate: string;
public modifiedDate: string;
public modifiedBy: string;
public cancelledDate?: string;
public cancelledReason: string;
public ipAddress: string;
public orderDetails: OrderDetail[];
public constructor(init?: Partial<Order>) { (Object as any).assign(this, init); }
}
// @ValidateRequest(Validator="IsAdmin")
export class QueryOrders extends QueryDb<Order>
{
public constructor(init?: Partial<QueryOrders>) { super(init); (Object as any).assign(this, init); }
}
export enum LicenseType
{
Free = 'Free',
FreeIndividual = 'FreeIndividual',
FreeOpenSource = 'FreeOpenSource',
Indie = 'Indie',
Business = 'Business',
Enterprise = 'Enterprise',
TextIndie = 'TextIndie',
TextBusiness = 'TextBusiness',
OrmLiteIndie = 'OrmLiteIndie',
OrmLiteBusiness = 'OrmLiteBusiness',
RedisIndie = 'RedisIndie',
RedisBusiness = 'RedisBusiness',
AwsIndie = 'AwsIndie',
AwsBusiness = 'AwsBusiness',
Trial = 'Trial',
Site = 'Site',
TextSite = 'TextSite',
RedisSite = 'RedisSite',
OrmLiteSite = 'OrmLiteSite',
}
export class LicenseKey
{
public ref: string;
public name: string;
public type: LicenseType;
public meta: number;
public hash: string;
public halg: string;
public expiry: string;
public constructor(init?: Partial<LicenseKey>) { (Object as any).assign(this, init); }
}
export class Subscription
{
public id: number;
public customerId: number;
public email: string;
public skuId: number;
public skuName: string;
public skuType: SkuType;
public code: string;
public quantity: number;
public supportQuantity: number;
public total: number;
public isPlan: boolean;
public isRenewal: boolean;
public subscriptionDurationDays: number;
public renewalDate?: string;
public licenseRef: string;
public licenseName: string;
public licenseAddress: string;
public licenseType: LicenseType;
public expiryDate: string;
public licenseKey: LicenseKey;
public licenseKeyText: string;
public createdDate: string;
public modifiedDate: string;
public cancelledDate?: string;
public stripeSubscriptionId: string;
public emailId?: number;
public emailRenewalId?: number;
public emailExpiredId?: number;
public renewalSubscriptionId?: number;
public externalRef: string;
public notes: string;
public error: string;
public constructor(init?: Partial<Subscription>) { (Object as any).assign(this, init); }
}
export class Customer implements IAddress
{
public id: number;
public email: string;
public displayName: string;
public firstName: string;
public lastName: string;
public company: string;
public phoneNumber: string;
public addressLine1: string;
public addressLine2: string;
public addressCity: string;
public addressZip: string;
public addressState: string;
public addressCountry: string;
public stripeCustomerId: string;
public stripeCouponId: string;
public plan: string;
public createdDate: string;
public isReferrer: boolean;
public orders: Order[];
public subscriptions: Subscription[];
public constructor(init?: Partial<Customer>) { (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<T>
{
// @DataMember(Order=1)
public offset: number;
// @DataMember(Order=2)
public total: number;
// @DataMember(Order=3)
public results: Customer[] = [];
// @DataMember(Order=4)
public meta?: { [index:string]: string; };
// @DataMember(Order=5)
public responseStatus?: ResponseStatus;
public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}
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 /xml/reply/QueryOrders HTTP/1.1
Host: account.servicestack.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<QueryOrders 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>
</QueryOrders>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfOrdertlJ4_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: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>
</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>
</QueryResponseOfOrdertlJ4_P31p>