Tax Filing Service

<back to all web services

DeleteAccountAsync

DeleteAccountsAsync

Represents a service request to delete a user account in an asynchronous operation.

Requires Authentication
Required role:AdminRequired permissions:CanAccess, CanDelete
The following routes are available for this service:
DELETE/async/accounts/{Id}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports PwC.Metering.Core.Services.Contracts.Requests
Imports PwC.Metering.Core.Services.Contracts.Responses
Imports PwC.Metering.Core.Domain.Concretes.Models

Namespace Global

    Namespace PwC.Metering.Core.Domain.Concretes.Models

        '''<Summary>
        '''Represents a user account.
        '''</Summary>
        <Api(Description:="Represents a user account.")>
        Public Partial Class Account
            Implements IHasUserName
            Public Sub New()
                Roles = New List(Of String)
                Permissions = New List(Of String)
                Meta = New Dictionary(Of String, String)
            End Sub

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        '''<Summary>
        '''Represents a commission to consume services.
        '''</Summary>
        <Api(Description:="Represents a commission to consume services.")>
        Public Partial Class Order
            Implements IHasName
            '''<Summary>
            '''The unique identifier of the order.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the order.", IsRequired:=true)>
            Public Overridable Property Id As Integer

            '''<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 Overridable Property ProductId As Integer

            '''<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 Overridable Property AccountId As Integer

            '''<Summary>
            '''A name to identify the order.
            '''</Summary>
            <ApiMember(Description:="A name to identify the order.", IsRequired:=true)>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property Name As String

            '''<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 Overridable Property ServiceName As String

            '''<Summary>
            '''The time stamp at which the order was initiated.
            '''</Summary>
            <ApiMember(Description:="The time stamp at which the order was initiated.")>
            Public Overridable Property RequestTimestamp As Nullable(Of Date)

            '''<Summary>
            '''The time stamp at which the order was completed.
            '''</Summary>
            <ApiMember(Description:="The time stamp at which the order was completed.")>
            Public Overridable Property ResponseTimestamp As Nullable(Of Date)

            '''<Summary>
            '''The URI from which the order was initiated.
            '''</Summary>
            <ApiMember(Description:="The URI from which the order was initiated.")>
            Public Overridable Property RequestUri As String

            '''<Summary>
            '''The HTTP method of the order request.
            '''</Summary>
            <ApiMember(Description:="The HTTP method of the order request.")>
            Public Overridable Property RequestHttpMethod As String

            '''<Summary>
            '''The duration of the order request.
            '''</Summary>
            <ApiMember(Description:="The duration of the order request.")>
            Public Overridable Property RequestDuration As Nullable(Of TimeSpan)

            '''<Summary>
            '''The HTTP status code of the order request.
            '''</Summary>
            <ApiMember(Description:="The HTTP status code of the order request.")>
            Public Overridable Property ResponseStatusCode As HttpStatusCode

            '''<Summary>
            '''The IP address of client, who placed the order.
            '''</Summary>
            <ApiMember(Description:="The IP address of client, who placed the order.")>
            Public Overridable Property ClientIPAddress As String

            '''<Summary>
            '''The unit of measurement for the order.
            '''</Summary>
            <ApiMember(Description:="The unit of measurement for the order.")>
            Public Overridable Property UnitOfMeasurement As String

            '''<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 Overridable Property ProcessType As String

            '''<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 Overridable Property DataType As String

            '''<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 Overridable Property DataName As String

            '''<Summary>
            '''The date of creation of the order.
            '''</Summary>
            <ApiMember(Description:="The date of creation of the order.")>
            Public Overridable Property CreationDate As Date

            '''<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 Overridable Property ExpiryDate As Nullable(Of Date)

            '''<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 Overridable Property IsTest As Boolean
        End Class

        '''<Summary>
        '''Represents a product.
        '''</Summary>
        <Api(Description:="Represents a product.")>
        Public Partial Class Product
            Implements IHasName
            Public Sub New()
                Tags = New List(Of String)
            End Sub

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

            '''<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 Overridable Property Index As Integer

            '''<Summary>
            '''The name of the product.
            '''</Summary>
            <ApiMember(Description:="The name of the product.", IsRequired:=true)>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The version of the product.
            '''</Summary>
            <ApiMember(Description:="The version of the product.", IsRequired:=true)>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property Version As String

            '''<Summary>
            '''The version of the product.
            '''</Summary>
            <ApiMember(Description:="The version of the product.")>
            Public Overridable Property Description As String

            '''<Summary>
            '''Tags associated with the product.
            '''</Summary>
            <ApiMember(Description:="Tags associated with the product.")>
            Public Overridable Property Tags As List(Of String)
        End Class
    End Namespace

    Namespace PwC.Metering.Core.Services.Contracts.Requests

        '''<Summary>
        '''Represents a service request to delete a user account in an asynchronous operation.
        '''</Summary>
        <Api(Description:="Represents a service request to delete a user account in an asynchronous operation.")>
        Public Partial Class DeleteAccountAsync
            Inherits DeleteAccountBase
            '''<Summary>
            '''The unique identifier of the user account to delete.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the user account to delete.")>
            Public Overridable Property Id As Integer
        End Class

        '''<Summary>
        '''Specifies a base service request to delete a user account.
        '''</Summary>
        <Api(Description:="Specifies a base service request to delete a user account.")>
        Public Partial Class DeleteAccountBase
            Implements IDelete
            '''<Summary>
            '''The unique identifier of the user account to delete.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the user account to delete.")>
            Public Overridable Property Id As Integer
        End Class
    End Namespace

    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
            Inherits ServiceResponseBase
            Public Sub New()
                Products = New List(Of Product)
                Orders = New List(Of Order)
            End Sub

            '''<Summary>
            '''The user account encapsulated in the response.
            '''</Summary>
            <ApiMember(Description:="The user account encapsulated in the response.")>
            Public Overridable Property Account As Account

            '''<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 Overridable Property Index As Long

            '''<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 Overridable Property Products As List(Of Product)

            '''<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 Overridable Property Orders As List(Of Order)

            '''<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 Overridable Property ResponseStatus As ResponseStatus
        End Class

        '''<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 Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET DeleteAccountAsync DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /async/accounts/{Id} HTTP/1.1 
Host: taxfiling.pwc.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
		lockedDate: 0001-01-01,
		createdDate: 0001-01-01,
		modifiedDate: 0001-01-01,
		phoneNumber: String,
		birthDate: 0001-01-01,
		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: 0001-01-01,
			responseTimestamp: 0001-01-01,
			requestUri: String,
			requestHttpMethod: String,
			requestDuration: PT0S,
			responseStatusCode: Continue,
			clientIPAddress: String,
			unitOfMeasurement: String,
			processType: String,
			dataType: String,
			dataName: String,
			creationDate: 0001-01-01,
			expiryDate: 0001-01-01,
			isTest: False
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}