Tax Filing Service

<back to all web services

SearchOrders

SearchOrdersSync

Represents a service request from a standard user to search for orders.

Requires Authentication
Required role:AllowAnyUserRequired permission:CanAccess
The following routes are available for this service:
GET/sync/orders/search
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.
    """


class PeriodMode(str, Enum):
    """
    Represents a specific time interval, within which, an action was carried out.
    """

    TODAY = 'Today'
    YESTERDAY = 'Yesterday'
    LAST_WEEK = 'LastWeek'
    LAST30_DAYS = 'Last30Days'
    LAST90_DAYS = 'Last90Days'
    LAST180_DAYS = 'Last180Days'


# @Api(Description="Specifies a service request from a standard user to search for orders.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOrdersBase(PaginationBase, IReturn[OrderQueryResponse], IGet):
    """
    Specifies a service request from a standard user to search for orders.
    """

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


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


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


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


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


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


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


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


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


    # @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")
    before: Optional[datetime.datetime] = None
    """
    Search for orders placed before a certain date and time. The specified date is included in the search.
    """


    # @ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")
    after: Optional[datetime.datetime] = None
    """
    Search for orders placed after a certain date and time. The specified date is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    period_start_date: Optional[datetime.datetime] = None
    """
    Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    period_end_date: Optional[datetime.datetime] = None
    """
    Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")
    period_mode: Optional[PeriodMode] = None
    """
    Search for orders placed within the last 180 days. Today is included in the search.
    """


    # @ApiMember(Description="Was the order request successful?")
    order_request_succeeded: Optional[bool] = None
    """
    Was the order request successful?
    """


    # @ApiMember(Description="The unit of measurement for the order.")
    unit_of_measurement: Optional[str] = None
    """
    The unit of measurement for the order.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")
    unit_of_measurement_starts_with: Optional[str] = None
    """
    Search by using the unit of measurement of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")
    unit_of_measurement_ends_with: Optional[str] = None
    """
    Search by using the unit of measurement of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")
    unit_of_measurement_contains: Optional[str] = None
    """
    Search by using the unit of measurement of the order that contains the specified value.
    """


    # @ApiMember(Description="The type of process, for which the order is charged.")
    process_type: Optional[str] = None
    """
    The type of process, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the process type of the order that starts with the specified value.")
    process_type_starts_with: Optional[str] = None
    """
    Search by using the process type of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the process type of the order that ends with the specified value.")
    process_type_ends_with: Optional[str] = None
    """
    Search by using the process type of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the process type of the order that contains the specified value.")
    process_type_contains: Optional[str] = None
    """
    Search by using the process type of the order that contains the specified value.
    """


    # @ApiMember(Description="The type of data, for which the order is charged.")
    data_type: Optional[str] = None
    """
    The type of data, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")
    data_type_starts_with: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")
    data_type_ends_with: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")
    data_type_contains: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that contains the specified value.
    """


    # @ApiMember(Description="The name of the data, for which the order is charged.")
    data_name: Optional[str] = None
    """
    The name of the data, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")
    data_name_starts_with: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")
    data_name_ends_with: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")
    data_name_contains: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that contains the specified value.
    """


    # @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 OrderQueryResponse


