Required role: | Admin | Required permission: | CanAccess |
GET | /async/products/search |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | query | int? | No | The unique identifier of the account associated with the product. |
AccountId | query | int? | No | The unique identifier of the account associated with the product. |
Name | query | string | No | The name of the product. |
NameStartsWith | query | string | No | Search by using the name of the product that starts with the specified value. |
NameEndsWith | query | string | No | Search by using the name of the product that ends with the specified value. |
NameContains | query | string | No | Search by using the name of the product that contains the specified value. |
Version | query | string | No | The version of the product. |
VersionStartsWith | query | string | No | Search by using the version of the product that starts with the specified value. |
VersionEndsWith | query | string | No | Search by using the version of the product that ends with the specified value. |
VersionContains | query | string | No | Search by using the version of the product that contains the specified value. |
Description | query | string | No | The description of the product. |
DescriptionStartsWith | query | string | No | Search by using the description of the product that starts with the specified value. |
DescriptionEndsWith | query | string | No | Search by using the description of the product that ends with the specified value. |
DescriptionContains | query | string | No | Search by using the description of the product that contains the specified value. |
IncludeOrders | query | bool? | No | Should the related orders of the account be included in the retrieved products? |
SkipOrders | query | int? | No | Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. |
TakeOrders | query | int? | No | Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. |
Skip | query | int? | No | The number of query results to skip. |
Take | query | int? | No | The number of query results to include. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductId | form | int? | No | The unique identifier of the account associated with the product. |
AccountId | form | int? | No | The unique identifier of the account associated with the product. |
Name | form | string | No | The name of the product. |
NameStartsWith | form | string | No | Search by using the name of the product that starts with the specified value. |
NameEndsWith | form | string | No | Search by using the name of the product that ends with the specified value. |
NameContains | form | string | No | Search by using the name of the product that contains the specified value. |
Version | form | string | No | The version of the product. |
VersionStartsWith | form | string | No | Search by using the version of the product that starts with the specified value. |
VersionEndsWith | form | string | No | Search by using the version of the product that ends with the specified value. |
VersionContains | form | string | No | Search by using the version of the product that contains the specified value. |
Description | form | string | No | The description of the product. |
DescriptionStartsWith | form | string | No | Search by using the description of the product that starts with the specified value. |
DescriptionEndsWith | form | string | No | Search by using the description of the product that ends with the specified value. |
DescriptionContains | form | string | No | Search by using the description of the product that contains the specified value. |
IncludeOrders | form | bool? | No | Should the related orders of the account be included in the retrieved products? |
SkipOrders | form | int? | No | Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. |
TakeOrders | form | int? | No | Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. |
Skip | form | int? | No | The number of query results to skip. |
Take | form | int? | No | The number of query results to include. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | The number of query results to skip. |
Take | form | int? | No | The number of query results to include. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OrdersMap | form | Dictionary<int, List<Order>> | Yes | The dictionary of orders associated with each found product. |
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<Product> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | Yes | The unique identifier of the product. |
Index | form | int | Yes | The position of this instance in a collection of 'Product' instances |
Name | form | string | Yes | The name of the product. |
Version | form | string | Yes | The version of the product. |
Description | form | string | No | The version of the product. |
Tags | form | List<string> | Yes | Tags associated with the product. |
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 /async/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>