Tax Filing Service
| Required role: | Admin | Required permissions: | CanAccess, CanAdd |
| POST | /async/products/batch |
|---|
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="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="Specifies a base service request to register one or more products in a batch operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchRegisterProductsBase(IReturn[List[ProductResponse]], IPost):
"""
Specifies a base service request to register one or more products in a batch operation.
"""
# @ApiMember(Description="The products to register.", IsRequired=true)
products: Optional[List[Product]] = None
"""
The products to register.
"""
@staticmethod
def response_type(): return List[ProductResponse]
# @Api(Description="Represents a service request to register one or more products in a batch operation.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BatchRegisterProductsAsync(BatchRegisterProductsBase):
"""
Represents a service request to register one or more products in a batch operation.
"""
# @ApiMember(Description="The products to register.", IsRequired=true)
products: Optional[List[Product]] = None
"""
The products to register.
"""
Python BatchRegisterProductsAsync DTOs
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.
POST /async/products/batch HTTP/1.1
Host: taxfiling.pwc.de
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length
{"products":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}]}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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":"\/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}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}]