Tax Filing Service

RetrieveAllProducts

RetrieveProductsSync

Represents a service request to retrieve all products.

**Requires Authentication**
Required role:	Admin	Required permission:	CanAccess

The following routes are available for this service:
GET	/sync/products

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 retrieve all products.
    ///</summary>
    [<Api(Description="Specifies a service to retrieve all products.")>]
    [<AllowNullLiteral>]
    type RetrieveAllProductsBase() = 
        inherit PaginationBase()
        interface IGet
        ///<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 request to retrieve all products.
    ///</summary>
    [<Api(Description="Represents a service request to retrieve all products.")>]
    [<AllowNullLiteral>]
    type RetrieveAllProducts() = 
        inherit RetrieveAllProductsBase()
        ///<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

F# RetrieveAllProducts DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack

HTTP + X-MSGPACK

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sync/products HTTP/1.1 
Host: taxfiling.staging.pwc.de 
Accept: application/x-msgpack

HTTP/1.1 200 OK
Content-Type: application/x-msgpack
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"}}}