<back to all web services

SearchAccountsAsync

Represents a service to search for accounts in an asynchronous operation.

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using PwC.Metering.Core.Services.Contracts.Requests;
using PwC.Metering.Core.Services.Contracts.Helpers;
using PwC.Metering.Core.Services.Contracts.Responses;
using PwC.Metering.Core.Domain.Concretes.Models;

namespace PwC.Metering.Core.Domain.Concretes.Models
{
    ///<summary>
    ///Represents a user account.
    ///</summary>
    [Api(Description="Represents a user account.")]
    public partial class Account
        : IHasUserName
    {
        public Account()
        {
            Roles = new List<string>{};
            Permissions = new List<string>{};
            Meta = new Dictionary<string, string>{};
        }

        ///<summary>
        ///The unique identifier of the user account.
        ///</summary>
        [ApiMember(Description="The unique identifier of the user account.", IsRequired=true)]
        public virtual int Id { get; set; }

        ///<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 virtual int Index { get; set; }

        ///<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 virtual int? RefId { get; set; }

        ///<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 virtual string RefIdStr { get; set; }

        ///<summary>
        ///The unique user name of the user account.
        ///</summary>
        [ApiMember(Description="The unique user name of the user account.", IsRequired=true)]
        public virtual string UserName { get; set; }

        ///<summary>
        ///The electronic mail address of the user account.
        ///</summary>
        [ApiMember(Description="The electronic mail address of the user account.")]
        public virtual string Email { get; set; }

        ///<summary>
        ///The friendly name of the user account.
        ///</summary>
        [ApiMember(Description="The friendly name of the user account.")]
        public virtual string DisplayName { get; set; }

        ///<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 virtual string FirstName { get; set; }

        ///<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 virtual string LastName { get; set; }

        ///<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 virtual string FullName { get; set; }

        ///<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 virtual string Gender { get; set; }

        ///<summary>
        ///The language of the owner of teh user account.
        ///</summary>
        [ApiMember(Description="The language of the owner of teh user account.")]
        public virtual string Language { get; set; }

        ///<summary>
        ///The company, where the user is an employee.
        ///</summary>
        [ApiMember(Description="The company, where the user is an employee.")]
        public virtual string Company { get; set; }

        ///<summary>
        ///The profile URL of the user account.
        ///</summary>
        [ApiMember(Description="The profile URL of the user account.", IsRequired=true)]
        public virtual string ProfileUrl { get; set; }

        ///<summary>
        ///The roles assigned to the user account.
        ///</summary>
        [ApiMember(Description="The roles assigned to the user account.")]
        public virtual List<string> Roles { get; set; }

        ///<summary>
        ///The permissions assigned to the user account.
        ///</summary>
        [ApiMember(Description="The permissions assigned to the user account.")]
        public virtual List<string> Permissions { get; set; }

        ///<summary>
        ///The primary e-mail address of the user.
        ///</summary>
        [ApiMember(Description="The primary e-mail address of the user.")]
        public virtual string PrimaryEmail { get; set; }

        ///<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 virtual string Salt { get; set; }

        ///<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 virtual string PasswordHash { get; set; }

        ///<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 virtual string DigestHa1Hash { get; set; }

        ///<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 virtual int InvalidLoginAttempts { get; set; }

        ///<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 virtual DateTime? LastLoginAttempt { get; set; }

        ///<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 virtual DateTime? LockedDate { get; set; }

        ///<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 virtual DateTime CreatedDate { get; set; }

        ///<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 virtual DateTime ModifiedDate { get; set; }

        ///<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 virtual string PhoneNumber { get; set; }

        ///<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 virtual DateTime? BirthDate { get; set; }

        ///<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 virtual string BirthDateRaw { get; set; }

        ///<summary>
        ///The mail address of the user account.
        ///</summary>
        [ApiMember(Description="The mail address of the user account.")]
        public virtual string Address { get; set; }

        ///<summary>
        ///Additional information for the specified 'Address' of the user.
        ///</summary>
        [ApiMember(Description="Additional information for the specified 'Address' of the user.")]
        public virtual string Address2 { get; set; }

        ///<summary>
        ///The city of the owner of the user account.
        ///</summary>
        [ApiMember(Description="The city of the owner of the user account.")]
        public virtual string City { get; set; }

        ///<summary>
        ///The state of the owner of the user account.
        ///</summary>
        [ApiMember(Description="The state of the owner of the user account.")]
        public virtual string State { get; set; }

        ///<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 virtual string Country { get; set; }

        ///<summary>
        ///The locale of the user account.
        ///</summary>
        [ApiMember(Description="The locale of the user account.")]
        public virtual string Culture { get; set; }

        ///<summary>
        ///The mail address of the user account.
        ///</summary>
        [ApiMember(Description="The mail address of the user account.")]
        public virtual string MailAddress { get; set; }

        ///<summary>
        ///The nickname of the user of the user account.
        ///</summary>
        [ApiMember(Description="The nickname of the user of the user account.")]
        public virtual string Nickname { get; set; }

        ///<summary>
        ///The postal code of the user account.
        ///</summary>
        [ApiMember(Description="The postal code of the user account.")]
        public virtual string PostalCode { get; set; }

        ///<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 virtual string TimeZone { get; set; }

        ///<summary>
        ///Additional information to attach to the user account.
        ///</summary>
        [ApiMember(Description="Additional information to attach to the user account.")]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

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
        : IPaginate
    {
        ///<summary>
        ///The number of query results to skip.
        ///</summary>
        [ApiMember(Description="The number of query results to skip.")]
        public virtual int? Skip { get; set; }

        ///<summary>
        ///The number of query results to include.
        ///</summary>
        [ApiMember(Description="The number of query results to include.")]
        public virtual int? Take { get; set; }
    }

}

namespace PwC.Metering.Core.Services.Contracts.Requests
{
    ///<summary>
    ///Represents a service to search for accounts in an asynchronous operation.
    ///</summary>
    [Api(Description="Represents a service to search for accounts in an asynchronous operation.")]
    public partial class SearchAccountsAsync
        : SearchAccountsBase
    {
        ///<summary>
        ///The unique identifier of the user account.
        ///</summary>
        [ApiMember(Description="The unique identifier of the user account.")]
        public virtual int? AccountId { get; set; }

        ///<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 virtual int? CustomerId { get; set; }

        ///<summary>
        ///The user name of the user account.
        ///</summary>
        [ApiMember(Description="The user name of the user account.")]
        public virtual string UserName { get; set; }

        ///<summary>
        ///Search by using the user name that starts with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the user name that starts with the specified value.")]
        public virtual string UserNameStartsWith { get; set; }

        ///<summary>
        ///Search by using the user name that ends with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the user name that ends with the specified value.")]
        public virtual string UserNameEndsWith { get; set; }

        ///<summary>
        ///Search by using the user name that contains the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the user name that contains the specified value.")]
        public virtual string UserNameContains { get; set; }

        ///<summary>
        ///The display name of the user account.
        ///</summary>
        [ApiMember(Description="The display name of the user account.")]
        public virtual string DisplayName { get; set; }

        ///<summary>
        ///The e-mail address of the user account.
        ///</summary>
        [ApiMember(Description="The e-mail address of the user account.")]
        public virtual string Email { get; set; }

        ///<summary>
        ///Search by using the e-mail address of the user account that starts with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the e-mail address of the user account that starts with the specified value.")]
        public virtual string EmailStartsWith { get; set; }

        ///<summary>
        ///Search by using the e-mail address of the user account that ends with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the e-mail address of the user account that ends with the specified value.")]
        public virtual string EmailEndsWith { get; set; }

        ///<summary>
        ///Search by using the e-mail address of the user account that contains the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the e-mail address of the user account that contains the specified value.")]
        public virtual string EmailContains { get; set; }

        ///<summary>
        ///Search by using the display name that starts with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the display name that starts with the specified value.")]
        public virtual string DisplayNameStartsWith { get; set; }

        ///<summary>
        ///Search by using the display name that ends with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the display name that ends with the specified value.")]
        public virtual string DisplayNameEndsWith { get; set; }

        ///<summary>
        ///Search by using the display name that contains the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the display name that contains the specified value.")]
        public virtual string DisplayNameContains { get; set; }

        ///<summary>
        ///Search with the profile URL of the user account.
        ///</summary>
        [ApiMember(Description="Search with the profile URL of the user account.")]
        public virtual string ProfileUrl { get; set; }

        ///<summary>
        ///Should the related products of the account be included in the retrieved accounts?
        ///</summary>
        [ApiMember(Description="Should the related products of the account be included in the retrieved accounts?")]
        public virtual bool IncludeProducts { get; set; }

        ///<summary>
        ///Should the related orders of the account be included in the retrieved accounts?
        ///</summary>
        [ApiMember(Description="Should the related orders of the account be included in the retrieved accounts?")]
        public virtual bool IncludeOrders { get; set; }

        ///<summary>
        ///Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. ")]
        public virtual int? SkipProducts { get; set; }

        ///<summary>
        ///Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. ")]
        public virtual int? TakeProducts { get; set; }

        ///<summary>
        ///Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. ")]
        public virtual int? SkipOrders { get; set; }

        ///<summary>
        ///Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. ")]
        public virtual int? TakeOrders { get; set; }

        ///<summary>
        ///The number of query results to skip.
        ///</summary>
        [ApiMember(Description="The number of query results to skip.")]
        public virtual int? Skip { get; set; }

        ///<summary>
        ///The number of query results to include.
        ///</summary>
        [ApiMember(Description="The number of query results to include.")]
        public virtual int? Take { get; set; }
    }

