Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /sync/products/search |
|---|
namespace PwC.Metering.Core.Domain.Concretes.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
///<summary>
///Represents a product.
///</summary>
[<Api(Description="Represents a product.")>]
[<AllowNullLiteral>]
type Product() =
///<summary>
///The unique identifier of the product.
///</summary>
[<ApiMember(Description="The unique identifier of the product.", IsRequired=true)>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The position of this instance in a collection of 'Product' instances
///</summary>
[<ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)>]
member val Index:Int32 = new Int32() with get,set
///<summary>
///The name of the product.
///</summary>
[<ApiMember(Description="The name of the product.", IsRequired=true)>]
[<Validate(Validator="NotEmpty")>]
member val Name:String = null with get,set
///<summary>
///The version of the product.
///</summary>
[<ApiMember(Description="The version of the product.", IsRequired=true)>]
[<Validate(Validator="NotEmpty")>]
member val Version:String = null with get,set
///<summary>
///The version of the product.
///</summary>
[<ApiMember(Description="The version of the product.")>]
member val Description:String = null with get,set
///<summary>
///Tags associated with the product.
///</summary>
[<ApiMember(Description="Tags associated with the product.")>]
member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///Represents a query response that contains a structured error information and encapsulates products.
///</summary>
[<Api(Description="Represents a query response that contains a structured error information and encapsulates products.")>]
[<AllowNullLiteral>]
type ProductQueryResponse() =
inherit QueryResponse<Product>()
///<summary>
///The dictionary of orders associated with each found product.
///</summary>
[<ApiMember(Description="The dictionary of orders associated with each found product.")>]
member val OrdersMap:Dictionary<Int32, List<Order>> = new Dictionary<Int32, List<Order>>() with get,set
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<Product> = new ResizeArray<Product>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///The number of query results to skip.
///</summary>
[<Api(Description="The number of query results to skip.")>]
[<AllowNullLiteral>]
type PaginationBase() =
///<summary>
///The number of query results to skip.
///</summary>
[<ApiMember(Description="The number of query results to skip.")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to include.
///</summary>
[<ApiMember(Description="The number of query results to include.")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Specifies a service to search for products.
///</summary>
[<Api(Description="Specifies a service to search for products.")>]
[<AllowNullLiteral>]
type SearchProductsBase() =
inherit PaginationBase()
interface IGet
///<summary>
///The unique identifier of the account associated with the product.
///</summary>
[<ApiMember(Description="The unique identifier of the account associated with the product.")>]
member val ProductId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The unique identifier of the account associated with the product.
///</summary>
[<ApiMember(Description="The unique identifier of the account associated with the product.")>]
member val AccountId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The name of the product.
///</summary>
[<ApiMember(Description="The name of the product.")>]
member val Name:String = null with get,set
///<summary>
///Search by using the name of the product that starts with the specified value.
///</summary>
[<ApiMember(Description="Search by using the name of the product that starts with the specified value.")>]
member val NameStartsWith:String = null with get,set
///<summary>
///Search by using the name of the product that ends with the specified value.
///</summary>
[<ApiMember(Description="Search by using the name of the product that ends with the specified value.")>]
member val NameEndsWith:String = null with get,set
///<summary>
///Search by using the name of the product that contains the specified value.
///</summary>
[<ApiMember(Description="Search by using the name of the product that contains the specified value.")>]
member val NameContains:String = null with get,set
///<summary>
///The version of the product.
///</summary>
[<ApiMember(Description="The version of the product.")>]
member val Version:String = null with get,set
///<summary>
///Search by using the version of the product that starts with the specified value.
///</summary>
[<ApiMember(Description="Search by using the version of the product that starts with the specified value.")>]
member val VersionStartsWith:String = null with get,set
///<summary>
///Search by using the version of the product that ends with the specified value.
///</summary>
[<ApiMember(Description="Search by using the version of the product that ends with the specified value.")>]
member val VersionEndsWith:String = null with get,set
///<summary>
///Search by using the version of the product that contains the specified value.
///</summary>
[<ApiMember(Description="Search by using the version of the product that contains the specified value.")>]
member val VersionContains:String = null with get,set
///<summary>
///The description of the product.
///</summary>
[<ApiMember(Description="The description of the product.")>]
member val Description:String = null with get,set
///<summary>
///Search by using the description of the product that starts with the specified value.
///</summary>
[<ApiMember(Description="Search by using the description of the product that starts with the specified value.")>]
member val DescriptionStartsWith:String = null with get,set
///<summary>
///Search by using the description of the product that ends with the specified value.
///</summary>
[<ApiMember(Description="Search by using the description of the product that ends with the specified value.")>]
member val DescriptionEndsWith:String = null with get,set
///<summary>
///Search by using the description of the product that contains the specified value.
///</summary>
[<ApiMember(Description="Search by using the description of the product that contains the specified value.")>]
member val DescriptionContains:String = null with get,set
///<summary>
///Should the related orders of the account be included in the retrieved products?
///</summary>
[<ApiMember(Description="Should the related orders of the account be included in the retrieved products?")>]
member val IncludeOrders:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true.
///</summary>
[<ApiMember(Description="Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. ")>]
member val SkipOrders:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true.
///</summary>
[<ApiMember(Description="Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. ")>]
member val TakeOrders:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to skip.
///</summary>
[<ApiMember(Description="The number of query results to skip.")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to include.
///</summary>
[<ApiMember(Description="The number of query results to include.")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Represents a service to search for product data.
///</summary>
[<Api(Description="Represents a service to search for product data.")>]
[<AllowNullLiteral>]
type SearchProducts() =
inherit SearchProductsBase()
///<summary>
///The unique identifier of the account associated with the product.
///</summary>
[<ApiMember(Description="The unique identifier of the account associated with the product.")>]
member val ProductId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The unique identifier of the account associated with the product.
///</summary>
[<ApiMember(Description="The unique identifier of the account associated with the product.")>]
member val AccountId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The name of the product.
///</summary>
[<ApiMember(Description="The name of the product.")>]
member val Name:String = null with get,set
///<summary>
///Search by using the name of the product that starts with the specified value.
///</summary>
[<ApiMember(Description="Search by using the name of the product that starts with the specified value.")>]
member val NameStartsWith:String = null with get,set
///<summary>
///Search by using the name of the product that ends with the specified value.
///</summary>
[<ApiMember(Description="Search by using the name of the product that ends with the specified value.")>]
member val NameEndsWith:String = null with get,set
///<summary>
///Search by using the name of the product that contains the specified value.
///</summary>
[<ApiMember(Description="Search by using the name of the product that contains the specified value.")>]
member val NameContains:String = null with get,set
///<summary>
///The version of the product.
///</summary>
[<ApiMember(Description="The version of the product.")>]
member val Version:String = null with get,set
///<summary>
///Search by using the version of the product that starts with the specified value.
///</summary>
[<ApiMember(Description="Search by using the version of the product that starts with the specified value.")>]
member val VersionStartsWith:String = null with get,set
///<summary>
///Search by using the version of the product that ends with the specified value.
///</summary>
[<ApiMember(Description="Search by using the version of the product that ends with the specified value.")>]
member val VersionEndsWith:String = null with get,set
///<summary>
///Search by using the version of the product that contains the specified value.
///</summary>
[<ApiMember(Description="Search by using the version of the product that contains the specified value.")>]
member val VersionContains:String = null with get,set
///<summary>
///The description of the product.
///</summary>
[<ApiMember(Description="The description of the product.")>]
member val Description:String = null with get,set
///<summary>
///Search by using the description of the product that starts with the specified value.
///</summary>
[<ApiMember(Description="Search by using the description of the product that starts with the specified value.")>]
member val DescriptionStartsWith:String = null with get,set
///<summary>
///Search by using the description of the product that ends with the specified value.
///</summary>
[<ApiMember(Description="Search by using the description of the product that ends with the specified value.")>]
member val DescriptionEndsWith:String = null with get,set
///<summary>
///Search by using the description of the product that contains the specified value.
///</summary>
[<ApiMember(Description="Search by using the description of the product that contains the specified value.")>]
member val DescriptionContains:String = null with get,set
///<summary>
///Should the related orders of the account be included in the retrieved products?
///</summary>
[<ApiMember(Description="Should the related orders of the account be included in the retrieved products?")>]
member val IncludeOrders:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true.
///</summary>
[<ApiMember(Description="Specifies the number of orders to skip per product. Applicable only when 'IncludeOrders' is true. ")>]
member val SkipOrders:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true.
///</summary>
[<ApiMember(Description="Specifies the number of orders to include per product. Applicable only when 'IncludeOrders' is true. ")>]
member val TakeOrders:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to skip.
///</summary>
[<ApiMember(Description="The number of query results to skip.")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///The number of query results to include.
///</summary>
[<ApiMember(Description="The number of query results to include.")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<T>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<T> = new ResizeArray<T>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
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>