Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /async/products/search |
|---|
/** @description The number of query results to skip. */
// @Api(Description="The number of query results to skip.")
export class PaginationBase implements IPaginate
{
/** @description The number of query results to skip. */
// @ApiMember(Description="The number of query results to skip.")
public skip?: number;
/** @description The number of query results to include. */
// @ApiMember(Description="The number of query results to include.")
public take?: number;
public constructor(init?: Partial<PaginationBase>) { (Object as any).assign(this, init); }
}
/** @description Specifies a service to search for products. */
// @Api(Description="Specifies a service to search for products.")
export class SearchProductsBase extends PaginationBase implements IGet
{
/** @description The unique identifier of the account associated with the product. */
// @ApiMember(Description="The unique identifier of the account associated with the product.")
public productId?: number;
/** @description The unique identifier of the account associated with the product. */
// @ApiMember(Description="The unique identifier of the account associated with the product.")
public accountId?: number;
/** @description The name of the product. */
// @ApiMember(Description="The name of the product.")
public name?: string;
/** @description Search by using the name of the product that starts with the specified value. */
// @ApiMember(Description="Search by using the name of the product that starts with the specified value.")
public nameStartsWith?: string;
/** @description Search by using the name of the product that ends with the specified value. */
// @ApiMember(Description="Search by using the name of the product that ends with the specified value.")
public nameEndsWith?: string;
/** @description Search by using the name of the product that contains the specified value. */
// @ApiMember(Description="Search by using the name of the product that contains the specified value.")
public nameContains?: string;
/** @description The version of the product. */
// @ApiMember(Description="The version of the product.")
public version?: string;
/** @description Search by using the version of the product that starts with the specified value. */
// @ApiMember(Description="Search by using the version of the product that starts with the specified value.")
public versionStartsWith?: string;
/** @description Search by using the version of the product that ends with the specified value. */
// @ApiMember(Description="Search by using the version of the product that ends with the specified value.")
public versionEndsWith?: string;
/** @description Search by using the version of the product that contains the specified value. */
// @ApiMember(Description="Search by using the version of the product that contains the specified value.")
public versionContains?: string;
/** @description The description of the product. */
// @ApiMember(Description="The description of the product.")
public description?: string;
/** @description Search by using the description of the product that starts with the specified value. */
// @ApiMember(Description="Search by using the description of the product that starts with the specified value.")
public descriptionStartsWith?: string;
/** @description Search by using the description of the product that ends with the specified value. */
// @ApiMember(Description="Search by using the description of the product that ends with the specified value.")
public descriptionEndsWith?: string;
/** @description Search by using the description of the product that contains the specified value. */
// @ApiMember(Description="Search by using the description of the product that contains the specified value.")
public descriptionContains?: string;
/** @description 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?")
public includeOrders?: boolean;
/** @description 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. ")
public skipOrders?: number;
/** @description 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. ")
public takeOrders?: number;
/** @description The number of query results to skip. */
// @ApiMember(Description="The number of query results to skip.")
public skip?: number;
/** @description The number of query results to include. */
// @ApiMember(Description="The number of query results to include.")
public take?: number;
public constructor(init?: Partial<SearchProductsBase>) { super(init); (Object as any).assign(this, init); }
}
/** @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 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.")
export class ProductQueryResponse extends QueryResponse<Product>
{
/** @description The dictionary of orders associated with each found product. */
// @ApiMember(Description="The dictionary of orders associated with each found product.")
public ordersMap: { [index: number]: Order[]; };
// @DataMember(Order=1)
public offset: number;
// @DataMember(Order=2)
public total: number;
// @DataMember(Order=3)
public results: Product[];
// @DataMember(Order=4)
public meta: { [index: string]: string; };
// @DataMember(Order=5)
public responseStatus: ResponseStatus;
public constructor(init?: Partial<ProductQueryResponse>) { super(init); (Object as any).assign(this, init); }
}
/** @description Represents a service to search for product data in an asynchronous operation. */
// @Api(Description="Represents a service to search for product data in an asynchronous operation.")
export class SearchProductsAsync extends SearchProductsBase
{
/** @description The unique identifier of the account associated with the product. */
// @ApiMember(Description="The unique identifier of the account associated with the product.")
public productId?: number;
/** @description The unique identifier of the account associated with the product. */
// @ApiMember(Description="The unique identifier of the account associated with the product.")
public accountId?: number;
/** @description The name of the product. */
// @ApiMember(Description="The name of the product.")
public name?: string;
/** @description Search by using the name of the product that starts with the specified value. */
// @ApiMember(Description="Search by using the name of the product that starts with the specified value.")
public nameStartsWith?: string;
/** @description Search by using the name of the product that ends with the specified value. */
// @ApiMember(Description="Search by using the name of the product that ends with the specified value.")
public nameEndsWith?: string;
/** @description Search by using the name of the product that contains the specified value. */
// @ApiMember(Description="Search by using the name of the product that contains the specified value.")
public nameContains?: string;
/** @description The version of the product. */
// @ApiMember(Description="The version of the product.")
public version?: string;
/** @description Search by using the version of the product that starts with the specified value. */
// @ApiMember(Description="Search by using the version of the product that starts with the specified value.")
public versionStartsWith?: string;
/** @description Search by using the version of the product that ends with the specified value. */
// @ApiMember(Description="Search by using the version of the product that ends with the specified value.")
public versionEndsWith?: string;
/** @description Search by using the version of the product that contains the specified value. */
// @ApiMember(Description="Search by using the version of the product that contains the specified value.")
public versionContains?: string;
/** @description The description of the product. */
// @ApiMember(Description="The description of the product.")
public description?: string;
/** @description Search by using the description of the product that starts with the specified value. */
// @ApiMember(Description="Search by using the description of the product that starts with the specified value.")
public descriptionStartsWith?: string;
/** @description Search by using the description of the product that ends with the specified value. */
// @ApiMember(Description="Search by using the description of the product that ends with the specified value.")
public descriptionEndsWith?: string;
/** @description Search by using the description of the product that contains the specified value. */
// @ApiMember(Description="Search by using the description of the product that contains the specified value.")
public descriptionContains?: string;
/** @description 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?")
public includeOrders?: boolean;
/** @description 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. ")
public skipOrders?: number;
/** @description 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. ")
public takeOrders?: number;
/** @description The number of query results to skip. */
// @ApiMember(Description="The number of query results to skip.")
public skip?: number;
/** @description The number of query results to include. */
// @ApiMember(Description="The number of query results to include.")
public take?: number;
public constructor(init?: Partial<SearchProductsAsync>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<T>
{
// @DataMember(Order=1)
public offset: number;
// @DataMember(Order=2)
public total: number;
// @DataMember(Order=3)
public results: T[];
// @DataMember(Order=4)
public meta: { [index: string]: string; };
// @DataMember(Order=5)
public responseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}
TypeScript SearchProductsAsync 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.
GET /async/products/search HTTP/1.1 Host: taxfiling.pwc.de Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ordersMap:
{
0:
[
{
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
}
]
},
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
}
}
}