Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/products/{Id} |
|---|
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="Specifies a service request to retrieve a product.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetrieveProductBase(IReturn[ProductResponse], IGet):
"""
Specifies a service request to retrieve a product.
"""
# @ApiMember(Description="The unique identifier of the product.", Name="Id")
id: int = 0
"""
The unique identifier of the product.
"""
# @ApiMember(Description="Should the related orders of the account be included in the retrieved product?")
include_orders: Optional[bool] = None
"""
Should the related orders of the account be included in the retrieved product?
"""
# @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ")
skip_orders: Optional[int] = None
"""
Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true.
"""
# @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ")
take_orders: Optional[int] = None
"""
Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true.
"""
@staticmethod
def response_type(): return ProductResponse
# @Api(Description="Specifies a base service response class that contains a structured error information.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceResponseBase:
"""
Specifies a base service response class that contains a structured error information.
"""
# @ApiMember(Description="Data structure that holds error information from a service operation.")
response_status: Optional[ResponseStatus] = None
"""
Data structure that holds error information from a service operation.
"""
# @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 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 service response that encapsulates product data.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductResponse(ServiceResponseBase):
"""
Represents a service response that encapsulates product data.
"""
# @ApiMember(Description="The product data of the response.")
product: Optional[Product] = None
"""
The product data of the response.
"""
# @ApiMember(Description="The list of orders associated with the encapsulated product.")
orders: Optional[List[Order]] = None
"""
The list of orders associated with the encapsulated product.
"""
# @ApiMember(Description="Data structure that holds error information from a service operation.")
response_status: Optional[ResponseStatus] = None
"""
Data structure that holds error information from a service operation.
"""
# @Api(Description="Represents a service request to retrieve a product.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetrieveProduct(RetrieveProductBase):
"""
Represents a service request to retrieve a product.
"""
# @ApiMember(Description="The unique identifier of the product.", Name="Id")
id: int = 0
"""
The unique identifier of the product.
"""
# @ApiMember(Description="Should the related orders of the account be included in the retrieved product?")
include_orders: Optional[bool] = None
"""
Should the related orders of the account be included in the retrieved product?
"""
# @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ")
skip_orders: Optional[int] = None
"""
Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true.
"""
# @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ")
take_orders: Optional[int] = None
"""
Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true.
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/products/{Id} HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
product:
{
id: 0,
index: 0,
name: String,
version: String,
description: String,
tags:
[
String
]
},
orders:
[
{
id: 0,
productId: 0,
accountId: 0,
name: String,
serviceName: String,
requestTimestamp: 0001-01-01,
responseTimestamp: 0001-01-01,
requestUri: String,
requestHttpMethod: String,
requestDuration: PT0S,
responseStatusCode: Continue,
clientIPAddress: String,
unitOfMeasurement: String,
processType: String,
dataType: String,
dataName: String,
creationDate: 0001-01-01,
expiryDate: 0001-01-01,
isTest: False
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}