Tax Filing Service

<back to all web services

BatchRegisterProductsAsync

RegisterProductsBatchAsync

Represents a service request to register one or more products in a batch operation.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanAdd
The following routes are available for this service:
POST/async/products/batch
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Represents a product.
*/
// @Api(Description="Represents a product.")
class Product implements IHasName, IConvertible
{
    /**
    * The unique identifier of the product.
    */
    // @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
    int? id;

    /**
    * The position of this instance in a collection of 'Product' instances
    */
    // @ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)
    int? index;

    /**
    * The name of the product.
    */
    // @ApiMember(Description="The name of the product.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    String? name;

    /**
    * The version of the product.
    */
    // @ApiMember(Description="The version of the product.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    String? version;

    /**
    * The version of the product.
    */
    // @ApiMember(Description="The version of the product.")
    String? description;

    /**
    * Tags associated with the product.
    */
    // @ApiMember(Description="Tags associated with the product.")
    List<String>? tags;

    Product({this.id,this.index,this.name,this.version,this.description,this.tags});
    Product.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        index = json['index'];
        name = json['name'];
        version = json['version'];
        description = json['description'];
        tags = JsonConverters.fromJson(json['tags'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'index': index,
        'name': name,
        'version': version,
        'description': description,
        'tags': JsonConverters.toJson(tags,'List<String>',context!)
    };

    getTypeName() => "Product";
    TypeContext? context = _ctx;
}

/**
* Specifies a base service request to register one or more products in a batch operation.
*/
// @Api(Description="Specifies a base service request to register one or more products in a batch operation.")
abstract class BatchRegisterProductsBase implements IPost
{
    /**
    * The products to register.
    */
    // @ApiMember(Description="The products to register.", IsRequired=true)
    List<Product>? products;

    BatchRegisterProductsBase({this.products});
    BatchRegisterProductsBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        products = JsonConverters.fromJson(json['products'],'List<Product>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'products': JsonConverters.toJson(products,'List<Product>',context!)
    };

    getTypeName() => "BatchRegisterProductsBase";
    TypeContext? context = _ctx;
}

/**
* Represents a service request to register one or more products in a batch operation.
*/
// @Api(Description="Represents a service request to register one or more products in a batch operation.")
class BatchRegisterProductsAsync extends BatchRegisterProductsBase implements IConvertible
{
    /**
    * The products to register.
    */
    // @ApiMember(Description="The products to register.", IsRequired=true)
    List<Product>? products;

    BatchRegisterProductsAsync({this.products});
    BatchRegisterProductsAsync.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        products = JsonConverters.fromJson(json['products'],'List<Product>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'products': JsonConverters.toJson(products,'List<Product>',context!)
    });

    getTypeName() => "BatchRegisterProductsAsync";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'taxfiling.pwc.de', types: <String, TypeInfo> {
    'Product': TypeInfo(TypeOf.Class, create:() => Product()),
    'BatchRegisterProductsBase': TypeInfo(TypeOf.AbstractClass),
    'List<Product>': TypeInfo(TypeOf.Class, create:() => <Product>[]),
    'BatchRegisterProductsAsync': TypeInfo(TypeOf.Class, create:() => BatchRegisterProductsAsync()),
});

Dart BatchRegisterProductsAsync 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.

POST /async/products/batch HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchRegisterProductsAsync xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Requests">
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
    <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>
  </Products>
</BatchRegisterProductsAsync>

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

<ArrayOfProductResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
  <ProductResponse>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d3p1:Meta>
    </ResponseStatus>
    <Orders xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
      <d3p1:Order>
        <d3p1:AccountId>0</d3p1:AccountId>
        <d3p1:ClientIPAddress>String</d3p1:ClientIPAddress>
        <d3p1:CreationDate>0001-01-01T00:00:00</d3p1:CreationDate>
        <d3p1:DataName>String</d3p1:DataName>
        <d3p1:DataType>String</d3p1:DataType>
        <d3p1:ExpiryDate>0001-01-01T00:00:00</d3p1:ExpiryDate>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:IsTest>false</d3p1:IsTest>
        <d3p1:Name>String</d3p1:Name>
        <d3p1:ProcessType>String</d3p1:ProcessType>
        <d3p1:ProductId>0</d3p1:ProductId>
        <d3p1:RequestDuration>PT0S</d3p1:RequestDuration>
        <d3p1:RequestHttpMethod>String</d3p1:RequestHttpMethod>
        <d3p1:RequestTimestamp>0001-01-01T00:00:00</d3p1:RequestTimestamp>
        <d3p1:RequestUri>String</d3p1:RequestUri>
        <d3p1:ResponseStatusCode>Continue</d3p1:ResponseStatusCode>
        <d3p1:ResponseTimestamp>0001-01-01T00:00:00</d3p1:ResponseTimestamp>
        <d3p1:ServiceName>String</d3p1:ServiceName>
        <d3p1:UnitOfMeasurement>String</d3p1:UnitOfMeasurement>
      </d3p1:Order>
    </Orders>
    <Product xmlns:d3p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
      <d3p1:Description>String</d3p1:Description>
      <d3p1:Id>0</d3p1:Id>
      <d3p1:Index>0</d3p1:Index>
      <d3p1:Name>String</d3p1:Name>
      <d3p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d3p1:Tags>
      <d3p1:Version>String</d3p1:Version>
    </Product>
  </ProductResponse>
</ArrayOfProductResponse>
© 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.