Required role: | Admin | Required permissions: | CanAccess, CanAdd |
POST | /sync/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 BatchRegisterProducts extends BatchRegisterProductsBase
{
/** @description The products to register. */
// @ApiMember(Description="The products to register.", IsRequired=true)
public products: Product[];
public constructor(init?: Partial<BatchRegisterProducts>) { super(init); (Object as any).assign(this, init); }
}
TypeScript BatchRegisterProducts DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sync/products/batch HTTP/1.1
Host: taxfiling.pwc.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
products:
[
{
id: 0,
index: 0,
name: String,
version: String,
description: String,
tags:
[
String
]
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv 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: 0001-01-01, responseTimestamp: 0001-01-01, requestUri: String, requestHttpMethod: String, requestDuration: PT0S, responseStatusCode: Continue, clientIPAddress: String, unitOfMeasurement: String, processType: String, dataType: String, dataName: String, creationDate: 0001-01-01, expiryDate: 0001-01-01, isTest: False } ], responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } } ]