Tax Filing Service

<back to all web services

SearchProductsAsync

SearchProductsAsync

Represents a service to search for product data in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/products/search
SearchProductsAsync Parameters:
NameParameterData TypeRequiredDescription
ProductIdqueryint?NoThe unique identifier of the account associated with the product.
AccountIdqueryint?NoThe unique identifier of the account associated with the product.
NamequerystringNoThe name of the product.
NameStartsWithquerystringNoSearch by using the name of the product that starts with the specified value.
NameEndsWithquerystringNoSearch by using the name of the product that ends with the specified value.
NameContainsquerystringNoSearch by using the name of the product that contains the specified value.
VersionquerystringNoThe version of the product.
VersionStartsWithquerystringNoSearch by using the version of the product that starts with the specified value.
VersionEndsWithquerystringNoSearch by using the version of the product that ends with the specified value.
VersionContainsquerystringNoSearch by using the version of the product that contains the specified value.
DescriptionquerystringNoThe description of the product.
DescriptionStartsWithquerystringNoSearch by using the description of the product that starts with the specified value.
DescriptionEndsWithquerystringNoSearch by using the description of the product that ends with the specified value.
DescriptionContainsquerystringNoSearch by using the description of the product that contains the specified value.
IncludeOrdersquerybool?NoShould the related orders of the account be included in the retrieved products?
SkipOrdersqueryint?NoSpecifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true.
TakeOrdersqueryint?NoSpecifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true.
Skipqueryint?NoThe number of query results to skip.
Takequeryint?NoThe number of query results to include.
SearchProductsBase Parameters:
NameParameterData TypeRequiredDescription
ProductIdformint?NoThe unique identifier of the account associated with the product.
AccountIdformint?NoThe unique identifier of the account associated with the product.
NameformstringNoThe name of the product.
NameStartsWithformstringNoSearch by using the name of the product that starts with the specified value.
NameEndsWithformstringNoSearch by using the name of the product that ends with the specified value.
NameContainsformstringNoSearch by using the name of the product that contains the specified value.
VersionformstringNoThe version of the product.
VersionStartsWithformstringNoSearch by using the version of the product that starts with the specified value.
VersionEndsWithformstringNoSearch by using the version of the product that ends with the specified value.
VersionContainsformstringNoSearch by using the version of the product that contains the specified value.
DescriptionformstringNoThe description of the product.
DescriptionStartsWithformstringNoSearch by using the description of the product that starts with the specified value.
DescriptionEndsWithformstringNoSearch by using the description of the product that ends with the specified value.
DescriptionContainsformstringNoSearch by using the description of the product that contains the specified value.
IncludeOrdersformbool?NoShould the related orders of the account be included in the retrieved products?
SkipOrdersformint?NoSpecifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true.
TakeOrdersformint?NoSpecifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true.
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
PaginationBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?NoThe number of query results to skip.
Takeformint?NoThe number of query results to include.
ProductQueryResponse Parameters:
NameParameterData TypeRequiredDescription
OrdersMapformDictionary<int, List<Order>>YesThe dictionary of orders associated with each found product.
OffsetformintNo
TotalformintNo
ResultsformList<Product>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Product Parameters:
NameParameterData TypeRequiredDescription
IdformintYesThe unique identifier of the product.
IndexformintYesThe position of this instance in a collection of 'Product' instances
NameformstringYesThe name of the product.
VersionformstringYesThe version of the product.
DescriptionformstringNoThe version of the product.
TagsformList<string>YesTags associated with the product.

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

HTTP + 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>