Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /async/products/search |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* 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.")
open class SearchProductsAsync : SearchProductsBase()
{
/**
* The unique identifier of the account associated with the product.
*/
@ApiMember(Description="The unique identifier of the account associated with the product.")
var productId:Int? = null
/**
* The unique identifier of the account associated with the product.
*/
@ApiMember(Description="The unique identifier of the account associated with the product.")
var accountId:Int? = null
/**
* The name of the product.
*/
@ApiMember(Description="The name of the product.")
var name:String? = null
/**
* 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.")
var nameStartsWith:String? = null
/**
* 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.")
var nameEndsWith:String? = null
/**
* 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.")
var nameContains:String? = null
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.")
var version:String? = null
/**
* 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.")
var versionStartsWith:String? = null
/**
* 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.")
var versionEndsWith:String? = null
/**
* 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.")
var versionContains:String? = null
/**
* The description of the product.
*/
@ApiMember(Description="The description of the product.")
var description:String? = null
/**
* 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.")
var descriptionStartsWith:String? = null
/**
* 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.")
var descriptionEndsWith:String? = null
/**
* 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.")
var descriptionContains:String? = null
/**
* 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?")
var includeOrders:Boolean? = null
/**
* 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. ")
var skipOrders:Int? = null
/**
* 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. ")
var takeOrders:Int? = null
/**
* The number of query results to skip.
*/
@ApiMember(Description="The number of query results to skip.")
var skip:Int? = null
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
var take:Int? = null
}
/**
* Specifies a service to search for products.
*/
@Api(Description="Specifies a service to search for products.")
open class SearchProductsBase : PaginationBase(), IGet
{
/**
* The unique identifier of the account associated with the product.
*/
@ApiMember(Description="The unique identifier of the account associated with the product.")
var productId:Int? = null
/**
* The unique identifier of the account associated with the product.
*/
@ApiMember(Description="The unique identifier of the account associated with the product.")
var accountId:Int? = null
/**
* The name of the product.
*/
@ApiMember(Description="The name of the product.")
var name:String? = null
/**
* 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.")
var nameStartsWith:String? = null
/**
* 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.")
var nameEndsWith:String? = null
/**
* 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.")
var nameContains:String? = null
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.")
var version:String? = null
/**
* 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.")
var versionStartsWith:String? = null
/**
* 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.")
var versionEndsWith:String? = null
/**
* 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.")
var versionContains:String? = null
/**
* The description of the product.
*/
@ApiMember(Description="The description of the product.")
var description:String? = null
/**
* 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.")
var descriptionStartsWith:String? = null
/**
* 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.")
var descriptionEndsWith:String? = null
/**
* 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.")
var descriptionContains:String? = null
/**
* 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?")
var includeOrders:Boolean? = null
/**
* 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. ")
var skipOrders:Int? = null
/**
* 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. ")
var takeOrders:Int? = null
/**
* The number of query results to skip.
*/
@ApiMember(Description="The number of query results to skip.")
var skip:Int? = null
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
var take:Int? = null
}
/**
* The number of query results to skip.
*/
@Api(Description="The number of query results to skip.")
open class PaginationBase : IPaginate
{
/**
* The number of query results to skip.
*/
@ApiMember(Description="The number of query results to skip.")
var skip:Int? = null
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
var take:Int? = null
}
/**
* 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.")
open class ProductQueryResponse : QueryResponse<Product>()
{
/**
* The dictionary of orders associated with each found product.
*/
@ApiMember(Description="The dictionary of orders associated with each found product.")
var ordersMap:HashMap<Int,ArrayList<Order>> = HashMap<Int,ArrayList<Order>>()
@DataMember(Order=1)
var offset:Int? = null
@DataMember(Order=2)
var total:Int? = null
@DataMember(Order=3)
var results:ArrayList<Product> = ArrayList<Product>()
@DataMember(Order=4)
var meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var responseStatus:ResponseStatus? = null
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
var offset:Int? = null
@DataMember(Order=2)
var total:Int? = null
@DataMember(Order=3)
var results:ArrayList<T> = ArrayList<T>()
@DataMember(Order=4)
var meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var responseStatus:ResponseStatus? = null
}
/**
* Represents a product.
*/
@Api(Description="Represents a product.")
open class Product : IHasName
{
/**
* The unique identifier of the product.
*/
@ApiMember(Description="The unique identifier of the product.", IsRequired=true)
var id:Int? = null
/**
* 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)
var index:Int? = null
/**
* The name of the product.
*/
@ApiMember(Description="The name of the product.", IsRequired=true)
@Validate(Validator="NotEmpty")
var name:String? = null
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.", IsRequired=true)
@Validate(Validator="NotEmpty")
var version:String? = null
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.")
var description:String? = null
/**
* Tags associated with the product.
*/
@ApiMember(Description="Tags associated with the product.")
var tags:ArrayList<String> = ArrayList<String>()
}
Kotlin SearchProductsAsync 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 /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>