Tax Filing Service

<back to all web services

RetrieveAllCustomersAsync

RetrieveCustomersAsync

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

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/customers
import Foundation
import ServiceStack

/**
* Represents a service request to retrieve all customers in an asynchronous operation.
*/
// @Api(Description="Represents a service request to retrieve all customers in an asynchronous operation.")
public class RetrieveAllCustomersAsync : RetrieveAllCustomersBase
{
    /**
    * Should related accounts be included in the retrieved customers?
    */
    // @ApiMember(Description="Should related accounts be included in the retrieved customers?")
    public var includeAccounts:Bool?

    /**
    * Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. 
    */
    // @ApiMember(Description="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")
    public var skipAccounts:Int?

    /**
    * Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. 
    */
    // @ApiMember(Description="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")
    public var takeAccounts:Int?

    /**
    * The number of query results to skip.
    */
    // @ApiMember(Description="The number of query results to skip.")
    public var skip:Int?

    /**
    * The number of query results to include.
    */
    // @ApiMember(Description="The number of query results to include.")
    public var take:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case includeAccounts
        case skipAccounts
        case takeAccounts
        case skip
        case take
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        includeAccounts = try container.decodeIfPresent(Bool.self, forKey: .includeAccounts)
        skipAccounts = try container.decodeIfPresent(Int.self, forKey: .skipAccounts)
        takeAccounts = try container.decodeIfPresent(Int.self, forKey: .takeAccounts)
        skip = try container.decodeIfPresent(Int.self, forKey: .skip)
        take = try container.decodeIfPresent(Int.self, forKey: .take)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if includeAccounts != nil { try container.encode(includeAccounts, forKey: .includeAccounts) }
        if skipAccounts != nil { try container.encode(skipAccounts, forKey: .skipAccounts) }
        if takeAccounts != nil { try container.encode(takeAccounts, forKey: .takeAccounts) }
        if skip != nil { try container.encode(skip, forKey: .skip) }
        if take != nil { try container.encode(take, forKey: .take) }
    }
}

/**
* Specifies a service to search for customers.
*/
// @Api(Description="Specifies a service to search for customers.")
public class RetrieveAllCustomersBase : PaginationBase, IGet
{
    /**
    * Should related accounts be included in the retrieved customers?
    */
    // @ApiMember(Description="Should related accounts be included in the retrieved customers?")
    public var includeAccounts:Bool?

    /**
    * Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. 
    */
    // @ApiMember(Description="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")
    public var skipAccounts:Int?

    /**
    * Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. 
    */
    // @ApiMember(Description="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")
    public var takeAccounts:Int?

    /**
    * The number of query results to skip.
    */
    // @ApiMember(Description="The number of query results to skip.")
    public var skip:Int?

    /**
    * The number of query results to include.
    */
    // @ApiMember(Description="The number of query results to include.")
    public var take:Int?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case includeAccounts
        case skipAccounts
        case takeAccounts
        case skip
        case take
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        includeAccounts = try container.decodeIfPresent(Bool.self, forKey: .includeAccounts)
        skipAccounts = try container.decodeIfPresent(Int.self, forKey: .skipAccounts)
        takeAccounts = try container.decodeIfPresent(Int.self, forKey: .takeAccounts)
        skip = try container.decodeIfPresent(Int.self, forKey: .skip)
        take = try container.decodeIfPresent(Int.self, forKey: .take)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if includeAccounts != nil { try container.encode(includeAccounts, forKey: .includeAccounts) }
        if skipAccounts != nil { try container.encode(skipAccounts, forKey: .skipAccounts) }
        if takeAccounts != nil { try container.encode(takeAccounts, forKey: .takeAccounts) }
        if skip != nil { try container.encode(skip, forKey: .skip) }
        if take != nil { try container.encode(take, forKey: .take) }
    }
}

/**
* The number of query results to skip.
*/
// @Api(Description="The number of query results to skip.")
public class PaginationBase : IPaginate, Codable
{
    /**
    * The number of query results to skip.
    */
    // @ApiMember(Description="The number of query results to skip.")
    public var skip:Int?

    /**
    * The number of query results to include.
    */
    // @ApiMember(Description="The number of query results to include.")
    public var take:Int?

