Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/admin/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 an admin user to search for orders.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdminSearchOrdersBase(PaginationBase, IReturn[OrderQueryResponse], IGet):
"""
Specifies a service request from an admin 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 unique identifier of the order.")
order_id: Optional[int] = None
"""
The unique identifier of the order.
"""
# @ApiMember(Description="The unique identifier of the product, for which the order is made.")
product_id: Optional[int] = None
"""
The unique identifier of the product, for which the order is made.
"""
# @ApiMember(Description="The unique identifier of the user account, who made the order.")
account_id: Optional[int] = None
"""
The unique identifier of the user account, who made the order.
"""
# @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="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="Was the order request successful?")
order_request_succeeded: Optional[bool] = None
"""
Was the order request successful?
"""
# @ApiMember(Description="The initial IP address of client, who made the order.")
client_i_p_address: Optional[str] = None
"""
The initial IP address of client, who made 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="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 an admin user to search for orders.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AdminSearchOrders(AdminSearchOrdersBase):
"""
Represents a service request from an admin 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 unique identifier of the order.")
order_id: Optional[int] = None
"""
The unique identifier of the order.
"""
# @ApiMember(Description="The unique identifier of the product, for which the order is made.")
product_id: Optional[int] = None
"""
The unique identifier of the product, for which the order is made.
"""
# @ApiMember(Description="The unique identifier of the user account, who made the order.")
account_id: Optional[int] = None
"""
The unique identifier of the user account, who made the order.
"""
# @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="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="Was the order request successful?")
order_request_succeeded: Optional[bool] = None
"""
Was the order request successful?
"""
# @ApiMember(Description="The initial IP address of client, who made the order.")
client_i_p_address: Optional[str] = None
"""
The initial IP address of client, who made 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="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
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/admin/orders/search HTTP/1.1 Host: taxfiling.staging.pwc.de Accept: application/x-msgpack
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length
{"offset":0,"total":0,"results":[{"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}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}