<back to all web services

RetrieveAccountAsync

Represents a service request to retrieve an account 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; }
    }

    ///<summary>
    ///Represents a commission to consume services.
    ///</summary>
    [Api(Description="Represents a commission to consume services.")]
    public partial class Order
        : IHasName
    {
        ///<summary>
        ///The unique identifier of the order.
        ///</summary>
        [ApiMember(Description="The unique identifier of the order.", IsRequired=true)]
        public virtual int Id { get; set; }

        ///<summary>
        ///The unique identifier of the product, for which the order is made.
        ///</summary>
        [ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)]
        public virtual int ProductId { get; set; }

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

        ///<summary>
        ///A name to identify the order.
        ///</summary>
        [ApiMember(Description="A name to identify the order.", IsRequired=true)]
        [Validate("NotEmpty")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The name of the service, for which the order was made.
        ///</summary>
        [ApiMember(Description="The name of the service, for which the order was made.")]
        public virtual string ServiceName { get; set; }

        ///<summary>
        ///The time stamp at which the order was initiated.
        ///</summary>
        [ApiMember(Description="The time stamp at which the order was initiated.")]
        public virtual DateTime? RequestTimestamp { get; set; }

        ///<summary>
        ///The time stamp at which the order was completed.
        ///</summary>
        [ApiMember(Description="The time stamp at which the order was completed.")]
        public virtual DateTime? ResponseTimestamp { get; set; }

        ///<summary>
        ///The URI from which the order was initiated.
        ///</summary>
        [ApiMember(Description="The URI from which the order was initiated.")]
        public virtual string RequestUri { get; set; }

        ///<summary>
        ///The HTTP method of the order request.
        ///</summary>
        [ApiMember(Description="The HTTP method of the order request.")]
        public virtual string RequestHttpMethod { get; set; }

        ///<summary>
        ///The duration of the order request.
        ///</summary>
        [ApiMember(Description="The duration of the order request.")]
        public virtual TimeSpan? RequestDuration { get; set; }

        ///<summary>
        ///The HTTP status code of the order request.
        ///</summary>
        [ApiMember(Description="The HTTP status code of the order request.")]
        public virtual HttpStatusCode ResponseStatusCode { get; set; }

        ///<summary>
        ///The IP address of client, who placed the order.
        ///</summary>
        [ApiMember(Description="The IP address of client, who placed the order.")]
        public virtual string ClientIPAddress { get; set; }

        ///<summary>
        ///The unit of measurement for the order.
        ///</summary>
        [ApiMember(Description="The unit of measurement for the order.")]
        public virtual string UnitOfMeasurement { get; set; }

        ///<summary>
        ///The type of process, for which the order is charged.
        ///</summary>
        [ApiMember(Description="The type of process, for which the order is charged.")]
        public virtual string ProcessType { get; set; }

        ///<summary>
        ///The type of data, for which the order is charged.
        ///</summary>
        [ApiMember(Description="The type of data, for which the order is charged.")]
        public virtual string DataType { get; set; }

        ///<summary>
        ///The name of the data, for which the order is charged.
        ///</summary>
        [ApiMember(Description="The name of the data, for which the order is charged.")]
        public virtual string DataName { get; set; }

        ///<summary>
        ///The date of creation of the order.
        ///</summary>
        [ApiMember(Description="The date of creation of the order.")]
        public virtual DateTime CreationDate { get; set; }

        ///<summary>
        ///The final date to retain the order in the records. After this date, the order is expunged from the records.
        ///</summary>
        [ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")]
        public virtual DateTime? ExpiryDate { get; set; }

        ///<summary>
        ///Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.
        ///</summary>
        [ApiMember(Description="Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.")]
        public virtual bool IsTest { get; set; }
    }

    ///<summary>
    ///Represents a product.
    ///</summary>
    [Api(Description="Represents a product.")]
    public partial class Product
        : IHasName
    {
        public Product()
        {
            Tags = new List<string>{};
        }

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

        ///<summary>
        ///The position of this instance in a collection of 'Product' instances
        ///</summary>
        [ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)]
        public virtual int Index { get; set; }

        ///<summary>
        ///The name of the product.
        ///</summary>
        [ApiMember(Description="The name of the product.", IsRequired=true)]
        [Validate("NotEmpty")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The version of the product.
        ///</summary>
        [ApiMember(Description="The version of the product.", IsRequired=true)]
        [Validate("NotEmpty")]
        public virtual string Version { get; set; }

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

        ///<summary>
        ///Tags associated with the product.
        ///</summary>
        [ApiMember(Description="Tags associated with the product.")]
        public virtual List<string> Tags { 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 request to retrieve an account in an asynchronous operation.
    ///</summary>
    [Api(Description="Represents a service request to retrieve an account in an asynchronous operation.")]
    public partial class RetrieveAccountAsync
        : RetrieveAccountBase
    {
        ///<summary>
        ///The user name of the account.
        ///</summary>
        [ApiMember(Description="The user name of the account.")]
        public virtual string UserName { get; set; }

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

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

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

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

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

        ///<summary>
        ///Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of orders to include. 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 request to retrieve an account.
    ///</summary>
    [Api(Description="Specifies a service request to retrieve an account.")]
    public partial class RetrieveAccountBase
        : PaginationBase, IGet
    {
        ///<summary>
        ///The user name of the account.
        ///</summary>
        [ApiMember(Description="The user name of the account.")]
        public virtual string UserName { get; set; }

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

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

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

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

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

        ///<summary>
        ///Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. 
        ///</summary>
        [ApiMember(Description="Specifies the number of orders to include. 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 service response that contains a structured error information and encapsulates a user account.
    ///</summary>
    [Api(Description="Represents a service response that contains a structured error information and encapsulates a user account.")]
    public partial class AccountResponse
        : ServiceResponseBase
    {
        public AccountResponse()
        {
            Products = new List<Product>{};
            Orders = new List<Order>{};
        }

        ///<summary>
        ///The user account encapsulated in the response.
        ///</summary>
        [ApiMember(Description="The user account encapsulated in the response.")]
        public virtual Account Account { get; set; }

        ///<summary>
        ///The index position of the reponse in a collection, if it were returned together with other responses.
        ///</summary>
        [ApiMember(Description="The index position of the reponse in a collection, if it were returned together with other responses.")]
        public virtual long Index { get; set; }

        ///<summary>
        ///The list of products associated with the encapsulated user account.
        ///</summary>
        [ApiMember(Description="The list of products associated with the encapsulated user account.")]
        public virtual List<Product> Products { get; set; }

        ///<summary>
        ///The list of orders associated with the encapsulated user account.
        ///</summary>
        [ApiMember(Description="The list of orders associated with the encapsulated user account.")]
        public virtual List<Order> Orders { get; set; }

        ///<summary>
        ///Data structure that holds error information from a service operation.
        ///</summary>
        [ApiMember(Description="Data structure that holds error information from a service operation.")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    ///<summary>
    ///Specifies a base service response class that contains a structured error information.
    ///</summary>
    [Api(Description="Specifies a base service response class that contains a structured error information.")]
    public partial class ServiceResponseBase
    {
        ///<summary>
        ///Data structure that holds error information from a service operation.
        ///</summary>
        [ApiMember(Description="Data structure that holds error information from a service operation.")]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# RetrieveAccountAsync DTOs

GET /async/accounts/retrieve HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: application/x-msgpack

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

{"account":{"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"}},"index":0,"products":[{"id":0,"index":0,"name":"String","version":"String","description":"String","tags":["String"]}],"orders":[{"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}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}