Tax Filing Service

RegisterProductAsync

RegisterProductsAsync

Represents a service request to register a product in an asynchronous operation

**Requires Authentication**
Required role:	Admin	Required permissions:	CanAccess, CanAdd

The following routes are available for this service:
POST	/async/products

"use strict";
export class RegisterProductBase {
    /** @param {{name?:string,description?:string,version?:string,tags?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The name of the product. */
    name;
    /**
     * @type {?string}
     * @description The description of the product. */
    description;
    /**
     * @type {?string}
     * @description The version of the product. */
    version;
    /**
     * @type {string[]}
     * @description Tags associated with the product. */
    tags;
}
export class ServiceResponseBase {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?ResponseStatus}
     * @description Data structure that holds error information from a service operation. */
    responseStatus;
}
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 Order {
    /** @param {{id?:number,productId?:number,accountId?:number,name?:string,serviceName?:string,requestTimestamp?:string,responseTimestamp?:string,requestUri?:string,requestHttpMethod?:string,requestDuration?:string,responseStatusCode?:HttpStatusCode,clientIPAddress?:string,unitOfMeasurement?:string,processType?:string,dataType?:string,dataName?:string,creationDate?:string,expiryDate?:string,isTest?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The unique identifier of the order. */
    id;
    /**
     * @type {number}
     * @description The unique identifier of the product, for which the order is made. */
    productId;
    /**
     * @type {number}
     * @description The unique identifier of the user account, who placed the order. */
    accountId;
    /**
     * @type {string}
     * @description A name to identify the order. */
    name;
    /**
     * @type {?string}
     * @description The name of the service, for which the order was made. */
    serviceName;
    /**
     * @type {?string}
     * @description The time stamp at which the order was initiated. */
    requestTimestamp;
    /**
     * @type {?string}
     * @description The time stamp at which the order was completed. */
    responseTimestamp;
    /**
     * @type {?string}
     * @description The URI from which the order was initiated. */
    requestUri;
    /**
     * @type {?string}
     * @description The HTTP method of the order request. */
    requestHttpMethod;
    /**
     * @type {?string}
     * @description The duration of the order request. */
    requestDuration;
    /**
     * @type {HttpStatusCode}
     * @description The HTTP status code of the order request. */
    responseStatusCode;
    /**
     * @type {?string}
     * @description The IP address of client, who placed the order. */
    clientIPAddress;
    /**
     * @type {?string}
     * @description The unit of measurement for the order. */
    unitOfMeasurement;
    /**
     * @type {?string}
     * @description The type of process, for which the order is charged. */
    processType;
    /**
     * @type {?string}
     * @description The type of data, for which the order is charged. */
    dataType;
    /**
     * @type {?string}
     * @description The name of the data, for which the order is charged. */
    dataName;
    /**
     * @type {string}
     * @description The date of creation of the order. */
    creationDate;
    /**
     * @type {?string}
     * @description The final date to retain the order in the records. After this date, the order is expunged from the records. */
    expiryDate;
    /**
     * @type {boolean}
     * @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. */
    isTest;
}
export class ProductResponse extends ServiceResponseBase {
    /** @param {{product?:Product,orders?:Order[],responseStatus?:ResponseStatus,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?Product}
     * @description The product data of the response. */
    product;
    /**
     * @type {Order[]}
     * @description The list of orders associated with the encapsulated product. */
    orders;
    /**
     * @type {?ResponseStatus}
     * @description Data structure that holds error information from a service operation. */
    responseStatus;
}
export class RegisterProductAsync extends RegisterProductBase {
    /** @param {{name?:string,description?:string,version?:string,tags?:string[],name?:string,description?:string,version?:string,tags?:string[]}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The name of the product. */
    name;
    /**
     * @type {?string}
     * @description The description of the product. */
    description;
    /**
     * @type {?string}
     * @description The version of the product. */
    version;
    /**
     * @type {string[]}
     * @description Tags associated with the product. */
    tags;
}

JavaScript RegisterProductAsync DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"name":"String","description":"String","version":"String","tags":["String"]}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}