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
"use strict";
export class Product {
    /** @param {{id?:number,index?:number,name?:string,version?:string,description?:string,tags?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the product. */
    id;
    /**
     * @type {number}
     * @description The position of this instance in a collection of 'Product' instances */
    index;
    /**
     * @type {string}
     * @description The name of the product. */
    name;
    /**
     * @type {string}
     * @description The version of the product. */
    version;
    /**
     * @type {?string}
     * @description The version of the product. */
    description;
    /**
     * @type {string[]}
     * @description Tags associated with the product. */
    tags;
}
export class BatchRegisterProductsBase {
    /** @param {{products?:Product[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Product[]}
     * @description The products to register. */
    products;
}
export class BatchRegisterProductsAsync extends BatchRegisterProductsBase {
    /** @param {{products?:Product[],products?:Product[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {Product[]}
     * @description The products to register. */
    products;
}

JavaScript BatchRegisterProductsAsync DTOs

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

HTTP + 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"}}}]