Tax Filing Service

<back to all web services

RetrieveAllCustomers

RetrieveCustomersSync

Represents a service request to retrieve all customers.

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/sync/customers
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 user account.
        '''</Summary>
        <Api(Description:="Represents a user account.")>
        Public Partial Class Account
            Implements IHasUserName
            Public Sub New()
                Roles = New List(Of String)
                Permissions = New List(Of String)
                Meta = New Dictionary(Of String, String)
            End Sub

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

            '''<Summary>
            '''The position of this instance in a collection of 'Account' instances
            '''</Summary>
            <ApiMember(Description:="The position of this instance in a collection of 'Account' instances", IsRequired:=true)>
            Public Overridable Property Index As Integer

            '''<Summary>
            '''The unique identifier of the customer associated with this account.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the customer associated with this account.", IsRequired:=true)>
            Public Overridable Property RefId As Nullable(Of Integer)

            '''<Summary>
            '''The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
            '''</Summary>
            <ApiMember(Description:="The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")>
            Public Overridable Property RefIdStr As String

            '''<Summary>
            '''The unique user name of the user account.
            '''</Summary>
            <ApiMember(Description:="The unique user name of the user account.", IsRequired:=true)>
            Public Overridable Property UserName As String

            '''<Summary>
            '''The electronic mail address of the user account.
            '''</Summary>
            <ApiMember(Description:="The electronic mail address of the user account.")>
            Public Overridable Property Email As String

            '''<Summary>
            '''The friendly name of the user account.
            '''</Summary>
            <ApiMember(Description:="The friendly name of the user account.")>
            Public Overridable Property DisplayName As String

            '''<Summary>
            '''The first name of the owner (natural person) of the user account.
            '''</Summary>
            <ApiMember(Description:="The first name of the owner (natural person) of the user account.")>
            Public Overridable Property FirstName As String

            '''<Summary>
            '''The last name of the owner (natural person) of the user account.
            '''</Summary>
            <ApiMember(Description:="The last name of the owner (natural person) of the user account.")>
            Public Overridable Property LastName As String

            '''<Summary>
            '''The unique identifier of the customer associated with this account.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the customer associated with this account.")>
            Public Overridable Property FullName As String

            '''<Summary>
            '''The gender of the owner (natural person) of the user account.
            '''</Summary>
            <ApiMember(Description:="The gender of the owner (natural person) of the user account.")>
            Public Overridable Property Gender As String

            '''<Summary>
            '''The language of the owner of teh user account.
            '''</Summary>
            <ApiMember(Description:="The language of the owner of teh user account.")>
            Public Overridable Property Language As String

            '''<Summary>
            '''The company, where the user is an employee.
            '''</Summary>
            <ApiMember(Description:="The company, where the user is an employee.")>
            Public Overridable Property Company As String

            '''<Summary>
            '''The profile URL of the user account.
            '''</Summary>
            <ApiMember(Description:="The profile URL of the user account.", IsRequired:=true)>
            Public Overridable Property ProfileUrl As String

            '''<Summary>
            '''The roles assigned to the user account.
            '''</Summary>
            <ApiMember(Description:="The roles assigned to the user account.")>
            Public Overridable Property Roles As List(Of String)

            '''<Summary>
            '''The permissions assigned to the user account.
            '''</Summary>
            <ApiMember(Description:="The permissions assigned to the user account.")>
            Public Overridable Property Permissions As List(Of String)

            '''<Summary>
            '''The primary e-mail address of the user.
            '''</Summary>
            <ApiMember(Description:="The primary e-mail address of the user.")>
            Public Overridable Property PrimaryEmail As String

            '''<Summary>
            '''Random data to enhance the security of the user password.
            '''</Summary>
            <ApiMember(Description:="Random data to enhance the security of the user password.")>
            Public Overridable Property Salt As String

            '''<Summary>
            '''The hash value of the user password that the PBKDF2 algorithm produces.
            '''</Summary>
            <ApiMember(Description:="The hash value of the user password that the PBKDF2 algorithm produces.")>
            Public Overridable Property PasswordHash As String

            '''<Summary>
            '''The hash value of the user password that the DigestHa1 algorithm produces.
            '''</Summary>
            <ApiMember(Description:="The hash value of the user password that the DigestHa1 algorithm produces.")>
            Public Overridable Property DigestHa1Hash As String

            '''<Summary>
            '''The number of times the user account tried to sign in but failed.
            '''</Summary>
            <ApiMember(Description:="The number of times the user account tried to sign in but failed.")>
            Public Overridable Property InvalidLoginAttempts As Integer

            '''<Summary>
            '''The last time the user account attempted a sign in.
            '''</Summary>
            <ApiMember(Description:="The last time the user account attempted a sign in.")>
            Public Overridable Property LastLoginAttempt As Nullable(Of Date)

            '''<Summary>
            '''The date and time when the user acount was denied access.
            '''</Summary>
            <ApiMember(Description:="The date and time when the user acount was denied access.")>
            Public Overridable Property LockedDate As Nullable(Of Date)

            '''<Summary>
            '''The date and time when the user account was created.
            '''</Summary>
            <ApiMember(Description:="The date and time when the user account was created.")>
            Public Overridable Property CreatedDate As Date

            '''<Summary>
            '''The date and time when the user account was last modified.
            '''</Summary>
            <ApiMember(Description:="The date and time when the user account was last modified.")>
            Public Overridable Property ModifiedDate As Date

            '''<Summary>
            '''The telephone number of the owner of the user account.
            '''</Summary>
            <ApiMember(Description:="The telephone number of the owner of the user account.")>
            Public Overridable Property PhoneNumber As String

            '''<Summary>
            '''The birth date of the owner of the user account
            '''</Summary>
            <ApiMember(Description:="The birth date of the owner of the user account")>
            Public Overridable Property BirthDate As Nullable(Of Date)

            '''<Summary>
            '''The string representation of the birth date of the user account.
            '''</Summary>
            <ApiMember(Description:="The string representation of the birth date of the user account.")>
            Public Overridable Property BirthDateRaw As String

            '''<Summary>
            '''The mail address of the user account.
            '''</Summary>
            <ApiMember(Description:="The mail address of the user account.")>
            Public Overridable Property Address As String

            '''<Summary>
            '''Additional information for the specified 'Address' of the user.
            '''</Summary>
            <ApiMember(Description:="Additional information for the specified 'Address' of the user.")>
            Public Overridable Property Address2 As String

            '''<Summary>
            '''The city of the owner of the user account.
            '''</Summary>
            <ApiMember(Description:="The city of the owner of the user account.")>
            Public Overridable Property City As String

            '''<Summary>
            '''The state of the owner of the user account.
            '''</Summary>
            <ApiMember(Description:="The state of the owner of the user account.")>
            Public Overridable Property State As String

            '''<Summary>
            '''The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
            '''</Summary>
            <ApiMember(Description:="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")>
            Public Overridable Property Country As String

            '''<Summary>
            '''The locale of the user account.
            '''</Summary>
            <ApiMember(Description:="The locale of the user account.")>
            Public Overridable Property Culture As String

            '''<Summary>
            '''The mail address of the user account.
            '''</Summary>
            <ApiMember(Description:="The mail address of the user account.")>
            Public Overridable Property MailAddress As String

            '''<Summary>
            '''The nickname of the user of the user account.
            '''</Summary>
            <ApiMember(Description:="The nickname of the user of the user account.")>
            Public Overridable Property Nickname As String

            '''<Summary>
            '''The postal code of the user account.
            '''</Summary>
            <ApiMember(Description:="The postal code of the user account.")>
            Public Overridable Property PostalCode As String

            '''<Summary>
            '''The time zone of the user of the user account.
            '''</Summary>
            <ApiMember(Description:="The time zone of the user of the user account.")>
            Public Overridable Property TimeZone As String

            '''<Summary>
            '''Additional information to attach to the user account.
            '''</Summary>
            <ApiMember(Description:="Additional information to attach to the user account.")>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        '''<Summary>
        '''Represents a customer (business organization or entrepreneur).
        '''</Summary>
        <Api(Description:="Represents a customer (business organization or entrepreneur).")>
        Public Partial Class Customer
            Implements IHasName
            Public Sub New()
                Accounts = New List(Of Account)
            End Sub

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

            '''<Summary>
            '''The position of this instance in a collection of 'Customer' instances
            '''</Summary>
            <ApiMember(Description:="The position of this instance in a collection of 'Customer' instances", IsRequired:=true)>
            Public Overridable Property Index As Integer

            '''<Summary>
            '''Full name or organization name of customer.
            '''</Summary>
            <ApiMember(Description:="Full name or organization name of customer.", IsRequired:=true)>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The country of residence or business of customer.
            '''</Summary>
            <ApiMember(Description:="The country of residence or business of customer.")>
            Public Overridable Property Country As String

            '''<Summary>
            '''The type of customer.
            '''</Summary>
            <ApiMember(Description:="The type of customer.")>
            Public Overridable Property Type As CustomerType

            '''<Summary>
            '''The list of user accounts associated with this customer.
            '''</Summary>
            <ApiMember(Description:="The list of user accounts associated with this customer.")>
            <Ignore>
            Public Overridable Property Accounts As List(Of Account)
        End Class

        Public Enum CustomerType
            Internal
            Network
            External
        End Enum
    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 customers.
        '''</Summary>
        <Api(Description:="Represents a service request to retrieve all customers.")>
        Public Partial Class RetrieveAllCustomers
            Inherits RetrieveAllCustomersBase
            '''<Summary>
            '''Should related accounts be included in the retrieved customers?
            '''</Summary>
            <ApiMember(Description:="Should related accounts be included in the retrieved customers?")>
            Public Overridable Property IncludeAccounts As Nullable(Of Boolean)

            '''<Summary>
            '''Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. 
            '''</Summary>
            <ApiMember(Description:="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")>
            Public Overridable Property SkipAccounts As Nullable(Of Integer)

            '''<Summary>
            '''Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. 
            '''</Summary>
            <ApiMember(Description:="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")>
            Public Overridable Property TakeAccounts 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 search for customers.
        '''</Summary>
        <Api(Description:="Specifies a service to search for customers.")>
        Public Partial Class RetrieveAllCustomersBase
            Inherits PaginationBase
            Implements IGet
            '''<Summary>
            '''Should related accounts be included in the retrieved customers?
            '''</Summary>
            <ApiMember(Description:="Should related accounts be included in the retrieved customers?")>
            Public Overridable Property IncludeAccounts As Nullable(Of Boolean)

            '''<Summary>
            '''Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. 
            '''</Summary>
            <ApiMember(Description:="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")>
            Public Overridable Property SkipAccounts As Nullable(Of Integer)

            '''<Summary>
            '''Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. 
            '''</Summary>
            <ApiMember(Description:="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")>
            Public Overridable Property TakeAccounts 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 customers.
        '''</Summary>
        <Api(Description:="Represents a query response that contains a structured error information and encapsulates customers.")>
        Public Partial Class CustomerQueryResponse
            Inherits QueryResponse(Of Customer)
            Public Sub New()
                Results = New List(Of Customer)
                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 Customer)

            <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 RetrieveAllCustomers 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/customers HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CustomerQueryResponse 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:Customer>
      <d2p1:Accounts>
        <d2p1:Account>
          <d2p1:Address>String</d2p1:Address>
          <d2p1:Address2>String</d2p1:Address2>
          <d2p1:BirthDate>0001-01-01T00:00:00</d2p1:BirthDate>
          <d2p1:BirthDateRaw>String</d2p1:BirthDateRaw>
          <d2p1:City>String</d2p1:City>
          <d2p1:Company>String</d2p1:Company>
          <d2p1:Country>String</d2p1:Country>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:Culture>String</d2p1:Culture>
          <d2p1:DigestHa1Hash>String</d2p1:DigestHa1Hash>
          <d2p1:DisplayName>String</d2p1:DisplayName>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:FirstName>String</d2p1:FirstName>
          <d2p1:FullName>String</d2p1:FullName>
          <d2p1:Gender>String</d2p1:Gender>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Index>0</d2p1:Index>
          <d2p1:InvalidLoginAttempts>0</d2p1:InvalidLoginAttempts>
          <d2p1:Language>String</d2p1:Language>
          <d2p1:LastLoginAttempt>0001-01-01T00:00:00</d2p1:LastLoginAttempt>
          <d2p1:LastName>String</d2p1:LastName>
          <d2p1:LockedDate>0001-01-01T00:00:00</d2p1:LockedDate>
          <d2p1:MailAddress>String</d2p1:MailAddress>
          <d2p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d2p1:Meta>
          <d2p1:ModifiedDate>0001-01-01T00:00:00</d2p1:ModifiedDate>
          <d2p1:Nickname>String</d2p1:Nickname>
          <d2p1:PasswordHash>String</d2p1:PasswordHash>
          <d2p1:Permissions xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d2p1:Permissions>
          <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
          <d2p1:PostalCode>String</d2p1:PostalCode>
          <d2p1:PrimaryEmail>String</d2p1:PrimaryEmail>
          <d2p1:ProfileUrl>String</d2p1:ProfileUrl>
          <d2p1:RefId>0</d2p1:RefId>
          <d2p1:RefIdStr>String</d2p1:RefIdStr>
          <d2p1:Roles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </d2p1:Roles>
          <d2p1:Salt>String</d2p1:Salt>
          <d2p1:State>String</d2p1:State>
          <d2p1:TimeZone>String</d2p1:TimeZone>
          <d2p1:UserName>String</d2p1:UserName>
        </d2p1:Account>
      </d2p1:Accounts>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Index>0</d2p1:Index>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Type>Internal</d2p1:Type>
    </d2p1:Customer>
  </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>
</CustomerQueryResponse>
© 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.