Tax Filing Service

<back to all web services

RetrieveAllProductsAsync

RetrieveProductsAsync

Represents a service request to retrieve all products in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/products
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.Metering.Core.Services.Contracts.Requests
Imports PwC.Metering.Core.Services.Contracts.Helpers
Imports PwC.Metering.Core.Services.Contracts.Responses
Imports PwC.Metering.Core.Domain.Concretes.Models

Namespace Global

    Namespace PwC.Metering.Core.Domain.Concretes.Models

        '''<Summary>
        '''Represents a product.
        '''</Summary>
        <Api(Description:="Represents a product.")>
        Public Partial Class Product
            Implements IHasName
            Public Sub New()
                Tags = New List(Of String)
            End Sub

            '''<Summary>
            '''The unique identifier of the product.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the product.", IsRequired:=true)>
            Public Overridable Property Id As Integer

            '''<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 Overridable Property Index As Integer

            '''<Summary>
            '''The name of the product.
            '''</Summary>
            <ApiMember(Description:="The name of the product.", IsRequired:=true)>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The version of the product.
            '''</Summary>
            <ApiMember(Description:="The version of the product.", IsRequired:=true)>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property Version As String

            '''<Summary>
            '''The version of the product.
            '''</Summary>
            <ApiMember(Description:="The version of the product.")>
            Public Overridable Property Description As String

            '''<Summary>
            '''Tags associated with the product.
            '''</Summary>
            <ApiMember(Description:="Tags associated with the product.")>
            Public Overridable Property Tags As List(Of String)
        End Class
    End Namespace

    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
            Implements IPaginate
            '''<Summary>
            '''The number of query results to skip.
            '''</Summary>
            <ApiMember(Description:="The number of query results to skip.")>
            Public Overridable Property Skip As Nullable(Of Integer)

            '''<Summary>
            '''The number of query results to include.
            '''</Summary>
            <ApiMember(Description:="The number of query results to include.")>
            Public Overridable Property Take As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace PwC.Metering.Core.Services.Contracts.Requests

        '''<Summary>
        '''Represents a service request to retrieve all products in an asynchronous operation.
        '''</Summary>
        <Api(Description:="Represents a service request to retrieve all products in an asynchronous operation.")>
        Public Partial Class RetrieveAllProductsAsync
            Inherits 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?")>
            Public Overridable Property IncludeOrders As Nullable(Of Boolean)

            '''<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 Overridable Property SkipOrders As Nullable(Of Integer)

            '''<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 Overridable Property TakeOrders As Nullable(Of Integer)

            '''<Summary>
            '''The number of query results to skip.
            '''</Summary>
            <ApiMember(Description:="The number of query results to skip.")>
            Public Overridable Property Skip As Nullable(Of Integer)

            '''<Summary>
            '''The number of query results to include.
            '''</Summary>
            <ApiMember(Description:="The number of query results to include.")>
            Public Overridable Property Take As Nullable(Of Integer)
        End Class

        '''<Summary>
        '''Specifies a service to retrieve all products.
        '''</Summary>
        <Api(Description:="Specifies a service to retrieve all products.")>
        Public Partial Class RetrieveAllProductsBase
            Inherits PaginationBase
            Implements 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?")>
            Public Overridable Property IncludeOrders As Nullable(Of Boolean)

            '''<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 Overridable Property SkipOrders As Nullable(Of Integer)

            '''<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 Overridable Property TakeOrders As Nullable(Of Integer)

            '''<Summary>
            '''The number of query results to skip.
            '''</Summary>
            <ApiMember(Description:="The number of query results to skip.")>
            Public Overridable Property Skip As Nullable(Of Integer)

            '''<Summary>
            '''The number of query results to include.
            '''</Summary>
            <ApiMember(Description:="The number of query results to include.")>
            Public Overridable Property Take As Nullable(Of Integer)
        End Class
    End Namespace

    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
            Inherits QueryResponse(Of Product)
            Public Sub New()
                OrdersMap = New Dictionary(Of Integer, List(Of Order))
                Results = New List(Of Product)
                Meta = New Dictionary(Of String, String)
            End Sub

            '''<Summary>
            '''The dictionary of orders associated with each found product.
            '''</Summary>
            <ApiMember(Description:="The dictionary of orders associated with each found product.")>
            Public Overridable Property OrdersMap As Dictionary(Of Integer, List(Of Order))

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of Product)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            Public Sub New()
                Results = New List(Of T)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of T)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET RetrieveAllProductsAsync DTOs

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

HTTP + CSV

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

GET /async/products HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}