Tax Filing Service

<back to all web services

RetrieveAllProductsAsync

RetrieveProductsAsync

Represents a service request to retrieve all products in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/products
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


# @Api(Description="The number of query results to skip.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaginationBase(IPaginate):
    """
    The number of query results to skip.
    """

    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """


# @Api(Description="Specifies a service to retrieve all products.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetrieveAllProductsBase(PaginationBase, IReturn[ProductQueryResponse], IGet):
    """
    Specifies a service to retrieve all products.
    """

    # @ApiMember(Description="Should the related orders of the account be included in the retrieved products?")
    include_orders: Optional[bool] = None
    """
    Should the related orders of the account be included in the retrieved products?
    """


    # @ApiMember(Description="Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. ")
    skip_orders: Optional[int] = None
    """
    Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. 
    """


    # @ApiMember(Description="Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. ")
    take_orders: Optional[int] = None
    """
    Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. 
    """


    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """
    @staticmethod
    def response_type(): return ProductQueryResponse


# @Api(Description="Represents a product.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Product(IHasName):
    """
    Represents a product.
    """

    # @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
    id: int = 0
    """
    The unique identifier of the product.
    """


    # @ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)
    index: int = 0
    """
    The position of this instance in a collection of 'Product' instances
    """


    # @ApiMember(Description="The name of the product.", IsRequired=true)
    # @Validate(Validator="NotEmpty")
    name: Optional[str] = None
    """
    The name of the product.
    """


    # @ApiMember(Description="The version of the product.", IsRequired=true)
    # @Validate(Validator="NotEmpty")
    version: Optional[str] = None
    """
    The version of the product.
    """


    # @ApiMember(Description="The version of the product.")
    description: Optional[str] = None
    """
    The version of the product.
    """


    # @ApiMember(Description="Tags associated with the product.")
    tags: Optional[List[str]] = None
    """
    Tags associated with the product.
    """


# @Api(Description="Represents a query response that contains a structured error information and encapsulates products.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductQueryResponse(QueryResponse[Product]):
    """
    Represents a query response that contains a structured error information and encapsulates products.
    """

    # @ApiMember(Description="The dictionary of orders associated with each found product.")
    orders_map: Optional[Dict[int, List[Order]]] = None
    """
    The dictionary of orders associated with each found product.
    """


    offset: int = 0
    total: int = 0
    results: Optional[List[Product]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None


# @Api(Description="Represents a service request to retrieve all products in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetrieveAllProductsAsync(RetrieveAllProductsBase):
    """
    Represents a service request to retrieve all products in an asynchronous operation.
    """

    # @ApiMember(Description="Should the related orders of the account be included in the retrieved products?")
    include_orders: Optional[bool] = None
    """
    Should the related orders of the account be included in the retrieved products?
    """


    # @ApiMember(Description="Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. ")
    skip_orders: Optional[int] = None
    """
    Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. 
    """


    # @ApiMember(Description="Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. ")
    take_orders: Optional[int] = None
    """
    Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. 
    """


    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: int = 0
    total: int = 0
    results: Optional[List[T]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python RetrieveAllProductsAsync DTOs

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

HTTP + CSV

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

GET /async/products HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ordersMap":{"0":[{"id":0,"productId":0,"accountId":0,"name":"String","serviceName":"String","requestTimestamp":"\/Date(-62135596800000-0000)\/","responseTimestamp":"\/Date(-62135596800000-0000)\/","requestUri":"String","requestHttpMethod":"String","requestDuration":"PT0S","responseStatusCode":"Continue","clientIPAddress":"String","unitOfMeasurement":"String","processType":"String","dataType":"String","dataName":"String","creationDate":"\/Date(-62135596800000-0000)\/","expiryDate":"\/Date(-62135596800000-0000)\/","isTest":false}]},"offset":0,"total":0,"results":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}