Tax Filing Service

<back to all web services

RetrieveAllProductsAsync

RetrieveProductsAsync

Represents a service request to retrieve all products in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/products
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* The number of query results to skip.
*/
// @Api(Description="The number of query results to skip.")
abstract class PaginationBase implements IPaginate
{
    /**
    * The number of query results to skip.
    */
    // @ApiMember(Description="The number of query results to skip.")
    int? skip;

    /**
    * The number of query results to include.
    */
    // @ApiMember(Description="The number of query results to include.")
    int? take;

    PaginationBase({this.skip,this.take});
    PaginationBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        skip = json['skip'];
        take = json['take'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'skip': skip,
        'take': take
    };

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

/**
* Specifies a service to retrieve all products.
*/
// @Api(Description="Specifies a service to retrieve all products.")
abstract class RetrieveAllProductsBase extends PaginationBase implements IGet
{
    /**
    * Should the related orders of the account be included in the retrieved products?
    */
    // @ApiMember(Description="Should the related orders of the account be included in the retrieved products?")
    bool? includeOrders;

    /**
    * Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. 
    */
    // @ApiMember(Description="Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. ")
    int? skipOrders;

    /**
    * Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. 
    */
    // @ApiMember(Description="Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. ")
    int? takeOrders;

    /**
    * The number of query results to skip.
    */
    // @ApiMember(Description="The number of query results to skip.")
    int? skip;

    /**
    * The number of query results to include.
    */
    // @ApiMember(Description="The number of query results to include.")
    int? take;

    RetrieveAllProductsBase({this.includeOrders,this.skipOrders,this.takeOrders,this.skip,this.take});
    RetrieveAllProductsBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        includeOrders = json['includeOrders'];
        skipOrders = json['skipOrders'];
        takeOrders = json['takeOrders'];
        skip = json['skip'];
        take = json['take'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'includeOrders': includeOrders,
        'skipOrders': skipOrders,
        'takeOrders': takeOrders,
        'skip': skip,
        'take': take
    });

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

/**
* 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;
}

/**
* Represents a query response that contains a structured error information and encapsulates products.
*/
// @Api(Description="Represents a query response that contains a structured error information and encapsulates products.")
class ProductQueryResponse extends QueryResponse<Product> implements IConvertible
{
    /**
    * The dictionary of orders associated with each found product.
    */
    // @ApiMember(Description="The dictionary of orders associated with each found product.")
    Map<int,List<Order>?>? ordersMap;

    // @DataMember(Order=1)
    int? offset;

    // @DataMember(Order=2)
    int? total;

    // @DataMember(Order=3)
    List<Product>? results;

    // @DataMember(Order=4)
    Map<String,String?>? meta;

    // @DataMember(Order=5)
    ResponseStatus? responseStatus;

    ProductQueryResponse({this.ordersMap,this.offset,this.total,this.results,this.meta,this.responseStatus});
    ProductQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ordersMap = JsonConverters.fromJson(json['ordersMap'],'Map<int,List<Order>?>',context!);
        offset = json['offset'];
        total = json['total'];
        results = JsonConverters.fromJson(json['results'],'List<Product>',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ordersMap': JsonConverters.toJson(ordersMap,'Map<int,List<Order>?>',context!),
        'offset': offset,
        'total': total,
        'results': JsonConverters.toJson(results,'List<Product>',context!),
        'meta': meta,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    });

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

/**
* Represents a service request to retrieve all products in an asynchronous operation.
*/
// @Api(Description="Represents a service request to retrieve all products in an asynchronous operation.")
class RetrieveAllProductsAsync extends RetrieveAllProductsBase implements IConvertible
{
    /**
    * Should the related orders of the account be included in the retrieved products?
    */
    // @ApiMember(Description="Should the related orders of the account be included in the retrieved products?")
    bool? includeOrders;

    /**
    * Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. 
    */
    // @ApiMember(Description="Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. ")
    int? skipOrders;

    /**
    * Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. 
    */
    // @ApiMember(Description="Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. ")
    int? takeOrders;

    /**
    * The number of query results to skip.
    */
    // @ApiMember(Description="The number of query results to skip.")
    int? skip;

    /**
    * The number of query results to include.
    */
    // @ApiMember(Description="The number of query results to include.")
    int? take;

    RetrieveAllProductsAsync({this.includeOrders,this.skipOrders,this.takeOrders,this.skip,this.take});
    RetrieveAllProductsAsync.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        includeOrders = json['includeOrders'];
        skipOrders = json['skipOrders'];
        takeOrders = json['takeOrders'];
        skip = json['skip'];
        take = json['take'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'includeOrders': includeOrders,
        'skipOrders': skipOrders,
        'takeOrders': takeOrders,
        'skip': skip,
        'take': take
    });

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

// @DataContract
class QueryResponse<T> implements IConvertible
{
    // @DataMember(Order=1)
    int? offset;

    // @DataMember(Order=2)
    int? total;

    // @DataMember(Order=3)
    List<T>? results;

    // @DataMember(Order=4)
    Map<String,String?>? meta;

    // @DataMember(Order=5)
    ResponseStatus? responseStatus;

    QueryResponse({this.offset,this.total,this.results,this.meta,this.responseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        offset = json['offset'];
        total = json['total'];
        results = JsonConverters.fromJson(json['results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'offset': offset,
        'total': total,
        'results': JsonConverters.toJson(results,'List<T>',context!),
        'meta': meta,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$T>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'taxfiling.pwc.de', types: <String, TypeInfo> {
    'PaginationBase': TypeInfo(TypeOf.AbstractClass),
    'RetrieveAllProductsBase': TypeInfo(TypeOf.AbstractClass),
    'Product': TypeInfo(TypeOf.Class, create:() => Product()),
    'ProductQueryResponse': TypeInfo(TypeOf.Class, create:() => ProductQueryResponse()),
    'Map<int,List<Order>?>': TypeInfo(TypeOf.Class, create:() => Map<int,List<Order>?>()),
    'List<Order>': TypeInfo(TypeOf.Class, create:() => <Order>[]),
    'Order': TypeInfo(TypeOf.Class, create:() => Order()),
    'List<Product>': TypeInfo(TypeOf.Class, create:() => <Product>[]),
    'RetrieveAllProductsAsync': TypeInfo(TypeOf.Class, create:() => RetrieveAllProductsAsync()),
});

Dart RetrieveAllProductsAsync DTOs

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

HTTP + CSV

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

GET /async/products HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ordersMap":{"0":[{"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}]},"offset":0,"total":0,"results":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}
© 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.