# @Api(Description="Represents a commission to consume services.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order(IHasName):
    """
    Represents a commission to consume services.
    """

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


    # @ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)
    product_id: int = 0
    """
    The unique identifier of the product, for which the order is made.
    """


    # @ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)
    account_id: int = 0
    """
    The unique identifier of the user account, who placed the order.
    """


    # @ApiMember(Description="A name to identify the order.", IsRequired=true)
    # @Validate(Validator="NotEmpty")
    name: Optional[str] = None
    """
    A name to identify the order.
    """


    # @ApiMember(Description="The name of the service, for which the order was made.")
    service_name: Optional[str] = None
    """
    The name of the service, for which the order was made.
    """


    # @ApiMember(Description="The time stamp at which the order was initiated.")
    request_timestamp: Optional[datetime.datetime] = None
    """
    The time stamp at which the order was initiated.
    """


    # @ApiMember(Description="The time stamp at which the order was completed.")
    response_timestamp: Optional[datetime.datetime] = None
    """
    The time stamp at which the order was completed.
    """


    # @ApiMember(Description="The URI from which the order was initiated.")
    request_uri: Optional[str] = None
    """
    The URI from which the order was initiated.
    """


    # @ApiMember(Description="The HTTP method of the order request.")
    request_http_method: Optional[str] = None
    """
    The HTTP method of the order request.
    """


    # @ApiMember(Description="The duration of the order request.")
    request_duration: Optional[datetime.timedelta] = None
    """
    The duration of the order request.
    """


    # @ApiMember(Description="The HTTP status code of the order request.")
    response_status_code: Optional[HttpStatusCode] = None
    """
    The HTTP status code of the order request.
    """


    # @ApiMember(Description="The IP address of client, who placed the order.")
    client_i_p_address: Optional[str] = None
    """
    The IP address of client, who placed the order.
    """


    # @ApiMember(Description="The unit of measurement for the order.")
    unit_of_measurement: Optional[str] = None
    """
    The unit of measurement for the order.
    """


    # @ApiMember(Description="The type of process, for which the order is charged.")
    process_type: Optional[str] = None
    """
    The type of process, for which the order is charged.
    """


    # @ApiMember(Description="The type of data, for which the order is charged.")
    data_type: Optional[str] = None
    """
    The type of data, for which the order is charged.
    """


    # @ApiMember(Description="The name of the data, for which the order is charged.")
    data_name: Optional[str] = None
    """
    The name of the data, for which the order is charged.
    """


    # @ApiMember(Description="The date of creation of the order.")
    creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The date of creation of the order.
    """


    # @ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")
    expiry_date: Optional[datetime.datetime] = None
    """
    The final date to retain the order in the records. After this date, the order is expunged from the records.
    """


    # @ApiMember(Description="Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.")
    is_test: bool = False
    """
    Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.
    """


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

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


# @Api(Description="Represents a service request from a standard user to search for orders.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOrders(SearchOrdersBase):
    """
    Represents a service request from a standard user to search for orders.
    """

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


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


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


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


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


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


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


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


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


    # @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")
    before: Optional[datetime.datetime] = None
    """
    Search for orders placed before a certain date and time. The specified date is included in the search.
    """


    # @ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")
    after: Optional[datetime.datetime] = None
    """
    Search for orders placed after a certain date and time. The specified date is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    period_start_date: Optional[datetime.datetime] = None
    """
    Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    period_end_date: Optional[datetime.datetime] = None
    """
    Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")
    period_mode: Optional[PeriodMode] = None
    """
    Search for orders placed within the last 180 days. Today is included in the search.
    """


    # @ApiMember(Description="Was the order request successful?")
    order_request_succeeded: Optional[bool] = None
    """
    Was the order request successful?
    """


    # @ApiMember(Description="The unit of measurement for the order.")
    unit_of_measurement: Optional[str] = None
    """
    The unit of measurement for the order.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")
    unit_of_measurement_starts_with: Optional[str] = None
    """
    Search by using the unit of measurement of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")
    unit_of_measurement_ends_with: Optional[str] = None
    """
    Search by using the unit of measurement of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")
    unit_of_measurement_contains: Optional[str] = None
    """
    Search by using the unit of measurement of the order that contains the specified value.
    """


    # @ApiMember(Description="The type of process, for which the order is charged.")
    process_type: Optional[str] = None
    """
    The type of process, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the process type of the order that starts with the specified value.")
    process_type_starts_with: Optional[str] = None
    """
    Search by using the process type of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the process type of the order that ends with the specified value.")
    process_type_ends_with: Optional[str] = None
    """
    Search by using the process type of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the process type of the order that contains the specified value.")
    process_type_contains: Optional[str] = None
    """
    Search by using the process type of the order that contains the specified value.
    """


    # @ApiMember(Description="The type of data, for which the order is charged.")
    data_type: Optional[str] = None
    """
    The type of data, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")
    data_type_starts_with: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")
    data_type_ends_with: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")
    data_type_contains: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that contains the specified value.
    """


    # @ApiMember(Description="The name of the data, for which the order is charged.")
    data_name: Optional[str] = None
    """
    The name of the data, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")
    data_name_starts_with: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")
    data_name_ends_with: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")
    data_name_contains: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that contains the specified value.
    """


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

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

HTTP + XML

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

GET /sync/orders/search HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml

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

<OrderQueryResponse 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:Order>
      <d2p1:AccountId>0</d2p1:AccountId>
      <d2p1:ClientIPAddress>String</d2p1:ClientIPAddress>
      <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate>
      <d2p1:DataName>String</d2p1:DataName>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsTest>false</d2p1:IsTest>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ProcessType>String</d2p1:ProcessType>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:RequestDuration>PT0S</d2p1:RequestDuration>
      <d2p1:RequestHttpMethod>String</d2p1:RequestHttpMethod>
      <d2p1:RequestTimestamp>0001-01-01T00:00:00</d2p1:RequestTimestamp>
      <d2p1:RequestUri>String</d2p1:RequestUri>
      <d2p1:ResponseStatusCode>Continue</d2p1:ResponseStatusCode>
      <d2p1:ResponseTimestamp>0001-01-01T00:00:00</d2p1:ResponseTimestamp>
      <d2p1:ServiceName>String</d2p1:ServiceName>
      <d2p1:UnitOfMeasurement>String</d2p1:UnitOfMeasurement>
    </d2p1:Order>
  </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>
</OrderQueryResponse>
© 2021 - 2024 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Any use of third party IP such as ELSTER is governed by the respective third party terms.