Tax Filing Service

<back to all web services

RetrieveAllProducts

RetrieveProductsSync

Represents a service request to retrieve all products.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/sync/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.
        '''</Summary>
        <Api(Description:="Represents a service request to retrieve all products.")>
        Public Partial Class RetrieveAllProducts
            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 RetrieveAllProducts DTOs

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

HTTP + XML

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.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>
© 2021 - 2024 PwC. All rights reserved.
PwC refers to the PwC network and/or one or more of its member firms, each of which is a separate legal entity. Please see www.pwc.com/structure for further details. Any use of third party IP such as ELSTER is governed by the respective third party terms.