    required public init(){}
}

/**
* Represents a query response that contains a structured error information and encapsulates customers.
*/
// @Api(Description="Represents a query response that contains a structured error information and encapsulates customers.")
public class CustomerQueryResponse : QueryResponse<Customer>
{
    // @DataMember(Order=1)
    public var offset:Int

    // @DataMember(Order=2)
    public var total:Int

    // @DataMember(Order=3)
    public var results:[Customer] = []

    // @DataMember(Order=4)
    public var meta:[String:String] = [:]

    // @DataMember(Order=5)
    public var responseStatus:ResponseStatus

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case offset
        case total
        case results
        case meta
        case responseStatus
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        offset = try container.decodeIfPresent(Int.self, forKey: .offset)
        total = try container.decodeIfPresent(Int.self, forKey: .total)
        results = try container.decodeIfPresent([Customer].self, forKey: .results) ?? []
        meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
        responseStatus = try container.decodeIfPresent(ResponseStatus.self, forKey: .responseStatus)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if offset != nil { try container.encode(offset, forKey: .offset) }
        if total != nil { try container.encode(total, forKey: .total) }
        if results.count > 0 { try container.encode(results, forKey: .results) }
        if meta.count > 0 { try container.encode(meta, forKey: .meta) }
        if responseStatus != nil { try container.encode(responseStatus, forKey: .responseStatus) }
    }
}

/**
* Represents a customer (business organization or entrepreneur).
*/
// @Api(Description="Represents a customer (business organization or entrepreneur).")
public class Customer : IHasName, Codable
{
    /**
    * The unique identifier of the customer.
    */
    // @ApiMember(Description="The unique identifier of the customer.", IsRequired=true)
    public var id:Int

    /**
    * The position of this instance in a collection of 'Customer' instances
    */
    // @ApiMember(Description="The position of this instance in a collection of 'Customer' instances", IsRequired=true)
    public var index:Int

    /**
    * Full name or organization name of customer.
    */
    // @ApiMember(Description="Full name or organization name of customer.", IsRequired=true)
    // @Validate(Validator="NotEmpty")
    public var name:String

    /**
    * The country of residence or business of customer.
    */
    // @ApiMember(Description="The country of residence or business of customer.")
    public var country:String

    /**
    * The type of customer.
    */
    // @ApiMember(Description="The type of customer.")
    public var type:CustomerType

    /**
    * The list of user accounts associated with this customer.
    */
    // @ApiMember(Description="The list of user accounts associated with this customer.")
    // @Ignore()
    public var accounts:[Account] = []

    required public init(){}
}

public enum CustomerType : String, Codable
{
    case Internal
    case Network
    case External
}

/**
* Represents a user account.
*/
// @Api(Description="Represents a user account.")
public class Account : IHasUserName, Codable
{
    /**
    * The unique identifier of the user account.
    */
    // @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
    public var id:Int

    /**
    * The position of this instance in a collection of 'Account' instances
    */
    // @ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
    public var index:Int

    /**
    * The unique identifier of the customer associated with this account.
    */
    // @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
    public var refId:Int?

    /**
    * The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
    */
    // @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 var refIdStr:String

    /**
    * The unique user name of the user account.
    */
    // @ApiMember(Description="The unique user name of the user account.", IsRequired=true)
    public var userName:String

    /**
    * The electronic mail address of the user account.
    */
    // @ApiMember(Description="The electronic mail address of the user account.")
    public var email:String

    /**
    * The friendly name of the user account.
    */
    // @ApiMember(Description="The friendly name of the user account.")
    public var displayName:String

    /**
    * The first name of the owner (natural person) of the user account.
    */
    // @ApiMember(Description="The first name of the owner (natural person) of the user account.")
    public var firstName:String

    /**
    * The last name of the owner (natural person) of the user account.
    */
    // @ApiMember(Description="The last name of the owner (natural person) of the user account.")
    public var lastName:String

    /**
    * The unique identifier of the customer associated with this account.
    */
    // @ApiMember(Description="The unique identifier of the customer associated with this account.")
    public var fullName:String

    /**
    * The gender of the owner (natural person) of the user account.
    */
    // @ApiMember(Description="The gender of the owner (natural person) of the user account.")
    public var gender:String

