| GET | /api/CategoryListing |
|---|
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest:
# @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
api_key: Optional[str] = None
"""
This is your AIM API Key provided by Tri-Tech
"""
# @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
o_auth_token: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
# @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
token: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
device_id: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
app_id: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
# @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
status_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
login: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
error_code: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
error_display_text: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
error_message: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
domain_name: Optional[str] = None
"""
"""
# @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
ip_address: Optional[str] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
# @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
status: Optional[BaseResponseResult] = None
"""
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubCategoryAttributeInfo:
attribute_name: Optional[str] = None
priority: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubCategoryInfo:
sub_number: int = 0
description: Optional[str] = None
active: bool = False
price: Decimal = decimal.Decimal(0)
sku_attributes: Optional[List[SubCategoryAttributeInfo]] = None
serial_attributes: Optional[List[SubCategoryAttributeInfo]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CategoryInfo:
category_number: int = 0
category_type: Optional[str] = None
description: Optional[str] = None
active: bool = False
sub_category_listing: Optional[List[SubCategoryInfo]] = None
payment_category_type: Optional[str] = None
allowed_on_mobile: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CategoryListingResponse(BaseResponse):
category_listing: Optional[List[CategoryInfo]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CategoryListingRequest(BaseSecureRequest):
"""
CategoryListingRequires active-e Inventory Service.
"""
# @ApiMember(DataType="boolean", Description="If true, Inactive Categories and Subcategories will be returned. Defaults to false.", Name="IncludeInactive", ParameterType="query")
include_inactive: Optional[bool] = None
"""
If true, Inactive Categories and Subcategories will be returned. Defaults to false.
"""
# @ApiMember(DataType="integer", Description="Category Number lookup. If sent, only this category and it's subs will be returned. Further parameters will be ignored.", Format="int64", Name="CategoryNumber", ParameterType="query")
category_number: Optional[int] = None
"""
Category Number lookup. If sent, only this category and it's subs will be returned. Further parameters will be ignored.
"""
# @ApiMember(DataType="boolean", Description="If true, Inventory Categories will be returned. Defaults to true.", Name="IncludeInventory", ParameterType="query")
include_inventory: Optional[bool] = None
"""
If true, Inventory Categories will be returned. Defaults to true.
"""
# @ApiMember(DataType="boolean", Description="If true, Non-Inventory Categories will be returned. Defaults to false.", Name="IncludeNonInventory", ParameterType="query")
include_non_inventory: Optional[bool] = None
"""
If true, Non-Inventory Categories will be returned. Defaults to false.
"""
# @ApiMember(DataType="boolean", Description="If true, Return Payment Categories will be returned. Defaults to false.", Name="IncludeReturn", ParameterType="query")
include_return: Optional[bool] = None
"""
If true, Return Payment Categories will be returned. Defaults to false.
"""
# @ApiMember(DataType="boolean", Description="If true, Payment Categories will be returned. Defaults to false.", Name="IncludePayment", ParameterType="query")
include_payment: Optional[bool] = None
"""
If true, Payment Categories will be returned. Defaults to false.
"""
Python CategoryListingRequest DTOs
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.
GET /api/CategoryListing HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CategoryListingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<CategoryListing>
<CategoryInfo>
<Active>false</Active>
<AllowedOnMobile>false</AllowedOnMobile>
<CategoryNumber>0</CategoryNumber>
<CategoryType>String</CategoryType>
<Description>String</Description>
<PaymentCategoryType>String</PaymentCategoryType>
<SubCategoryListing>
<SubCategoryInfo>
<Active>false</Active>
<Description>String</Description>
<Price>0</Price>
<SerialAttributes>
<SubCategoryAttributeInfo>
<AttributeName>String</AttributeName>
<Priority>0</Priority>
</SubCategoryAttributeInfo>
</SerialAttributes>
<SkuAttributes>
<SubCategoryAttributeInfo>
<AttributeName>String</AttributeName>
<Priority>0</Priority>
</SubCategoryAttributeInfo>
</SkuAttributes>
<SubNumber>0</SubNumber>
</SubCategoryInfo>
</SubCategoryListing>
</CategoryInfo>
</CategoryListing>
</CategoryListingResponse>