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

/** @description Represents a product. */
// @Api(Description="Represents a product.")
export class Product implements IHasName
{
    /** @description The unique identifier of the product. */
    // @ApiMember(Description="The unique identifier of the product.", IsRequired=true)
    public id: number;

    /** @description 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)
    public index: number;

    /** @description The name of the product. */
    // @ApiMember(Description="The name of the product.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    public name: string;

    /** @description The version of the product. */
    // @ApiMember(Description="The version of the product.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    public version: string;

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

    /** @description Tags associated with the product. */
    // @ApiMember(Description="Tags associated with the product.")
    public tags: string[];

    public constructor(init?: Partial<Product>) { (Object as any).assign(this, init); }
}

/** @description 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.")
export class BatchRegisterProductsBase implements IPost
{
    /** @description The products to register. */
    // @ApiMember(Description="The products to register.", IsRequired=true)
    public products: Product[];

    public constructor(init?: Partial<BatchRegisterProductsBase>) { (Object as any).assign(this, init); }
}

/** @description 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.")
export class BatchRegisterProductsAsync extends BatchRegisterProductsBase
{
    /** @description The products to register. */
    // @ApiMember(Description="The products to register.", IsRequired=true)
    public products: Product[];

    public constructor(init?: Partial<BatchRegisterProductsAsync>) { super(init); (Object as any).assign(this, init); }
}

TypeScript BatchRegisterProductsAsync DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"products":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}]