    /**
    * The language of the owner of teh user account.
    */
    // @ApiMember(Description="The language of the owner of teh user account.")
    public var language:String

    /**
    * The company, where the user is an employee.
    */
    // @ApiMember(Description="The company, where the user is an employee.")
    public var company:String

    /**
    * The profile URL of the user account.
    */
    // @ApiMember(Description="The profile URL of the user account.", IsRequired=true)
    public var profileUrl:String

    /**
    * The roles assigned to the user account.
    */
    // @ApiMember(Description="The roles assigned to the user account.")
    public var roles:[String] = []

    /**
    * The permissions assigned to the user account.
    */
    // @ApiMember(Description="The permissions assigned to the user account.")
    public var permissions:[String] = []

    /**
    * The primary e-mail address of the user.
    */
    // @ApiMember(Description="The primary e-mail address of the user.")
    public var primaryEmail:String

    /**
    * Random data to enhance the security of the user password.
    */
    // @ApiMember(Description="Random data to enhance the security of the user password.")
    public var salt:String

    /**
    * The hash value of the user password that the PBKDF2 algorithm produces.
    */
    // @ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
    public var passwordHash:String

    /**
    * The hash value of the user password that the DigestHa1 algorithm produces.
    */
    // @ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
    public var digestHa1Hash:String

    /**
    * The number of times the user account tried to sign in but failed.
    */
    // @ApiMember(Description="The number of times the user account tried to sign in but failed.")
    public var invalidLoginAttempts:Int

    /**
    * The last time the user account attempted a sign in.
    */
    // @ApiMember(Description="The last time the user account attempted a sign in.")
    public var lastLoginAttempt:Date?

    /**
    * The date and time when the user acount was denied access.
    */
    // @ApiMember(Description="The date and time when the user acount was denied access.")
    public var lockedDate:Date?

    /**
    * The date and time when the user account was created.
    */
    // @ApiMember(Description="The date and time when the user account was created.")
    public var createdDate:Date

    /**
    * The date and time when the user account was last modified.
    */
    // @ApiMember(Description="The date and time when the user account was last modified.")
    public var modifiedDate:Date

    /**
    * The telephone number of the owner of the user account.
    */
    // @ApiMember(Description="The telephone number of the owner of the user account.")
    public var phoneNumber:String

    /**
    * The birth date of the owner of the user account
    */
    // @ApiMember(Description="The birth date of the owner of the user account")
    public var birthDate:Date?

    /**
    * The string representation of the birth date of the user account.
    */
    // @ApiMember(Description="The string representation of the birth date of the user account.")
    public var birthDateRaw:String

    /**
    * The mail address of the user account.
    */
    // @ApiMember(Description="The mail address of the user account.")
    public var address:String

    /**
    * Additional information for the specified 'Address' of the user.
    */
    // @ApiMember(Description="Additional information for the specified 'Address' of the user.")
    public var address2:String

    /**
    * The city of the owner of the user account.
    */
    // @ApiMember(Description="The city of the owner of the user account.")
    public var city:String

    /**
    * The state of the owner of the user account.
    */
    // @ApiMember(Description="The state of the owner of the user account.")
    public var state:String

    /**
    * The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
    */
    // @ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
    public var country:String

    /**
    * The locale of the user account.
    */
    // @ApiMember(Description="The locale of the user account.")
    public var culture:String

    /**
    * The mail address of the user account.
    */
    // @ApiMember(Description="The mail address of the user account.")
    public var mailAddress:String

    /**
    * The nickname of the user of the user account.
    */
    // @ApiMember(Description="The nickname of the user of the user account.")
    public var nickname:String

    /**
    * The postal code of the user account.
    */
    // @ApiMember(Description="The postal code of the user account.")
    public var postalCode:String

    /**
    * The time zone of the user of the user account.
    */
    // @ApiMember(Description="The time zone of the user of the user account.")
    public var timeZone:String

    /**
    * Additional information to attach to the user account.
    */
    // @ApiMember(Description="Additional information to attach to the user account.")
    public var meta:[String:String] = [:]

    required public init(){}
}

Swift RetrieveAllCustomersAsync 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 /async/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.