Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /async/products/search |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
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()
{
}
/**
* 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.")
open 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.")
open var accountId:Int? = null
/**
* The name of the product.
*/
@ApiMember(Description="The name of the product.")
open 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.")
open 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.")
open 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.")
open var nameContains:String? = null
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.")
open 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.")
open 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.")
open 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.")
open var versionContains:String? = null
/**
* The description of the product.
*/
@ApiMember(Description="The description of the product.")
open 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.")
open 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.")
open 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.")
open 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?")
open 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. ")
open 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. ")
open var takeOrders: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.")
override var skip:Int? = null
/**
* The number of query results to include.
*/
@ApiMember(Description="The number of query results to include.")
override 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.")
open var ordersMap:HashMap<Int,ArrayList<Order>> = HashMap<Int,ArrayList<Order>>()
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
open var offset:Int? = null
@DataMember(Order=2)
open var total:Int? = null
@DataMember(Order=3)
open var results:ArrayList<T>? = null
@DataMember(Order=4)
open var meta:HashMap<String,String>? = null
@DataMember(Order=5)
open 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)
open 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)
open var index:Int? = null
/**
* The name of the product.
*/
@ApiMember(Description="The name of the product.", IsRequired=true)
@Validate(Validator="NotEmpty")
override var name:String? = null
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.", IsRequired=true)
@Validate(Validator="NotEmpty")
open var version:String? = null
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.")
open var description:String? = null
/**
* Tags associated with the product.
*/
@ApiMember(Description="Tags associated with the product.")
open var tags:ArrayList<String> = ArrayList<String>()
}
Kotlin 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.staging.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
}
}
}