ServiceStack Home (Live)

<back to all web services

Product

The following routes are available for this service:
GET/Product
GET/Product/{Id}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class SkuType(str, Enum):
    PRODUCT = 'Product'
    PER_DEV = 'PerDev'
    PER_CORE = 'PerCore'
    SITE = 'Site'
    SUPPORT = 'Support'
    TRAINING = 'Training'
    REGISTER = 'Register'
    PAYMENT = 'Payment'


# @Flags()
class LicenseFeature(IntEnum):
    NONE = 0
    FREE = 0
    PREMIUM = 1
    TEXT = 2
    CLIENT = 4
    COMMON = 8
    REDIS = 16
    REDIS_SKU = 18
    ORM_LITE = 32
    ORM_LITE_SKU = 34
    SERVICE_STACK = 64
    SERVER = 128
    RAZOR = 256
    ADMIN = 512
    AWS = 1024
    AWS_SKU = 1026
    ALL = 2047


class LicenseType(str, Enum):
    FREE = 'Free'
    FREE_INDIVIDUAL = 'FreeIndividual'
    FREE_OPEN_SOURCE = 'FreeOpenSource'
    INDIE = 'Indie'
    BUSINESS = 'Business'
    ENTERPRISE = 'Enterprise'
    TEXT_INDIE = 'TextIndie'
    TEXT_BUSINESS = 'TextBusiness'
    ORM_LITE_INDIE = 'OrmLiteIndie'
    ORM_LITE_BUSINESS = 'OrmLiteBusiness'
    REDIS_INDIE = 'RedisIndie'
    REDIS_BUSINESS = 'RedisBusiness'
    AWS_INDIE = 'AwsIndie'
    AWS_BUSINESS = 'AwsBusiness'
    TRIAL = 'Trial'
    SITE = 'Site'
    TEXT_SITE = 'TextSite'
    REDIS_SITE = 'RedisSite'
    ORM_LITE_SITE = 'OrmLiteSite'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Sku:
    id: int = 0
    product_id: int = 0
    type: Optional[SkuType] = None
    feature: Optional[LicenseFeature] = None
    code: Optional[str] = None
    name: Optional[str] = None
    notes: Optional[str] = None
    # @Ignore()
    min_qty: Optional[int] = None

    max_qty: Optional[int] = None
    price: int = 0
    plan: Optional[str] = None
    discount_off: int = 0
    discount_label_off: Optional[str] = None
    actual_price: int = 0
    is_plan: bool = False
    is_renewal: bool = False
    subscription_duration_days: Optional[int] = None
    expiry_duration_days: Optional[int] = None
    trial_period_days: Optional[int] = None
    support_qty: int = 0
    cores_qty: Optional[int] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    license_type: Optional[LicenseType] = None
    active: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Product:
    id: int = 0
    name: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    skus: Optional[List[Sku]] = None
    active: bool = False

Python Product DTOs

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

HTTP + JSV

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

GET /Product HTTP/1.1 
Host: account.servicestack.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	name: String,
	createdDate: 0001-01-01,
	modifiedDate: 0001-01-01,
	skus: 
	[
		{
			id: 0,
			productId: 0,
			type: Product,
			feature: 0,
			code: String,
			name: String,
			notes: String,
			maxQty: 0,
			price: 0,
			plan: String,
			discountOff: 0,
			discountLabelOff: String,
			actualPrice: 0,
			isPlan: False,
			isRenewal: False,
			subscriptionDurationDays: 0,
			expiryDurationDays: 0,
			trialPeriodDays: 0,
			supportQty: 0,
			coresQty: 0,
			createdDate: 0001-01-01,
			modifiedDate: 0001-01-01,
			licenseType: Free,
			active: False
		}
	],
	active: False
}