Tax Filing Service
| Required role: | Admin | Required permission: | CanAccess |
| GET | /async/products/search |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Metering.Core.Services.Contracts.Requests;
using PwC.Metering.Core.Services.Contracts.Helpers;
using PwC.Metering.Core.Services.Contracts.Responses;
using PwC.Metering.Core.Domain.Concretes.Models;
namespace PwC.Metering.Core.Domain.Concretes.Models
{
///<summary>
///Represents a product.
///</summary>
[Api(Description="Represents a product.")]
public partial class Product
: IHasName
{
public Product()
{
Tags = new List<string>{};
}
///<summary>
///The unique identifier of the product.
///</summary>
[ApiMember(Description="The unique identifier of the product.", IsRequired=true)]
public virtual int Id { 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)]
public virtual int Index { get; set; }
///<summary>
///The name of the product.
///</summary>
[ApiMember(Description="The name of the product.", IsRequired=true)]
[Validate("NotEmpty")]
public virtual string Name { get; set; }
///<summary>
///The version of the product.
///</summary>
[ApiMember(Description="The version of the product.", IsRequired=true)]
[Validate("NotEmpty")]
public virtual string Version { get; set; }
///<summary>
///The version of the product.
///</summary>
[ApiMember(Description="The version of the product.")]
public virtual string Description { get; set; }
///<summary>
///Tags associated with the product.
///</summary>
[ApiMember(Description="Tags associated with the product.")]
public virtual List<string> Tags { get; set; }
}
}
namespace PwC.Metering.Core.Services.Contracts.Helpers
{
///<summary>
///The number of query results to skip.
///</summary>
[Api(Description="The number of query results to skip.")]
public partial class PaginationBase
: IPaginate
{
///<summary>
///The number of query results to skip.
///</summary>
[ApiMember(Description="The number of query results to skip.")]
public virtual int? Skip { get; set; }
///<summary>
///The number of query results to include.
///</summary>
[ApiMember(Description="The number of query results to include.")]
public virtual int? Take { get; set; }
}
}
namespace PwC.Metering.Core.Services.Contracts.Requests
{
///<summary>
///Represents a service to search for product data in an asynchronous operation.
///</summary>
[Api(Description="Represents a service to search for product data in an asynchronous operation.")]
public partial class SearchProductsAsync
: 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.")]
public virtual int? ProductId { 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.")]
public virtual int? AccountId { get; set; }
///<summary>
///The name of the product.
///</summary>
[ApiMember(Description="The name of the product.")]
public virtual string Name { 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.")]
public virtual string NameStartsWith { 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.")]
public virtual string NameEndsWith { 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.")]
public virtual string NameContains { get; set; }
///<summary>
///The version of the product.
///</summary>
[ApiMember(Description="The version of the product.")]
public virtual string Version { 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.")]
public virtual string VersionStartsWith { 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.")]
public virtual string VersionEndsWith { 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.")]
public virtual string VersionContains { get; set; }
///<summary>
///The description of the product.
///</summary>
[ApiMember(Description="The description of the product.")]
public virtual string Description { 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.")]
public virtual string DescriptionStartsWith { 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.")]
public virtual string DescriptionEndsWith { 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.")]
public virtual string DescriptionContains { 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?")]
public virtual bool? IncludeOrders { 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. ")]
public virtual int? SkipOrders { 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. ")]
public virtual int? TakeOrders { get; set; }
///<summary>
///The number of query results to skip.
///</summary>
[ApiMember(Description="The number of query results to skip.")]
public virtual int? Skip { get; set; }
///<summary>
///The number of query results to include.
///</summary>
[ApiMember(Description="The number of query results to include.")]
public virtual int? Take { get; set; }
}
///<summary>
///Specifies a service to search for products.
///</summary>
[Api(Description="Specifies a service to search for products.")]
public partial class SearchProductsBase
: PaginationBase, 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.")]
public virtual int? ProductId { 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.")]
public virtual int? AccountId { get; set; }
///<summary>
///The name of the product.
///</summary>
[ApiMember(Description="The name of the product.")]
public virtual string Name { 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.")]
public virtual string NameStartsWith { 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.")]
public virtual string NameEndsWith { 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.")]
public virtual string NameContains { get; set; }
///<summary>
///The version of the product.
///</summary>
[ApiMember(Description="The version of the product.")]
public virtual string Version { 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.")]
public virtual string VersionStartsWith { 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.")]
public virtual string VersionEndsWith { 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.")]
public virtual string VersionContains { get; set; }
///<summary>
///The description of the product.
///</summary>
[ApiMember(Description="The description of the product.")]
public virtual string Description { 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.")]
public virtual string DescriptionStartsWith { 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.")]
public virtual string DescriptionEndsWith { 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.")]
public virtual string DescriptionContains { 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?")]
public virtual bool? IncludeOrders { 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. ")]
public virtual int? SkipOrders { 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. ")]
public virtual int? TakeOrders { get; set; }
///<summary>
///The number of query results to skip.
///</summary>
[ApiMember(Description="The number of query results to skip.")]
public virtual int? Skip { get; set; }
///<summary>
///The number of query results to include.
///</summary>
[ApiMember(Description="The number of query results to include.")]
public virtual int? Take { get; set; }
}
}
namespace PwC.Metering.Core.Services.Contracts.Responses
{
///<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.")]
public partial class ProductQueryResponse
: QueryResponse<Product>
{
public ProductQueryResponse()
{
OrdersMap = new Dictionary<int, List<Order>>{};
Results = new List<Product>{};
Meta = new Dictionary<string, string>{};
}
///<summary>
///The dictionary of orders associated with each found product.
///</summary>
[ApiMember(Description="The dictionary of orders associated with each found product.")]
public virtual Dictionary<int, List<Order>> OrdersMap { get; set; }
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<Product> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryResponse<T>
{
public QueryResponse()
{
Results = new List<T>{};
Meta = new Dictionary<string, string>{};
}
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<T> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { 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 /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>