Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/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. */
// @Api(Description="Represents a service to search for product data.")
export class SearchProducts 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<SearchProducts>) { 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 SearchProducts DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /sync/products/search HTTP/1.1 Host: taxfiling.pwc.de Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ProductQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses">
<Offset xmlns="http://schemas.servicestack.net/types">0</Offset>
<Total xmlns="http://schemas.servicestack.net/types">0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models" xmlns="http://schemas.servicestack.net/types">
<d2p1:Product>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:Index>0</d2p1:Index>
<d2p1:Name>String</d2p1:Name>
<d2p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:Tags>
<d2p1:Version>String</d2p1:Version>
</d2p1:Product>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus xmlns="http://schemas.servicestack.net/types">
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
<OrdersMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfintArrayOfOrderKY2vvLcG>
<d2p1:Key>0</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
<d4p1:Order>
<d4p1:AccountId>0</d4p1:AccountId>
<d4p1:ClientIPAddress>String</d4p1:ClientIPAddress>
<d4p1:CreationDate>0001-01-01T00:00:00</d4p1:CreationDate>
<d4p1:DataName>String</d4p1:DataName>
<d4p1:DataType>String</d4p1:DataType>
<d4p1:ExpiryDate>0001-01-01T00:00:00</d4p1:ExpiryDate>
<d4p1:Id>0</d4p1:Id>
<d4p1:IsTest>false</d4p1:IsTest>
<d4p1:Name>String</d4p1:Name>
<d4p1:ProcessType>String</d4p1:ProcessType>
<d4p1:ProductId>0</d4p1:ProductId>
<d4p1:RequestDuration>PT0S</d4p1:RequestDuration>
<d4p1:RequestHttpMethod>String</d4p1:RequestHttpMethod>
<d4p1:RequestTimestamp>0001-01-01T00:00:00</d4p1:RequestTimestamp>
<d4p1:RequestUri>String</d4p1:RequestUri>
<d4p1:ResponseStatusCode>Continue</d4p1:ResponseStatusCode>
<d4p1:ResponseTimestamp>0001-01-01T00:00:00</d4p1:ResponseTimestamp>
<d4p1:ServiceName>String</d4p1:ServiceName>
<d4p1:UnitOfMeasurement>String</d4p1:UnitOfMeasurement>
</d4p1:Order>
</d2p1:Value>
</d2p1:KeyValueOfintArrayOfOrderKY2vvLcG>
</OrdersMap>
</ProductQueryResponse>