<back to all web services

SearchProductsAsync

Represents a service to search for product data in an asynchronous operation.

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 search for products.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchProductsBase(PaginationBase, IReturn[ProductQueryResponse], IGet):
    """
    Specifies a service to search for products.
    """

    # @ApiMember(Description="The unique identifier of the account associated with the product.")
    product_id: Optional[int] = None
    """
    The unique identifier of the account associated with the product.
    """


    # @ApiMember(Description="The unique identifier of the account associated with the product.")
    account_id: Optional[int] = None
    """
    The unique identifier of the account associated with the product.
    """


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


    # @ApiMember(Description="Search by using the name of the product that starts with the specified value.")
    name_starts_with: Optional[str] = None
    """
    Search by using the name of the product that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the product that ends with the specified value.")
    name_ends_with: Optional[str] = None
    """
    Search by using the name of the product that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the product that contains the specified value.")
    name_contains: Optional[str] = None
    """
    Search by using the name of the product that contains the specified value.
    """


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


    # @ApiMember(Description="Search by using the version of the product that starts with the specified value.")
    version_starts_with: Optional[str] = None
    """
    Search by using the version of the product that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the version of the product that ends with the specified value.")
    version_ends_with: Optional[str] = None
    """
    Search by using the version of the product that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the version of the product that contains the specified value.")
    version_contains: Optional[str] = None
    """
    Search by using the version of the product that contains the specified value.
    """


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


    # @ApiMember(Description="Search by using the description of the product that starts with the specified value.")
    description_starts_with: Optional[str] = None
    """
    Search by using the description of the product that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the description of the product that ends with the specified value.")
    description_ends_with: Optional[str] = None
    """
    Search by using the description of the product that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the description of the product that contains the specified value.")
    description_contains: Optional[str] = None
    """
    Search by using the description of the product that contains the specified value.
    """


    # @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 to search for product data in an asynchronous operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchProductsAsync(SearchProductsBase):
    """
    Represents a service to search for product data in an asynchronous operation.
    """

    # @ApiMember(Description="The unique identifier of the account associated with the product.")
    product_id: Optional[int] = None
    """
    The unique identifier of the account associated with the product.
    """


    # @ApiMember(Description="The unique identifier of the account associated with the product.")
    account_id: Optional[int] = None
    """
    The unique identifier of the account associated with the product.
    """


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


    # @ApiMember(Description="Search by using the name of the product that starts with the specified value.")
    name_starts_with: Optional[str] = None
    """
    Search by using the name of the product that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the product that ends with the specified value.")
    name_ends_with: Optional[str] = None
    """
    Search by using the name of the product that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the product that contains the specified value.")
    name_contains: Optional[str] = None
    """
    Search by using the name of the product that contains the specified value.
    """


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


    # @ApiMember(Description="Search by using the version of the product that starts with the specified value.")
    version_starts_with: Optional[str] = None
    """
    Search by using the version of the product that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the version of the product that ends with the specified value.")
    version_ends_with: Optional[str] = None
    """
    Search by using the version of the product that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the version of the product that contains the specified value.")
    version_contains: Optional[str] = None
    """
    Search by using the version of the product that contains the specified value.
    """


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


    # @ApiMember(Description="Search by using the description of the product that starts with the specified value.")
    description_starts_with: Optional[str] = None
    """
    Search by using the description of the product that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the description of the product that ends with the specified value.")
    description_ends_with: Optional[str] = None
    """
    Search by using the description of the product that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the description of the product that contains the specified value.")
    description_contains: Optional[str] = None
    """
    Search by using the description of the product that contains the specified value.
    """


    # @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 SearchProductsAsync DTOs

GET /async/products/search HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProductQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
  <Offset xmlns="http://schemas.servicestack.net/types">0</Offset>
  <Total xmlns="http://schemas.servicestack.net/types">0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models" xmlns="http://schemas.servicestack.net/types">
    <d2p1:Product>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Index>0</d2p1:Index>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Tags>
      <d2p1:Version>String</d2p1:Version>
    </d2p1:Product>
  </Results>
  <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>
  <ResponseStatus xmlns="http://schemas.servicestack.net/types">
    <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>
  <OrdersMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfOrderKY2vvLcG>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
        <d4p1:Order>
          <d4p1:AccountId>0</d4p1:AccountId>
          <d4p1:ClientIPAddress>String</d4p1:ClientIPAddress>
          <d4p1:CreationDate>0001-01-01T00:00:00</d4p1:CreationDate>
          <d4p1:DataName>String</d4p1:DataName>
          <d4p1:DataType>String</d4p1:DataType>
          <d4p1:ExpiryDate>0001-01-01T00:00:00</d4p1:ExpiryDate>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:IsTest>false</d4p1:IsTest>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:ProcessType>String</d4p1:ProcessType>
          <d4p1:ProductId>0</d4p1:ProductId>
          <d4p1:RequestDuration>PT0S</d4p1:RequestDuration>
          <d4p1:RequestHttpMethod>String</d4p1:RequestHttpMethod>
          <d4p1:RequestTimestamp>0001-01-01T00:00:00</d4p1:RequestTimestamp>
          <d4p1:RequestUri>String</d4p1:RequestUri>
          <d4p1:ResponseStatusCode>Continue</d4p1:ResponseStatusCode>
          <d4p1:ResponseTimestamp>0001-01-01T00:00:00</d4p1:ResponseTimestamp>
          <d4p1:ServiceName>String</d4p1:ServiceName>
          <d4p1:UnitOfMeasurement>String</d4p1:UnitOfMeasurement>
        </d4p1:Order>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfOrderKY2vvLcG>
  </OrdersMap>
</ProductQueryResponse>