    ///<summary>
    ///Specifies a service to search for accounts.
    ///</summary>
    [Api(Description="Specifies a service to search for accounts.")]
    public partial class SearchAccountsBase
        : PaginationBase, IGet
    {
        ///<summary>
        ///The unique identifier of the user account.
        ///</summary>
        [ApiMember(Description="The unique identifier of the user account.")]
        public virtual int? AccountId { get; set; }

        ///<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 virtual int? CustomerId { get; set; }

        ///<summary>
        ///The user name of the user account.
        ///</summary>
        [ApiMember(Description="The user name of the user account.")]
        public virtual string UserName { get; set; }

        ///<summary>
        ///Search by using the user name that starts with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the user name that starts with the specified value.")]
        public virtual string UserNameStartsWith { get; set; }

        ///<summary>
        ///Search by using the user name that ends with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the user name that ends with the specified value.")]
        public virtual string UserNameEndsWith { get; set; }

        ///<summary>
        ///Search by using the user name that contains the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the user name that contains the specified value.")]
        public virtual string UserNameContains { get; set; }

        ///<summary>
        ///The display name of the user account.
        ///</summary>
        [ApiMember(Description="The display name of the user account.")]
        public virtual string DisplayName { get; set; }

        ///<summary>
        ///The e-mail address of the user account.
        ///</summary>
        [ApiMember(Description="The e-mail address of the user account.")]
        public virtual string Email { get; set; }

        ///<summary>
        ///Search by using the e-mail address of the user account that starts with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the e-mail address of the user account that starts with the specified value.")]
        public virtual string EmailStartsWith { get; set; }

        ///<summary>
        ///Search by using the e-mail address of the user account that ends with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the e-mail address of the user account that ends with the specified value.")]
        public virtual string EmailEndsWith { get; set; }

        ///<summary>
        ///Search by using the e-mail address of the user account that contains the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the e-mail address of the user account that contains the specified value.")]
        public virtual string EmailContains { get; set; }

        ///<summary>
        ///Search by using the display name that starts with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the display name that starts with the specified value.")]
        public virtual string DisplayNameStartsWith { get; set; }

        ///<summary>
        ///Search by using the display name that ends with the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the display name that ends with the specified value.")]
        public virtual string DisplayNameEndsWith { get; set; }

        ///<summary>
        ///Search by using the display name that contains the specified value.
        ///</summary>
        [ApiMember(Description="Search by using the display name that contains the specified value.")]
        public virtual string DisplayNameContains { get; set; }

        ///<summary>
        ///Search with the profile URL of the user account.
        ///</summary>
        [ApiMember(Description="Search with the profile URL of the user account.")]
        public virtual string ProfileUrl { get; set; }

        ///<summary>
        ///Should the related products of the account be included in the retrieved accounts?
        ///</summary>
        [ApiMember(Description="Should the related products of the account be included in the retrieved accounts?")]
        public virtual bool IncludeProducts { get; set; }

        ///<summary>
        ///Should the related orders of the account be included in the retrieved accounts?
        ///</summary>
        [ApiMember(Description="Should the related orders of the account be included in the retrieved accounts?")]
        public virtual bool IncludeOrders { get; set; }

        ///<summary>
        ///Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of products to skip per account. Applicable only when 'IncludeProducts' is true. ")]
        public virtual int? SkipProducts { get; set; }

        ///<summary>
        ///Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of products to include per account. Applicable only when 'IncludeProducts' is true. ")]
        public virtual int? TakeProducts { get; set; }

        ///<summary>
        ///Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of orders to skip per account. Applicable only when 'IncludeOrders' is true. ")]
        public virtual int? SkipOrders { get; set; }

        ///<summary>
        ///Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of orders to include per account. Applicable only when 'IncludeOrders' is true. ")]
        public virtual int? TakeOrders { get; set; }

        ///<summary>
        ///The number of query results to skip.
        ///</summary>
        [ApiMember(Description="The number of query results to skip.")]
        public virtual int? Skip { get; set; }

        ///<summary>
        ///The number of query results to include.
        ///</summary>
        [ApiMember(Description="The number of query results to include.")]
        public virtual int? Take { get; set; }
    }

}

namespace PwC.Metering.Core.Services.Contracts.Responses
{
    ///<summary>
    ///Represents a query response that contains a structured error information and encapsulates user accounts.
    ///</summary>
    [Api(Description="Represents a query response that contains a structured error information and encapsulates user accounts.")]
    public partial class AccountQueryResponse
        : QueryResponse<Account>
    {
        public AccountQueryResponse()
        {
            ProductsMap = new Dictionary<int, List<Product>>{};
            OrdersMap = new Dictionary<int, List<Order>>{};
            Results = new List<Account>{};
            Meta = new Dictionary<string, string>{};
        }

        ///<summary>
        ///The dictionary of products associated to found user accounts.
        ///</summary>
        [ApiMember(Description="The dictionary of products associated to found user accounts.")]
        public virtual Dictionary<int, List<Product>> ProductsMap { get; set; }

        ///<summary>
        ///The dictionary of orders associated with each found user account.
        ///</summary>
        [ApiMember(Description="The dictionary of orders associated with each found user account.")]
        public virtual Dictionary<int, List<Order>> OrdersMap { get; set; }

        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<Account> Results { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryResponse<T>
    {
        public QueryResponse()
        {
            Results = new List<T>{};
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<T> Results { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# SearchAccountsAsync DTOs

GET /async/accounts/search HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/json

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

{"productsMap":{"0":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}]},"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,"refId":0,"refIdStr":"String","userName":"String","email":"String","displayName":"String","firstName":"String","lastName":"String","fullName":"String","gender":"String","language":"String","company":"String","profileUrl":"String","roles":["String"],"permissions":["String"],"primaryEmail":"String","salt":"String","passwordHash":"String","digestHa1Hash":"String","invalidLoginAttempts":0,"lastLoginAttempt":"\/Date(-62135596800000-0000)\/","lockedDate":"\/Date(-62135596800000-0000)\/","createdDate":"\/Date(-62135596800000-0000)\/","modifiedDate":"\/Date(-62135596800000-0000)\/","phoneNumber":"String","birthDate":"\/Date(-62135596800000-0000)\/","birthDateRaw":"String","address":"String","address2":"String","city":"String","state":"String","country":"String","culture":"String","mailAddress":"String","nickname":"String","postalCode":"String","timeZone":"String","meta":{"String":"String"}}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}