Tax Filing Service

<back to all web services

RetrieveAllAccountsAsync

RetrieveAccountsAsync

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

Requires Authentication
Required role:AdminRequired permission:CanAccess
The following routes are available for this service:
GET/async/accounts

/** @description The number of query results to skip. */
// @Api(Description="The number of query results to skip.")
export class PaginationBase implements IPaginate
{
    /** @description The number of query results to skip. */
    // @ApiMember(Description="The number of query results to skip.")
    public skip?: number;

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

    public constructor(init?: Partial<PaginationBase>) { (Object as any).assign(this, init); }
}

/** @description Specifies a service to retrieve all accounts. */
// @Api(Description="Specifies a service to retrieve all accounts.")
export class RetrieveAllAccountsBase extends PaginationBase implements IGet
{
    /** @description Should the related products of the accounts be included in the retrieved results? */
    // @ApiMember(Description="Should the related products of the accounts be included in the retrieved results?")
    public includeProducts?: boolean;

    /** @description Should the related orders of the accounts be included in the retrieved results? */
    // @ApiMember(Description="Should the related orders of the accounts be included in the retrieved results?")
    public includeOrders?: boolean;

    /** @description Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true.  */
    // @ApiMember(Description="Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. ")
    public skipProducts?: number;

    /** @description Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true.  */
    // @ApiMember(Description="Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. ")
    public takeProducts?: number;

    /** @description Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. ")
    public skipOrders?: number;

    /** @description Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. ")
    public takeOrders?: number;

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

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

    public constructor(init?: Partial<RetrieveAllAccountsBase>) { super(init); (Object as any).assign(this, init); }
}

/** @description Represents a user account. */
// @Api(Description="Represents a user account.")
export class Account implements IHasUserName
{
    /** @description The unique identifier of the user account. */
    // @ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
    public id: number;

    /** @description 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 index: number;

    /** @description 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 refId: number;

    /** @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'. */
    // @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 refIdStr?: string;

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

    /** @description The electronic mail address of the user account. */
    // @ApiMember(Description="The electronic mail address of the user account.")
    public email?: string;

    /** @description The friendly name of the user account. */
    // @ApiMember(Description="The friendly name of the user account.")
    public displayName?: string;

    /** @description 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 firstName?: string;

    /** @description 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 lastName?: string;

    /** @description The unique identifier of the customer associated with this account. */
    // @ApiMember(Description="The unique identifier of the customer associated with this account.")
    public fullName?: string;

    /** @description 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 gender?: string;

    /** @description The language of the owner of teh user account. */
    // @ApiMember(Description="The language of the owner of teh user account.")
    public language?: string;

    /** @description The company, where the user is an employee. */
    // @ApiMember(Description="The company, where the user is an employee.")
    public company?: string;

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

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

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

    /** @description The primary e-mail address of the user. */
    // @ApiMember(Description="The primary e-mail address of the user.")
    public primaryEmail?: string;

    /** @description Random data to enhance the security of the user password. */
    // @ApiMember(Description="Random data to enhance the security of the user password.")
    public salt?: string;

    /** @description 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 passwordHash?: string;

    /** @description 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 digestHa1Hash?: string;

    /** @description 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 invalidLoginAttempts: number;

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

    /** @description 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 lockedDate?: string;

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

    /** @description 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 modifiedDate: string;

    /** @description The telephone number of the owner of the user account. */
    // @ApiMember(Description="The telephone number of the owner of the user account.")
    public phoneNumber?: string;

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

    /** @description 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 birthDateRaw?: string;

    /** @description The mail address of the user account. */
    // @ApiMember(Description="The mail address of the user account.")
    public address?: string;

    /** @description Additional information for the specified 'Address' of the user. */
    // @ApiMember(Description="Additional information for the specified 'Address' of the user.")
    public address2?: string;

    /** @description The city of the owner of the user account. */
    // @ApiMember(Description="The city of the owner of the user account.")
    public city?: string;

