Required role: | Admin | Required permissions: | CanAccess, CanDelete |
DELETE | /sync/accounts/{Id} |
---|
namespace PwC.Metering.Core.Domain.Concretes.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
///<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.")>]
[<AllowNullLiteral>]
type 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.")>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Represents a user account.
///</summary>
[<Api(Description="Represents a user account.")>]
[<AllowNullLiteral>]
type Account() =
///<summary>
///The unique identifier of the user account.
///</summary>
[<ApiMember(Description="The unique identifier of the user account.", IsRequired=true)>]
member val Id:Int32 = new Int32() with 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)>]
member val Index:Int32 = new Int32() with 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)>]
member val RefId:Nullable<Int32> = new Nullable<Int32>() with 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'.")>]
member val RefIdStr:String = null with get,set
///<summary>
///The unique user name of the user account.
///</summary>
[<ApiMember(Description="The unique user name of the user account.", IsRequired=true)>]
member val UserName:String = null with get,set
///<summary>
///The electronic mail address of the user account.
///</summary>
[<ApiMember(Description="The electronic mail address of the user account.")>]
member val Email:String = null with get,set
///<summary>
///The friendly name of the user account.
///</summary>
[<ApiMember(Description="The friendly name of the user account.")>]
member val DisplayName:String = null with 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.")>]
member val FirstName:String = null with 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.")>]
member val LastName:String = null with 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.")>]
member val FullName:String = null with 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.")>]
member val Gender:String = null with get,set
///<summary>
///The language of the owner of teh user account.
///</summary>
[<ApiMember(Description="The language of the owner of teh user account.")>]
member val Language:String = null with get,set
///<summary>
///The company, where the user is an employee.
///</summary>
[<ApiMember(Description="The company, where the user is an employee.")>]
member val Company:String = null with get,set
///<summary>
///The profile URL of the user account.
///</summary>
[<ApiMember(Description="The profile URL of the user account.", IsRequired=true)>]
member val ProfileUrl:String = null with get,set
///<summary>
///The roles assigned to the user account.
///</summary>
[<ApiMember(Description="The roles assigned to the user account.")>]
member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///The permissions assigned to the user account.
///</summary>
[<ApiMember(Description="The permissions assigned to the user account.")>]
member val Permissions:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///The primary e-mail address of the user.
///</summary>
[<ApiMember(Description="The primary e-mail address of the user.")>]
member val PrimaryEmail:String = null with 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.")>]
member val Salt:String = null with 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.")>]
member val PasswordHash:String = null with 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.")>]
member val DigestHa1Hash:String = null with 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.")>]
member val InvalidLoginAttempts:Int32 = new Int32() with 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.")>]
member val LastLoginAttempt:Nullable<DateTime> = new Nullable<DateTime>() with 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.")>]
member val LockedDate:Nullable<DateTime> = new Nullable<DateTime>() with 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.")>]
member val CreatedDate:DateTime = new DateTime() with 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.")>]
member val ModifiedDate:DateTime = new DateTime() with 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.")>]
member val PhoneNumber:String = null with 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")>]
member val BirthDate:Nullable<DateTime> = new Nullable<DateTime>() with 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.")>]
member val BirthDateRaw:String = null with get,set
///<summary>
///The mail address of the user account.
///</summary>
[<ApiMember(Description="The mail address of the user account.")>]
member val Address:String = null with get,set
///<summary>
///Additional information for the specified 'Address' of the user.
///</summary>
[<ApiMember(Description="Additional information for the specified 'Address' of the user.")>]
member val Address2:String = null with get,set
///<summary>
///The city of the owner of the user account.
///</summary>
[<ApiMember(Description="The city of the owner of the user account.")>]
member val City:String = null with get,set
///<summary>
///The state of the owner of the user account.
///</summary>
[<ApiMember(Description="The state of the owner of the user account.")>]
member val State:String = null with 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'.")>]
member val Country:String = null with get,set
///<summary>
///The locale of the user account.
///</summary>
[<ApiMember(Description="The locale of the user account.")>]
member val Culture:String = null with get,set
///<summary>
///The mail address of the user account.
///</summary>
[<ApiMember(Description="The mail address of the user account.")>]
member val MailAddress:String = null with get,set
///<summary>
///The nickname of the user of the user account.
///</summary>
[<ApiMember(Description="The nickname of the user of the user account.")>]
member val Nickname:String = null with get,set
///<summary>
///The postal code of the user account.
///</summary>
[<ApiMember(Description="The postal code of the user account.")>]
member val PostalCode:String = null with 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.")>]
member val TimeZone:String = null with get,set
///<summary>
///Additional information to attach to the user account.
///</summary>
[<ApiMember(Description="Additional information to attach to the user account.")>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
///<summary>
///Represents a product.
///</summary>
[<Api(Description="Represents a product.")>]
[<AllowNullLiteral>]
type Product() =
///<summary>
///The unique identifier of the product.
///</summary>
[<ApiMember(Description="The unique identifier of the product.", IsRequired=true)>]
member val Id:Int32 = new Int32() with 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)>]
member val Index:Int32 = new Int32() with get,set
///<summary>
///The name of the product.
///</summary>
[<ApiMember(Description="The name of the product.", IsRequired=true)>]
[<Validate(Validator="NotEmpty")>]
member val Name:String = null with get,set
///<summary>
///The version of the product.
///</summary>
[<ApiMember(Description="The version of the product.", IsRequired=true)>]
[<Validate(Validator="NotEmpty")>]
member val Version:String = null with get,set
///<summary>
///The version of the product.
///</summary>
[<ApiMember(Description="The version of the product.")>]
member val Description:String = null with get,set
///<summary>
///Tags associated with the product.
///</summary>
[<ApiMember(Description="Tags associated with the product.")>]
member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
///<summary>
///Represents a commission to consume services.
///</summary>
[<Api(Description="Represents a commission to consume services.")>]
[<AllowNullLiteral>]
type Order() =
///<summary>
///The unique identifier of the order.
///</summary>
[<ApiMember(Description="The unique identifier of the order.", IsRequired=true)>]
member val Id:Int32 = new Int32() with 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)>]
member val ProductId:Int32 = new Int32() with 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)>]
member val AccountId:Int32 = new Int32() with get,set
///<summary>
///A name to identify the order.
///</summary>
[<ApiMember(Description="A name to identify the order.", IsRequired=true)>]
[<Validate(Validator="NotEmpty")>]
member val Name:String = null with 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.")>]
member val ServiceName:String = null with get,set
///<summary>
///The time stamp at which the order was initiated.
///</summary>
[<ApiMember(Description="The time stamp at which the order was initiated.")>]
member val RequestTimestamp:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///The time stamp at which the order was completed.
///</summary>
[<ApiMember(Description="The time stamp at which the order was completed.")>]
member val ResponseTimestamp:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///The URI from which the order was initiated.
///</summary>
[<ApiMember(Description="The URI from which the order was initiated.")>]
member val RequestUri:String = null with get,set
///<summary>
///The HTTP method of the order request.
///</summary>
[<ApiMember(Description="The HTTP method of the order request.")>]
member val RequestHttpMethod:String = null with get,set
///<summary>
///The duration of the order request.
///</summary>
[<ApiMember(Description="The duration of the order request.")>]
member val RequestDuration:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
///<summary>
///The HTTP status code of the order request.
///</summary>
[<ApiMember(Description="The HTTP status code of the order request.")>]
member val ResponseStatusCode:HttpStatusCode = new HttpStatusCode() with get,set
///<summary>
///The IP address of client, who placed the order.
///</summary>
[<ApiMember(Description="The IP address of client, who placed the order.")>]
member val ClientIPAddress:String = null with get,set
///<summary>
///The unit of measurement for the order.
///</summary>
[<ApiMember(Description="The unit of measurement for the order.")>]
member val UnitOfMeasurement:String = null with 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.")>]
member val ProcessType:String = null with 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.")>]
member val DataType:String = null with 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.")>]
member val DataName:String = null with get,set
///<summary>
///The date of creation of the order.
///</summary>
[<ApiMember(Description="The date of creation of the order.")>]
member val CreationDate:DateTime = new DateTime() with 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.")>]
member val ExpiryDate:Nullable<DateTime> = new Nullable<DateTime>() with 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.")>]
member val IsTest:Boolean = new Boolean() with get,set
///<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.")>]
[<AllowNullLiteral>]
type AccountResponse() =
inherit ServiceResponseBase()
///<summary>
///The user account encapsulated in the response.
///</summary>
[<ApiMember(Description="The user account encapsulated in the response.")>]
member val Account:Account = null with 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.")>]
member val Index:Int64 = new Int64() with 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.")>]
member val Products:ResizeArray<Product> = new ResizeArray<Product>() with 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.")>]
member val Orders:ResizeArray<Order> = new ResizeArray<Order>() with 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.")>]
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Specifies a base service request to delete a user account.
///</summary>
[<Api(Description="Specifies a base service request to delete a user account.")>]
[<AllowNullLiteral>]
type DeleteAccountBase() =
interface IDelete
///<summary>
///The unique identifier of the user account to delete.
///</summary>
[<ApiMember(Description="The unique identifier of the user account to delete.")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///Represents a service request to delete a user account.
///</summary>
[<Api(Description="Represents a service request to delete a user account.")>]
[<AllowNullLiteral>]
type DeleteAccount() =
inherit DeleteAccountBase()
///<summary>
///The unique identifier of the user account to delete.
///</summary>
[<ApiMember(Description="The unique identifier of the user account to delete.")>]
member val Id:Int32 = new Int32() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /sync/accounts/{Id} HTTP/1.1 Host: taxfiling.pwc.de Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Services.Contracts.Responses"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1: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> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1: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> </d2p1:Meta> </ResponseStatus> <Account xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models"> <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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1: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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1: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:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>String</d3p1:string> </d2p1:Roles> <d2p1:Salt>String</d2p1:Salt> <d2p1:State>String</d2p1:State> <d2p1:TimeZone>String</d2p1:TimeZone> <d2p1:UserName>String</d2p1:UserName> </Account> <Index>0</Index> <Orders xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models"> <d2p1:Order> <d2p1:AccountId>0</d2p1:AccountId> <d2p1:ClientIPAddress>String</d2p1:ClientIPAddress> <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate> <d2p1:DataName>String</d2p1:DataName> <d2p1:DataType>String</d2p1:DataType> <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate> <d2p1:Id>0</d2p1:Id> <d2p1:IsTest>false</d2p1:IsTest> <d2p1:Name>String</d2p1:Name> <d2p1:ProcessType>String</d2p1:ProcessType> <d2p1:ProductId>0</d2p1:ProductId> <d2p1:RequestDuration>PT0S</d2p1:RequestDuration> <d2p1:RequestHttpMethod>String</d2p1:RequestHttpMethod> <d2p1:RequestTimestamp>0001-01-01T00:00:00</d2p1:RequestTimestamp> <d2p1:RequestUri>String</d2p1:RequestUri> <d2p1:ResponseStatusCode>Continue</d2p1:ResponseStatusCode> <d2p1:ResponseTimestamp>0001-01-01T00:00:00</d2p1:ResponseTimestamp> <d2p1:ServiceName>String</d2p1:ServiceName> <d2p1:UnitOfMeasurement>String</d2p1:UnitOfMeasurement> </d2p1:Order> </Orders> <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/PwC.Metering.Core.Domain.Concretes.Models"> <d2p1:Product> <d2p1:Description>String</d2p1:Description> <d2p1:Id>0</d2p1:Id> <d2p1:Index>0</d2p1:Index> <d2p1:Name>String</d2p1:Name> <d2p1:Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>String</d4p1:string> </d2p1:Tags> <d2p1:Version>String</d2p1:Version> </d2p1:Product> </Products> </AccountResponse>