Tax Filing Service
| Requires any of the roles: | AllowAnyUser, Admin | Required permissions: | CanAccess, CanEdit |
| PUT | /async/accounts/update |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Represents a service request to update account data in an asynchronous operation.
*/
@Api(Description="Represents a service request to update account data in an asynchronous operation.")
open class UpdateAccountAsync : UpdateAccountBase()
{
}
/**
* Specifies a service request to update account data.
*/
@Api(Description="Specifies a service request to update account data.")
open class UpdateAccountBase : IPut
{
/**
* The user name of the user account.
*/
@ApiMember(Description="The user name of the user account.")
open var userName:String? = null
/**
* The friendly name of the user account.
*/
@ApiMember(Description="The friendly name of the user account.")
open var displayName:String? = null
/**
* The e-mail address of the user account.
*/
@ApiMember(Description="The e-mail address of the user account.")
@Validate(Validator="Email")
open var email:String? = null
/**
* The profile URL of the user account.
*/
@ApiMember(Description="The profile URL of the user account.")
open var profileUrl:String? = null
/**
* Extra information for the user account.
*/
@ApiMember(Description="Extra information for the user account.")
open var meta:HashMap<String,String> = HashMap<String,String>()
}
/**
* Represents a service response that contains a structured error information and encapsulates a user account.
*/
@Api(Description="Represents a service response that contains a structured error information and encapsulates a user account.")
open class AccountResponse : ServiceResponseBase()
{
/**
* The user account encapsulated in the response.
*/
@ApiMember(Description="The user account encapsulated in the response.")
open var account:Account? = null
/**
* The index position of the reponse in a collection, if it were returned together with other responses.
*/
@ApiMember(Description="The index position of the reponse in a collection, if it were returned together with other responses.")
open var index:Long? = null
/**
* The list of products associated with the encapsulated user account.
*/
@ApiMember(Description="The list of products associated with the encapsulated user account.")
open var products:ArrayList<Product> = ArrayList<Product>()
/**
* The list of orders associated with the encapsulated user account.
*/
@ApiMember(Description="The list of orders associated with the encapsulated user account.")
open var orders:ArrayList<Order> = ArrayList<Order>()
}
/**
* Specifies a base service response class that contains a structured error information.
*/
@Api(Description="Specifies a base service response class that contains a structured error information.")
open class ServiceResponseBase
{
/**
* Data structure that holds error information from a service operation.
*/
@ApiMember(Description="Data structure that holds error information from a service operation.")
open var responseStatus:ResponseStatus? = null
}
/**
* Represents a user account.
*/
@Api(Description="Represents a user account.")
open class Account : IHasUserName
{
/**
* The unique identifier of the user account.
*/
@ApiMember(Description="The unique identifier of the user account.", IsRequired=true)
open var id:Int? = null
/**
* The position of this instance in a collection of 'Account' instances
*/
@ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true)
open var index:Int? = null
/**
* The unique identifier of the customer associated with this account.
*/
@ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true)
open var refId:Int? = null
/**
* The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
*/
@ApiMember(Description="The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.")
open var refIdStr:String? = null
/**
* The unique user name of the user account.
*/
@ApiMember(Description="The unique user name of the user account.", IsRequired=true)
override var userName:String? = null
/**
* The electronic mail address of the user account.
*/
@ApiMember(Description="The electronic mail address of the user account.")
open var email:String? = null
/**
* The friendly name of the user account.
*/
@ApiMember(Description="The friendly name of the user account.")
open var displayName:String? = null
/**
* The first name of the owner (natural person) of the user account.
*/
@ApiMember(Description="The first name of the owner (natural person) of the user account.")
open var firstName:String? = null
/**
* The last name of the owner (natural person) of the user account.
*/
@ApiMember(Description="The last name of the owner (natural person) of the user account.")
open var lastName:String? = null
/**
* The unique identifier of the customer associated with this account.
*/
@ApiMember(Description="The unique identifier of the customer associated with this account.")
open var fullName:String? = null
/**
* The gender of the owner (natural person) of the user account.
*/
@ApiMember(Description="The gender of the owner (natural person) of the user account.")
open var gender:String? = null
/**
* The language of the owner of teh user account.
*/
@ApiMember(Description="The language of the owner of teh user account.")
open var language:String? = null
/**
* The company, where the user is an employee.
*/
@ApiMember(Description="The company, where the user is an employee.")
open var company:String? = null
/**
* The profile URL of the user account.
*/
@ApiMember(Description="The profile URL of the user account.", IsRequired=true)
open var profileUrl:String? = null
/**
* The roles assigned to the user account.
*/
@ApiMember(Description="The roles assigned to the user account.")
open var roles:ArrayList<String> = ArrayList<String>()
/**
* The permissions assigned to the user account.
*/
@ApiMember(Description="The permissions assigned to the user account.")
open var permissions:ArrayList<String> = ArrayList<String>()
/**
* The primary e-mail address of the user.
*/
@ApiMember(Description="The primary e-mail address of the user.")
open var primaryEmail:String? = null
/**
* Random data to enhance the security of the user password.
*/
@ApiMember(Description="Random data to enhance the security of the user password.")
open var salt:String? = null
/**
* The hash value of the user password that the PBKDF2 algorithm produces.
*/
@ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.")
open var passwordHash:String? = null
/**
* The hash value of the user password that the DigestHa1 algorithm produces.
*/
@ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.")
open var digestHa1Hash:String? = null
/**
* The number of times the user account tried to sign in but failed.
*/
@ApiMember(Description="The number of times the user account tried to sign in but failed.")
open var invalidLoginAttempts:Int? = null
/**
* The last time the user account attempted a sign in.
*/
@ApiMember(Description="The last time the user account attempted a sign in.")
open var lastLoginAttempt:Date? = null
/**
* The date and time when the user acount was denied access.
*/
@ApiMember(Description="The date and time when the user acount was denied access.")
open var lockedDate:Date? = null
/**
* The date and time when the user account was created.
*/
@ApiMember(Description="The date and time when the user account was created.")
open var createdDate:Date? = null
/**
* The date and time when the user account was last modified.
*/
@ApiMember(Description="The date and time when the user account was last modified.")
open var modifiedDate:Date? = null
/**
* The telephone number of the owner of the user account.
*/
@ApiMember(Description="The telephone number of the owner of the user account.")
open var phoneNumber:String? = null
/**
* The birth date of the owner of the user account
*/
@ApiMember(Description="The birth date of the owner of the user account")
open var birthDate:Date? = null
/**
* The string representation of the birth date of the user account.
*/
@ApiMember(Description="The string representation of the birth date of the user account.")
open var birthDateRaw:String? = null
/**
* The mail address of the user account.
*/
@ApiMember(Description="The mail address of the user account.")
open var address:String? = null
/**
* Additional information for the specified 'Address' of the user.
*/
@ApiMember(Description="Additional information for the specified 'Address' of the user.")
open var address2:String? = null
/**
* The city of the owner of the user account.
*/
@ApiMember(Description="The city of the owner of the user account.")
open var city:String? = null
/**
* The state of the owner of the user account.
*/
@ApiMember(Description="The state of the owner of the user account.")
open var state:String? = null
/**
* The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
*/
@ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")
open var country:String? = null
/**
* The locale of the user account.
*/
@ApiMember(Description="The locale of the user account.")
open var culture:String? = null
/**
* The mail address of the user account.
*/
@ApiMember(Description="The mail address of the user account.")
open var mailAddress:String? = null
/**
* The nickname of the user of the user account.
*/
@ApiMember(Description="The nickname of the user of the user account.")
open var nickname:String? = null
/**
* The postal code of the user account.
*/
@ApiMember(Description="The postal code of the user account.")
open var postalCode:String? = null
/**
* The time zone of the user of the user account.
*/
@ApiMember(Description="The time zone of the user of the user account.")
open var timeZone:String? = null
/**
* Additional information to attach to the user account.
*/
@ApiMember(Description="Additional information to attach to the user account.")
open var meta:HashMap<String,String>? = null
}
/**
* Represents a product.
*/
@Api(Description="Represents a product.")
open class Product : IHasName
{
/**
* The unique identifier of the product.
*/
@ApiMember(Description="The unique identifier of the product.", IsRequired=true)
open var id:Int? = null
/**
* The position of this instance in a collection of 'Product' instances
*/
@ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true)
open var index:Int? = null
/**
* The name of the product.
*/
@ApiMember(Description="The name of the product.", IsRequired=true)
@Validate(Validator="NotEmpty")
override var name:String? = null
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.", IsRequired=true)
@Validate(Validator="NotEmpty")
open var version:String? = null
/**
* The version of the product.
*/
@ApiMember(Description="The version of the product.")
open var description:String? = null
/**
* Tags associated with the product.
*/
@ApiMember(Description="Tags associated with the product.")
open var tags:ArrayList<String> = ArrayList<String>()
}
/**
* Represents a commission to consume services.
*/
@Api(Description="Represents a commission to consume services.")
open class Order : IHasName
{
/**
* The unique identifier of the order.
*/
@ApiMember(Description="The unique identifier of the order.", IsRequired=true)
open var id:Int? = null
/**
* The unique identifier of the product, for which the order is made.
*/
@ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)
open var productId:Int? = null
/**
* The unique identifier of the user account, who placed the order.
*/
@ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)
open var accountId:Int? = null
/**
* A name to identify the order.
*/
@ApiMember(Description="A name to identify the order.", IsRequired=true)
@Validate(Validator="NotEmpty")
override var name:String? = null
/**
* The name of the service, for which the order was made.
*/
@ApiMember(Description="The name of the service, for which the order was made.")
open var serviceName:String? = null
/**
* The time stamp at which the order was initiated.
*/
@ApiMember(Description="The time stamp at which the order was initiated.")
open var requestTimestamp:Date? = null
/**
* The time stamp at which the order was completed.
*/
@ApiMember(Description="The time stamp at which the order was completed.")
open var responseTimestamp:Date? = null
/**
* The URI from which the order was initiated.
*/
@ApiMember(Description="The URI from which the order was initiated.")
open var requestUri:String? = null
/**
* The HTTP method of the order request.
*/
@ApiMember(Description="The HTTP method of the order request.")
open var requestHttpMethod:String? = null
/**
* The duration of the order request.
*/
@ApiMember(Description="The duration of the order request.")
open var requestDuration:TimeSpan? = null
/**
* The HTTP status code of the order request.
*/
@ApiMember(Description="The HTTP status code of the order request.")
open var responseStatusCode:HttpStatusCode? = null
/**
* The IP address of client, who placed the order.
*/
@ApiMember(Description="The IP address of client, who placed the order.")
open var clientIPAddress:String? = null
/**
* The unit of measurement for the order.
*/
@ApiMember(Description="The unit of measurement for the order.")
open var unitOfMeasurement:String? = null
/**
* The type of process, for which the order is charged.
*/
@ApiMember(Description="The type of process, for which the order is charged.")
open var processType:String? = null
/**
* The type of data, for which the order is charged.
*/
@ApiMember(Description="The type of data, for which the order is charged.")
open var dataType:String? = null
/**
* The name of the data, for which the order is charged.
*/
@ApiMember(Description="The name of the data, for which the order is charged.")
open var dataName:String? = null
/**
* The date of creation of the order.
*/
@ApiMember(Description="The date of creation of the order.")
open var creationDate:Date? = null
/**
* The final date to retain the order in the records. After this date, the order is expunged from the records.
*/
@ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")
open var expiryDate:Date? = null
/**
* 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.
*/
@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.")
open var isTest:Boolean? = null
}
Kotlin UpdateAccountAsync DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .x-msgpack suffix or ?format=x-msgpack
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /async/accounts/update HTTP/1.1
Host: taxfiling.staging.pwc.de
Accept: application/x-msgpack
Content-Type: application/x-msgpack
Content-Length: length
{"userName":"String","displayName":"String","email":"String","profileUrl":"String","meta":{"String":"String"}}
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"}}}