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 .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ordersMap":{"0":[{"id":0,"productId":0,"accountId":0,"name":"String","serviceName":"String","requestTimestamp":"\/Date(-62135596800000-0000)\/","responseTimestamp":"\/Date(-62135596800000-0000)\/","requestUri":"String","requestHttpMethod":"String","requestDuration":"PT0S","responseStatusCode":"Continue","clientIPAddress":"String","unitOfMeasurement":"String","processType":"String","dataType":"String","dataName":"String","creationDate":"\/Date(-62135596800000-0000)\/","expiryDate":"\/Date(-62135596800000-0000)\/","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"}}}