    /** @description The state of the owner of the user account. */
    // @ApiMember(Description="The state of the owner of the user account.")
    public state?: string;

    /** @description 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 country?: string;

    /** @description The locale of the user account. */
    // @ApiMember(Description="The locale of the user account.")
    public culture?: string;

    /** @description The mail address of the user account. */
    // @ApiMember(Description="The mail address of the user account.")
    public mailAddress?: string;

    /** @description The nickname of the user of the user account. */
    // @ApiMember(Description="The nickname of the user of the user account.")
    public nickname?: string;

    /** @description The postal code of the user account. */
    // @ApiMember(Description="The postal code of the user account.")
    public postalCode?: string;

    /** @description The time zone of the user of the user account. */
    // @ApiMember(Description="The time zone of the user of the user account.")
    public timeZone?: string;

    /** @description Additional information to attach to the user account. */
    // @ApiMember(Description="Additional information to attach to the user account.")
    public meta?: { [index: string]: string; };

    public constructor(init?: Partial<Account>) { (Object as any).assign(this, init); }
}

/** @description Represents a query response that contains a structured error information and encapsulates user accounts. */
// @Api(Description="Represents a query response that contains a structured error information and encapsulates user accounts.")
export class AccountQueryResponse extends QueryResponse<Account>
{
    /** @description The dictionary of products associated to found user accounts. */
    // @ApiMember(Description="The dictionary of products associated to found user accounts.")
    public productsMap: { [index: number]: Product[]; };

    /** @description The dictionary of orders associated with each found user account. */
    // @ApiMember(Description="The dictionary of orders associated with each found user account.")
    public ordersMap: { [index: number]: Order[]; };

    // @DataMember(Order=1)
    public offset: number;

    // @DataMember(Order=2)
    public total: number;

    // @DataMember(Order=3)
    public results: Account[];

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

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

    public constructor(init?: Partial<AccountQueryResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description Represents a service request to retrieve all accounts in an asynchronous operation. */
// @Api(Description="Represents a service request to retrieve all accounts in an asynchronous operation.")
export class RetrieveAllAccountsAsync extends RetrieveAllAccountsBase
{
    /** @description Should the related products of the accounts be included in the retrieved results? */
    // @ApiMember(Description="Should the related products of the accounts be included in the retrieved results?")
    public includeProducts?: boolean;

    /** @description Should the related orders of the accounts be included in the retrieved results? */
    // @ApiMember(Description="Should the related orders of the accounts be included in the retrieved results?")
    public includeOrders?: boolean;

    /** @description Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true.  */
    // @ApiMember(Description="Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. ")
    public skipProducts?: number;

    /** @description Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true.  */
    // @ApiMember(Description="Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. ")
    public takeProducts?: number;

    /** @description Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. ")
    public skipOrders?: number;

    /** @description Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true.  */
    // @ApiMember(Description="Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. ")
    public takeOrders?: number;

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

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

    public constructor(init?: Partial<RetrieveAllAccountsAsync>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public offset: number;

    // @DataMember(Order=2)
    public total: number;

    // @DataMember(Order=3)
    public results: T[];

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

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

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript RetrieveAllAccountsAsync 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/accounts HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AccountQueryResponse 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: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1: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>
  </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>
  <ProductsMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintArrayOfProductKY2vvLcG>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models">
        <d4p1:Product>
          <d4p1:Description>String</d4p1:Description>
          <d4p1:Id>0</d4p1:Id>
          <d4p1:Index>0</d4p1:Index>
          <d4p1:Name>String</d4p1:Name>
          <d4p1:Tags>
            <d2p1:string>String</d2p1:string>
          </d4p1:Tags>
          <d4p1:Version>String</d4p1:Version>
        </d4p1:Product>
      </d2p1:Value>
    </d2p1:KeyValueOfintArrayOfProductKY2vvLcG>
  </ProductsMap>
</AccountQueryResponse>